NVIDIA DRIVE OS Linux API Reference

5.1.6.1 Release
For Test and Development only

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvmedia_image_pyramid.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 - 2019, 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 
16 #ifndef _NVMEDIA_IMAGE_PYRAMID_H
17 #define _NVMEDIA_IMAGE_PYRAMID_H
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 #include "nvmedia_core.h"
24 #include "nvmedia_image.h"
25 #include "nvmedia_surface.h"
26 
38 #define NVMEDIA_IMAGE_PYRAMID_VERSION_MAJOR 1
39 
40 #define NVMEDIA_IMAGE_PYRAMID_VERSION_MINOR 1
41 
43 #define MAX_PYRAMID_LEVELS (10)
44 
49 
68  NvMediaDevice *device,
69  NvMediaSurfaceType type,
70  NvMediaSurfAllocAttr *attrs,
71  uint32_t numLevels,
72  float scale,
73  uint32_t numAttrs,
74  uint32_t flags
75 );
76 
81 void
83  NvMediaImagePyramid *pyramid
84 );
85 
106  NvMediaImagePyramid *pyramid,
107  uint32_t lockAccessType,
108  NvMediaImageSurfaceMap *surfaceMap
109 );
110 
118 void
120  NvMediaImagePyramid *pyramid
121 );
122 
141  NvMediaImagePyramid *pyramid,
142  uint32_t millisecondWait,
143  NvMediaTaskStatus *status
144 );
145 
152 NvMediaImage *
154  NvMediaImagePyramid * pyramid,
155  uint32_t level
156 );
157 
163 uint32_t
165  NvMediaImagePyramid * pyramid
166 );
167 
173 float
175  NvMediaImagePyramid * pyramid
176 );
177 
178 /*
179  * \defgroup history_nvmedia_image_pyramid History
180  * Provides change history for the NvMedia ImagePyramid API.
181  *
182  * \section history_nvmedia_image_pyramid Version History
183  *
184  * <b> Version 1.0 </b> December 4, 2017
185  * - Initial Release.
186  *
187  * <b> Version 1.1 </b> February 6, 2019
188  * - Added required header includes nvmedia_core.h and nvmedia_surface.h
189  *
190  */
191 
194 #ifdef __cplusplus
195 }; /* extern "C" */
196 #endif
197 
198 #endif /* _NVMEDIA_IMAGE_PYRAMID_H */
Holds a handle representing image objects.
Definition: nvmedia_image.h:69
#define NvMediaSurfaceType
Defines the set of NvMedia surface types.
NvMediaStatus NvMediaImagePyramidGetStatus(NvMediaImagePyramid *pyramid, uint32_t millisecondWait, NvMediaTaskStatus *status)
Gets the status of the current or most recent operation for the image pyramid; optionally waits for t...
NVIDIA Media Interface: Surface Handling
float NvMediaImagePyramidGetScale(NvMediaImagePyramid *pyramid)
Returns the scale factor of a pyramid.
NVIDIA Media Interface: Image Processing
struct NvMediaDevice NvMediaDevice
An opaque handle representing an NvMediaDevice object.
Definition: nvmedia_core.h:337
Holds status of latest operation for NvMedia managed data structure.
Definition: nvmedia_core.h:209
NvMediaImage * NvMediaImagePyramidGetImageForLevel(NvMediaImagePyramid *pyramid, uint32_t level)
Gets a pointer to the image for a level.
NVIDIA Media Interface: Core
NvMediaStatus
Defines all possible error codes.
Definition: nvmedia_core.h:169
uint32_t NvMediaImagePyramidGetNumLevels(NvMediaImagePyramid *pyramid)
Returns the number of levels in a pyramid.
NvMediaImagePyramid * NvMediaImagePyramidCreate(NvMediaDevice *device, NvMediaSurfaceType type, NvMediaSurfAllocAttr *attrs, uint32_t numLevels, float scale, uint32_t numAttrs, uint32_t flags)
Allocates an image pyramid.
int uint32_t uint32_t uint32_t const uint32_t const uint32_t const uint32_t const uint64_t uint32_t uint32_t flags
struct NvMediaImagePyramid NvMediaImagePyramid
A handle representing an image pyramid object.
Holds NvMedia Surface allocation attributes.
void NvMediaImagePyramidUnlock(NvMediaImagePyramid *pyramid)
Unlocks an image pyramid.
NvMediaStatus NvMediaImagePyramidLock(NvMediaImagePyramid *pyramid, uint32_t lockAccessType, NvMediaImageSurfaceMap *surfaceMap)
Locks an image pyramid and returns the associated mapped pointers to the image pyramid surface data...
Holds an image surface map descriptor used by NvMediaImageLock().
void NvMediaImagePyramidDestroy(NvMediaImagePyramid *pyramid)
Destroys an image pyramid created by NvMediaImagePyramidCreate().