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_image_pyramid.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018, 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_image.h"
24 
36 #define NVMEDIA_IMAGE_PYRAMID_VERSION_MAJOR 1
37 
38 #define NVMEDIA_IMAGE_PYRAMID_VERSION_MINOR 0
39 
41 #define MAX_PYRAMID_LEVELS (10)
42 
47 
62  NvMediaDevice *device,
63  NvMediaSurfaceType type,
64  NvMediaSurfAllocAttr *attrs,
65  uint32_t numLevels,
66  float scale,
67  uint32_t numAttrs,
68  uint32_t flags
69 );
70 
76 void
78  NvMediaImagePyramid *pyramid
79 );
80 
102  NvMediaImagePyramid *pyramid,
103  uint32_t lockAccessType,
104  NvMediaImageSurfaceMap *surfaceMap
105 );
106 
114 void
116  NvMediaImagePyramid *pyramid
117 );
118 
136  NvMediaImagePyramid *pyramid,
137  uint32_t millisecondWait,
138  NvMediaTaskStatus *status
139 );
140 
147 NvMediaImage *
149  NvMediaImagePyramid * pyramid,
150  uint32_t level
151 );
152 
158 uint32_t
160  NvMediaImagePyramid * pyramid
161 );
162 
168 float
170  NvMediaImagePyramid * pyramid
171 );
172 
173 /*
174  * \defgroup history_nvmedia_image_pyramid History
175  * Provides change history for the NvMedia ImagePyramid API.
176  *
177  * \section history_nvmedia_image_pyramid Version History
178  *
179  * <b> Version 1.0 </b> December 4, 2017
180  * - Initial Release.
181  *
182  */
183 
186 #ifdef __cplusplus
187 }; /* extern "C" */
188 #endif
189 
190 #endif /* _NVMEDIA_IMAGE_PYRAMID_H */
A handle representing image objects.
Definition: nvmedia_image.h:75
#define NvMediaSurfaceType
Defines the set of NvMedia surface types.
NvMediaStatus NvMediaImagePyramidGetStatus(NvMediaImagePyramid *pyramid, uint32_t millisecondWait, NvMediaTaskStatus *status)
Gets status of the current/last operation for the image pyramid, and optionally waits for operation t...
float NvMediaImagePyramidGetScale(NvMediaImagePyramid *pyramid)
Returns scale factor of the pyramid.
NVIDIA Media Interface: Image Processing
Holds status of latest operation for NvMedia managed data structure.
Definition: nvmedia_core.h:235
NvMediaImage * NvMediaImagePyramidGetImageForLevel(NvMediaImagePyramid *pyramid, uint32_t level)
Returns NvMediaImage pointer of image for a level.
NvMediaStatus
The set of all possible error codes.
Definition: nvmedia_core.h:199
uint32_t NvMediaImagePyramidGetNumLevels(NvMediaImagePyramid *pyramid)
Returns number of levels in the 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 image pyramid objects.
Holds NvMedia Surface allocation attributes.
void NvMediaDevice
An opaque handle representing a NvMediaDevice object.
Definition: nvmedia_core.h:305
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 pointing to the image pyramid surfa...
Image surface map descriptor used by NvMediaImageLock.
void NvMediaImagePyramidDestroy(NvMediaImagePyramid *pyramid)
Destroys an image pyramid that NvMediaImagePyramidCreate() created.