reckfellENGINE

WorldEnvironment

Default environment properties for the entire scene (post-processing effects, lighting and background settings).

On this page
class WorldEnvironmentReckfellSharpInherits Entity

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
# WorldEnvironment
C#
public WorldEnvironment();

Properties3

CameraAttributesProperty
# CameraAttributes
C#
public CameraAttributes CameraAttributes { get; set; }

The default CameraAttributes resource to use if none set on the Camera3D.

CompositorProperty
# Compositor
C#
public Compositor Compositor { get; set; }

The default Compositor resource to use if none set on the Camera3D.

EnvironmentProperty
# Environment
C#
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
# GetCameraAttributes
C#
public CameraAttributes GetCameraAttributes();
Returns CameraAttributes
GetCompositorCompositor
# GetCompositor
C#
public Compositor GetCompositor();
Returns Compositor
GetEnvironmentEnvironment
# GetEnvironment
C#
public Environment GetEnvironment();
Returns Environment
SetCameraAttributesvoid
# SetCameraAttributes
C#
public void SetCameraAttributes(CameraAttributes cameraAttributes);
Parameters
NameTypeDefault
cameraAttributesCameraAttributes—
SetCompositorvoid
# SetCompositor
C#
public void SetCompositor(Compositor compositor);
Parameters
NameTypeDefault
compositorCompositor—
SetEnvironmentvoid
# SetEnvironment
C#
public void SetEnvironment(Environment env);
Parameters
NameTypeDefault
envEnvironment—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.