rprGridGetInfo
Queries information about a grid.
rpr_status rprGridGetInfo( |
rpr_grid grid, |
rpr_grid_parameter grid_info, |
|
size_t size, |
|
void * data, |
|
size_t * size_ret); |
Parameters
Parameter |
Description |
---|---|
grid |
The grid to query. |
grid_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 |
Gives the size in bytes of the data being queried. |
Notes
Query operations usually include two steps:
First, pass
data
as NULL along with a value for rpr_grid_parameter detailing the information you wish to obtain. This will return the storage requirements for your query data.Secondly, query with
size_ret
set to NULL to fill the data buffer with the query data.
Output
Size in bytes of 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