Radeon ProRender

rprPostEffectGetInfo

Queries a post effect object for information.

rpr_status rprPostEffectGetInfo( rpr_post_effect effect,
  rpr_post_effect_info info,
  size_t size,
  void * data,
  size_t * size_ret);

Parameters

Parameter Description
effect The post effect to query.
info The type of information requested.
size Size of buffer pointed to by data variable.
data The buffer into which query info will be placed.
size_ret Returns the size in bytes of the data being queried.

Notes

Query operations usually include two steps:

  1. First, pass data as NULL along with a value for rpr_post_effect_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.

Output

Size in bytes of the data being queried.

Return

Returns RPR_SUCCESS in case of success, or RPR_ERROR code if a problem was encountered.

To learn how to handle errors in AMD Radeon ProRender SDK, see Error Handling.

Errors

Possible error codes:

  • RPR_ERROR_INVALID_PARAMETER