Detailed Description

Defines and manages image objects.

NvMediaImage objects are video RAM surfaces storing YUV, RGBA or RAW data. They can store one or more images depending on the class. NvMediaImage objects are created with NvMediaImageCreateNew() and destroyed with NvMediaImageDestroy().

Data Structures
struct	NvMediaImageRec
	Holds a handle representing image objects. More...

struct	NvMediaImageGroup
	Holds a handle representing an image group. More...

Macros
#define	NVMEDIA_MAX_IMAGE_GROUP_SIZE
	Maximum number of images in an image group. More...

#define	NVMEDIA_IMAGE_TIMEOUT_INFINITE
	Infinite timeout for NvMediaImageGetStatus(). More...

Typedefs
typedef struct NvMediaImageRec	NvMediaImage
	Holds a handle representing image objects. More...

Functions
NvMediaStatus	NvMediaImageGetVersion (NvMediaVersion *version)
	Gets the version of the NvMedia Image library. More...

NvMediaImage *	NvMediaImageCreateNew (NvMediaDevice device, NvMediaSurfaceType type, const NvMediaSurfAllocAttr attrs, uint32_t numAttrs, uint32_t flags)
	Allocates an image object. More...

void	NvMediaImageDestroy (NvMediaImage *image)
	Destroys an image object created by NvMediaImageCreateNew(). More...

Macro Definition Documentation

#define NVMEDIA_IMAGE_TIMEOUT_INFINITE

Definition at line 64 of file nvmedia_image.h.

#define NVMEDIA_MAX_IMAGE_GROUP_SIZE

Maximum number of images in an image group.

Definition at line 58 of file nvmedia_image.h.

Holds a handle representing image objects.

NvMediaImage* NvMediaImageCreateNew	(	NvMediaDevice *	device,
		NvMediaSurfaceType	type,
		const NvMediaSurfAllocAttr *	attrs,
		uint32_t	numAttrs,
		uint32_t	flags
	)

Allocates an image object.

Upon creation, the contents are undefined.

Parameters

[in]	device	The NvMediaDevice.
[in]	type	Surface format type obtained by NvMediaSurfaceFormatGetType().
[in]	attrs	An array of surface alloc attributes for surface creation.
[in]	numAttrs	Number of attributes in attrs.
[in]	flags	Flags for module hints (reserved for future use).

Returns: The new image's handle if the call is successful, or NULL otherwise.

void NvMediaImageDestroy ( NvMediaImage * image )

Destroys an image object created by NvMediaImageCreateNew().

Parameters

[in] image The image to destroy.

NvMediaStatus NvMediaImageGetVersion ( NvMediaVersion * version )

Gets the version of the NvMedia Image library.

Parameters

[in] version A pointer to an NvMediaVersion structure belonging to the client.

Returns: A status code; NVMEDIA_STATUS_OK if the call was successful, or NVMEDIA_STATUS_BAD_PARAMETER if version is an invalid pointer.