rprSceneSetBackgroundImage

Sets background image for the scene that does not affect the scene lighting and is shown as view-independent rectangular background.

rpr_status rprSceneSetBackgroundImage(

rpr_scene scene,

rpr_image image);

Parameters

Parameter

Description

scene

The scene to set background for.

image

The background image.

Notes

Uses a rectangular texture. Its UV is within the range of [0;1] in the screen space.

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