rprSceneGetBackgroundImage

Gets background image for a scene.

rpr_status rprSceneGetBackgroundImage(

rpr_scene scene,

rpr_image * out_image);

Parameters

Parameter

Description

scene

The scene to get background image from.

out_image

A pointer to the image object returned.

Output

A pointer to an image 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.