NVIDIA DRIVE OS Linux API Reference

5.1.3.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvmedia_idp.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014-2017, NVIDIA CORPORATION. All rights reserved. All
3  * information contained herein is proprietary and confidential to NVIDIA
4  * Corporation. Any use, reproduction, or disclosure without the written
5  * permission of NVIDIA Corporation is prohibited.
6  */
7 
15 #ifndef _NVMEDIA_IDP_H
16 #define _NVMEDIA_IDP_H
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
22 #include "nvmedia_core.h"
23 #include "nvmedia_common.h"
24 #include "nvmedia_image.h"
25 
36 #define NVMEDIA_IDP_VERSION_MAJOR 2
37 
38 #define NVMEDIA_IDP_VERSION_MINOR 0
39 
43 typedef struct {
45  uint32_t displayId;
47  uint32_t windowId;
49  uint32_t width;
51  uint32_t height;
53  float_t refreshRate;
54 } NvMediaIDP;
55 
61 typedef struct {
63  uint32_t width;
65  uint32_t height;
67  float_t refreshRate;
69 
73 typedef struct {
75  uint32_t displayId;
79  uint32_t width;
81  uint32_t height;
83  float_t refreshRate;
85 
97  NvMediaVersion *version
98 );
99 
112 NvMediaIDP *
114  uint32_t displayId,
115  uint32_t windowId,
116  NvMediaIDPPreferences *displayPreference,
117  NvMediaBool alreadyCreated
118 );
119 
125 void
127  NvMediaIDP *idp
128 );
129 
154  NvMediaIDP *idp,
155  uint32_t attributeMask,
156  NvMediaDispAttributes *attributes
157 );
158 
175  int32_t *displayDevices,
176  NvMediaIDPDeviceParams *displayParams
177 );
178 
204  NvMediaIDP *idp,
205  NvMediaImage *image,
206  NvMediaRect *srcRect,
207  NvMediaRect *dstRect,
208  NvMediaImage **releaseList,
209  NvMediaTime *timeStamp
210 );
211 
212 /*
213  * \defgroup history_nvmedia_idp History
214  * Provides change history for the NvMedia IDP API.
215  *
216  * \section history_nvmedia_idp Version History
217  *
218  * <b> Version 1.1 </b> September 24, 2015
219  * - Initial release
220  *
221  * <b> Version 1.2 </b> May 11, 2016
222  * - Added \ref NvMediaIDPCheckVersion API
223  *
224  * <b> Version 2.0 </b> May 12, 2017
225  * - Added \ref NvMediaIDPGetVersion API to get the version of NvMedia image display library
226  * - NvMediaIDPCheckVersion is deprecated. Use NvMediaIDPGetVersion() instead
227  * - Remove NvMediaIDPDeviceType
228  * - Remove imageType as input parameter of \ref NvMediaIDPCreate
229  * - Replace NvMediaIDPCompositionModes with \ref NvMediaDispCompMode
230  * - Replace NvMediaIDPAttributes with \ref NvMediaDispAttributes
231  * - Deprecated NvMediaIDPSetDepth, use NvMediaIDPSetAttributes with
232  * NVMEDIA_DISP_ATTR_SET_DEPTH instead
233  * - All NvMedia data types are moved to standard data types
234  */
237 #ifdef __cplusplus
238 }; /* extern "C" */
239 #endif
240 
241 #endif /* _NVMEDIA_IDP_H */
A handle representing image objects.
Definition: nvmedia_image.h:75
uint32_t NvMediaBool
A boolean value, holding NVMEDIA_TRUE or NVMEDIA_FALSE.
Definition: nvmedia_core.h:79
NvMediaStatus NvMediaIDPSetAttributes(NvMediaIDP *idp, uint32_t attributeMask, NvMediaDispAttributes *attributes)
Set NvMediaIDP attributes.
NvMediaStatus NvMediaIDPGetVersion(NvMediaVersion *version)
Gets the version compatibility for the NvMedia IDP library.
uint32_t windowId
Display window Id.
Definition: nvmedia_idp.h:47
NVIDIA Media Interface: Image Processing
NvMediaIDP * NvMediaIDPCreate(uint32_t displayId, uint32_t windowId, NvMediaIDPPreferences *displayPreference, NvMediaBool alreadyCreated)
Creates an image display object.
uint32_t displayId
Display device (head) Id.
Definition: nvmedia_idp.h:45
struct timespec NvMediaTime
Holds the media time (timespec as defined by the POSIX specification).
Definition: nvmedia_core.h:84
Holds NvMedia Version information.
Definition: nvmedia_core.h:252
NVIDIA Media Interface: Common Types for Video/Image Encode/Decode
float_t refreshRate
Display refresh rate in Hertz.
Definition: nvmedia_idp.h:67
Device parameters returned by NvMediaIDPQuery function.
Definition: nvmedia_idp.h:73
NVIDIA Media Interface: Core
NvMediaStatus
The set of all possible error codes.
Definition: nvmedia_core.h:199
uint32_t width
Display width.
Definition: nvmedia_idp.h:79
uint32_t height
Display height.
Definition: nvmedia_idp.h:65
Holds a rectangular region of a surface.
Definition: nvmedia_core.h:146
uint32_t displayId
Display device Id.
Definition: nvmedia_idp.h:75
NvMediaStatus NvMediaIDPQuery(int32_t *displayDevices, NvMediaIDPDeviceParams *displayParams)
Queries the display system and returns the parameters of all display devices.
Sets the preferences for the image display creation.
Definition: nvmedia_idp.h:61
uint32_t width
Display width.
Definition: nvmedia_idp.h:63
Image display object created by NvMediaIDPCreate.
Definition: nvmedia_idp.h:43
Holds NvMedia display attributes.
float_t refreshRate
Display refresh rate in Hertz.
Definition: nvmedia_idp.h:83
void NvMediaIDPDestroy(NvMediaIDP *idp)
Destroy an image display object created by NvMediaIDPCreate.
uint32_t height
Display height.
Definition: nvmedia_idp.h:81
NvMediaBool enabled
Set to NVMEDIA_TRUE if the device is already enabled (initialized) by the system. ...
Definition: nvmedia_idp.h:77
uint32_t height
Display height.
Definition: nvmedia_idp.h:51
float_t refreshRate
Display refresh rate in Hertz.
Definition: nvmedia_idp.h:53
NvMediaStatus NvMediaIDPFlip(NvMediaIDP *idp, NvMediaImage *image, NvMediaRect *srcRect, NvMediaRect *dstRect, NvMediaImage **releaseList, NvMediaTime *timeStamp)
Displays an image on the display device.
uint32_t width
Display width.
Definition: nvmedia_idp.h:49