Radeon ProRender

rifImageFilterGetInfo

Gets the filter information.

rif_int rifImageFilterGetInfo( rif_image_filter image_filter,
  rif_image_filter_info filter_info,
  size_t size,
  void * data,
  size_t * size_ret);

Parameters

Parameter Input/Output Description
image_filter input A valid image filter object.
filter_info input Filter information to be requested.
size input Maximum size of filter information which can be stored in data.
data output A pointer to memory in which filter 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 if the function is executed successfully, or RIF_ERROR code if a problem is encountered.

Errors

Possible error codes:

  • RIF_ERROR_INVALID_FILTER - image_filter is not a valid image filter object.
  • RIF_ERROR_INVALID_PARAMETER - size_ret is nullptr or size_ret is less than the requested image information.
  • RIF_ERROR_INVALID_PARAMETER_TYPE - filter_info type is not supported.