rprContextGetParameterInfo

Queries information about a context parameter.

rpr_status rprContextGetParameterInfo(

rpr_context context,

int param_idx,

rpr_parameter_info parameter_info,

size_t size,

void * data,

size_t * size_ret);

Parameters

Parameter

Description

context

The context to query.

param_idx

The index of the parameter. Value must be between 0 and (value stored in RPR_CONTEXT_PARAMETER_COUNT) -1.

parameter_info

The type of info to query.

size

The size of the buffer pointed by data.

data

The buffer to store queried info.

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_parameter_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