rprLightGetInfo

Queries details for a particular light.

rpr_status rprLightGetInfo(

rpr_light light,

rpr_light_info info,

size_t size,

void * data,

size_t * size_ret);

Parameters

Parameter

Description

light

The light to query.

light_info

The information we wish to obtain.

size

Size of the buffer pointed to 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_light_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