rifImageMap

Map the image pixels data into the host address space and returns a pointer to this mapped region.

rif_int rifImageMap(

rif_image image,

rif_image_map_type map_type,

void** data);

Parameters

Parameter

Input/Output

Description

image

input

A valid image object.

map_type

input

Not used at the moment.

data

output

A pointer to the mapped data if the function is executed successfully.

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 — data is nullptr.

  • RIF_ERRO—_INTERNAL_ERROR — an internal RadeonImageFiflters error occurs. Sends a bug report if such an error occurs.