Radeon ProRender

rprBufferGetInfo

Queries information about a buffer.

rpr_status rprBufferGetInfo ( rpr_buffer buffer,
  rpr_buffer_info buffer_info,
  size_t size,
  void* data,
  size_t* size_ret);

Parameters

Parameter Description
buffer The buffer to query.
buffer_info The type of info to query.
size The size of the buffer pointed by the data variable.
data A buffer into which the results of the query will be stored.
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_buffer_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

The 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