rprContextGetInfo

Queries the current context for information, such as buffer size.

rpr_status rprContextGetInfo(

rpr_context context,

rpr_context_info context_info,

size_t size,

void * data,

size_t * size_ret);

Parameters

Parameter

Description

context

The context to be queried.

context_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_context_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