rifImageGetInfo

Gets the image information.

rif_int rifImageGetInfo(

rif_image image,

rif_image_info image_info,

size_t size,

void * data,

size_t * size_ret);

Parameters

Parameter

Input/Output

Description

image

input

A valid image object.

image_info

input

Image information to be requested.

size

input

Maximum size of information which can be stored in data.

data

output

A pointer to memory in which image information will be stored.

size_ret

output

The size of the data stored in data.

Notes

Query operations usually include two steps:

  1. First, pass data as NULL along with a value for filter_info detailing the information you wish to obtain. This will return the storage requirements for your query data.

  2. Secondly, query with size_ret set to NULL to fill the data buffer with the query data.

Return

Returns RIF_SUCCESS in case of success, or RIF_ERROR code if a problem was encountered.

Errors

Possible error codes:

  • RIF_ERROR_INVALID_IMAGE — image is not a valid image object.

  • RIF_ERROR_INVALID_PARAMETER — size_ret or data is nullptr or size is less than requested image information.

  • RIF_ERROR_INVALID_PARAMETER_TYPE — the requested image_info type is not supported.