Radeon ProRender

rprContextCreateEnvironmentLight

Creates an environment light source.

Environment lights are a class of their own, providing a way to emulate radiance coming from the full hemisphere. It is advisable to use full HDR images for this purpose, as these images most accurately represent the dynamic range of environment lighting.

rpr_status rprContextCreateEnvironmentLight( rpr_context context,
  rpr_light * out_light);

Parameters

Parameter Description
context The context to which the environment light will be added.
out_light A pointer to the created directional light object.

Output

A pointer to a directional light object.

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_OUT_OF_VIDEO_MEMORY
  • RPR_ERROR_OUT_OF_SYSTEM_MEMORY