Radeon ProRender

rprEnvironmentLightSetImage

Sets image to be used for an environment light.

Environment lights provide 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 rprEnvironmentLightSetImage( rpr_light env_light,
  rpr_image image);

Parameters

Parameter Description
light The environment light to set the image for.
image Image object to set.

Notes

For a solid color, be sure to create an rpr_image from a single color value.

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
  • RPR_ERROR_UNSUPPORTED_IMAGE_FORMAT