nvmedia_idp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2019, NVIDIA CORPORATION.  All rights reserved.  All
 * information contained herein is proprietary and confidential to NVIDIA
 * Corporation.  Any use, reproduction, or disclosure without the written
 * permission of NVIDIA Corporation is prohibited.
 */

#ifndef _NVMEDIA_IDP_H
#define _NVMEDIA_IDP_H

#ifdef __cplusplus
extern "C" {
#endif

#include "nvmedia_core.h"
#include "nvmedia_common.h"
#include "nvmedia_image.h"

#define NVMEDIA_IDP_VERSION_MAJOR   3

#define NVMEDIA_IDP_VERSION_MINOR   0

typedef struct {
    uint32_t displayId;
    uint32_t windowId;
    uint32_t width;
    uint32_t height;
    float_t refreshRate;
} NvMediaIDP;

typedef struct {
    uint32_t width;
    uint32_t height;
    float_t refreshRate;
} NvMediaIDPPreferences;

typedef struct {
    uint32_t displayId;
    NvMediaBool enabled;
    uint32_t width;
    uint32_t height;
    float_t refreshRate;
} NvMediaIDPDeviceParams;

NvMediaStatus
NvMediaIDPGetVersion(
    NvMediaVersion *version
);

NvMediaIDP *
NvMediaIDPCreate(
    uint32_t displayId,
    uint32_t windowId,
    NvMediaIDPPreferences *displayPreference,
    NvMediaBool alreadyCreated
);

void
NvMediaIDPDestroy(
    NvMediaIDP *idp
);

NvMediaStatus
NvMediaIDPSetAttributes(
    NvMediaIDP *idp,
    uint32_t attributeMask,
    NvMediaDispAttributes *attributes
);

NvMediaStatus
NvMediaIDPQuery(
    int32_t *displayDevices,
    NvMediaIDPDeviceParams *displayParams
);

NvMediaStatus
NvMediaIDPFlip(
    NvMediaIDP *idp,
    NvMediaImage *image,
    NvMediaRect *srcRect,
    NvMediaRect *dstRect,
    NvMediaImage **releaseList,
    NvMediaTime *timeStamp
);

/*
 * \defgroup history_nvmedia_idp History
 * Provides change history for the NvMedia IDP API.
 *
 * \section history_nvmedia_idp Version History
 *
 * <b> Version 1.1 </b> September 24, 2015
 * - Initial release
 *
 * <b> Version 1.2 </b> May 11, 2016
 * - Added \ref NvMediaIDPCheckVersion API
 *
 * <b> Version 2.0 </b> May 12, 2017
 * - Added \ref NvMediaIDPGetVersion API to get the version of NvMedia image display library
 * - NvMediaIDPCheckVersion is deprecated. Use NvMediaIDPGetVersion() instead
 * - Remove NvMediaIDPDeviceType
 * - Remove imageType as input parameter of \ref NvMediaIDPCreate
 * - Replace NvMediaIDPCompositionModes with \ref NvMediaDispCompMode
 * - Replace NvMediaIDPAttributes with \ref NvMediaDispAttributes
 * - Deprecated NvMediaIDPSetDepth, use NvMediaIDPSetAttributes with
 *   NVMEDIA_DISP_ATTR_SET_DEPTH instead
 * - All NvMedia data types are moved to standard data types
 *
 * <b> Version 3.0 </b> February 6, 2019
 * - Deprecated brightness, hue, saturation, contrast, limitedRGB and
 *   colorStandard support from \ref NvMediaIDPSetAttributes.
 *
 */
#ifdef __cplusplus
};     /* extern "C" */
#endif

#endif /* _NVMEDIA_IDP_H */