WorldEnvironment
Default environment properties for the entire scene (post-processing effects, lighting and background settings).
Default environment properties for the entire scene (post-processing effects, lighting and background settings).
The WorldEnvironment node is used to configure the default Environment for the scene.
The parameters defined in the WorldEnvironment can be overridden by an Environment node set on the current Camera3D. Additionally, only one WorldEnvironment may be instantiated in a given scene at a time.
The WorldEnvironment allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). Usually, these are added in order to improve the realism/color balance of the scene.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
WorldEnvironmentConstructor
public WorldEnvironment();Properties3
CameraAttributesProperty
public CameraAttributes CameraAttributes { get; set; }The default CameraAttributes resource to use if none set on the Camera3D.
CompositorProperty
public Compositor Compositor { get; set; }The default Compositor resource to use if none set on the Camera3D.
EnvironmentProperty
public Environment Environment { get; set; }Environment resource for this viewport’s World3D. Multiple WorldEnvironment entities in one world use the first rather than blending automatically. Distinct owned World3D instances in one EntityTree can have independent environments. Camera3D.Environment has priority.
Methods6
GetCameraAttributesCameraAttributes
public CameraAttributes GetCameraAttributes();CameraAttributesGetCompositorCompositor
public Compositor GetCompositor();CompositorGetEnvironmentEnvironment
public Environment GetEnvironment();EnvironmentSetCameraAttributesvoid
public void SetCameraAttributes(CameraAttributes cameraAttributes);| Name | Type | Default |
|---|---|---|
cameraAttributes | CameraAttributes | — |
SetCompositorvoid
public void SetCompositor(Compositor compositor);| Name | Type | Default |
|---|---|---|
compositor | Compositor | — |
SetEnvironmentvoid
public void SetEnvironment(Environment env);| Name | Type | Default |
|---|---|---|
env | Environment | — |