Radeon ProRender

rprIESLightSetImageFromFile

Sets an IES file for an IES light.

rpr_status rprIESLightSetImageFromFile( rpr_light env_light,
  rpr_char const * imagePath,
  rpr_int nx,
  rpr_int ny);

Parameters

Parameter Description
env_light The environment light to set an image for.
imagePath The path to the image to set (for UNICODE, supports UTF-8 encoding).
nx Resolution X of the IES image.
ny Resolution Y of the IES image.

Notes

IES files, composed of light quantities and measurements, specify intensity, falloff and radial dispersion of light, and are available for many real-world light sources.

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 (if the format of the IES file is not supported by AMD Radeon ProRender).
  • RPR_ERROR_IO_ERROR (if the IES image path file doesn’t exist).