Radeon ProRender

rprEnvironmentLightAttachPortal

Sets portal for environment light to accelerate convergence of indoor scenes.

rpr_status rprEnvironmentLightAttachPortal( rpr_scene scene,
  rpr_light env_light,
  rpr_shape portal);

Parameters

Parameter Description
scene The scene to set portal for.
env_light Environment light.
portal Portal mesh, might have multiple components.

Notes

Portals are often just pieces of geometry through which samples of the environment light will pass though. Most often they are used in squares over windows for interior scenes.

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