SceneSettings.backgroundEnvironment Property

Parent Object: SceneSettings
Defined in namespace "adsk::fusion" and the header file is <Fusion/Render/SceneSettings.h>

Description

Gets and sets the environment to use for the background. The available environments can be accessed through the RenderManager.renderEnvironments property.

Getting this property is only valid when the backgroundType property returns EnvironmentRenderSceneBackgroundType. Setting this property will automatically set the background type to EnvironmentRenderSceneBackgroundType.

Syntax

"sceneSettings_var" is a variable referencing a SceneSettings object.

# Get the value of the property.
propertyValue = sceneSettings_var.backgroundEnvironment

# Set the value of the property.
sceneSettings_var.backgroundEnvironment = propertyValue
"sceneSettings_var" is a variable referencing a SceneSettings object.
#include <Fusion/Render/SceneSettings.h>

// Get the value of the property.
Ptr<RenderEnvironment> propertyValue = sceneSettings_var->backgroundEnvironment();

// Set the value of the property, where value_var is a RenderEnvironment.
bool returnValue = sceneSettings_var->backgroundEnvironment(value_var);

Property Value

This is a read/write property whose value is a RenderEnvironment.

Version

Introduced in version May 2023