Click or drag to resize

Environment Properties

The Environment type exposes the following members.

Properties
  NameDescription
Public propertyAdjustmentBrightness

The global brightness value of the rendered scene. Effective only if adjustment_enabled is true.

Public propertyAdjustmentColorCorrection

Applies the provided Texture resource to affect the global color aspect of the rendered scene. Effective only if adjustment_enabled is true.

Public propertyAdjustmentContrast

The global contrast value of the rendered scene (default value is 1). Effective only if adjustment_enabled is true.

Public propertyAdjustmentEnabled

If true, enables the adjustment_* properties provided by this resource. If false, modifications to the adjustment_* properties will have no effect on the rendered scene.

Public propertyAdjustmentSaturation

The global color saturation value of the rendered scene (default value is 1). Effective only if adjustment_enabled is true.

Public propertyAmbientLightColor

The ambient light's Color.

Public propertyAmbientLightEnergy

The ambient light's energy. The higher the value, the stronger the light.

Public propertyAmbientLightSkyContribution

Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene.

Public propertyAutoExposureEnabled

If true, enables the tonemapping auto exposure mode of the scene renderer. If true, the renderer will automatically determine the exposure setting to adapt to the scene's illumination and the observed light.

Public propertyAutoExposureMaxLuma

The maximum luminance value for the auto exposure.

Public propertyAutoExposureMinLuma

The minimum luminance value for the auto exposure.

Public propertyAutoExposureScale

The scale of the auto exposure effect. Affects the intensity of auto exposure.

Public propertyAutoExposureSpeed

The speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.

Public propertyBackgroundCameraFeedId

The ID of the camera feed to show in the background.

Public propertyBackgroundCanvasMaxLayer

The maximum layer ID to display. Only effective when using the background mode.

Public propertyBackgroundColor

The Color displayed for clear areas of the scene. Only effective when using the or background modes).

Public propertyBackgroundEnergy

The power of the light emitted by the background.

Public propertyBackgroundMode
Public propertyBackgroundSky

The Sky resource defined as background.

Public propertyBackgroundSkyCustomFov

The Sky resource's custom field of view.

Public propertyBackgroundSkyOrientation

The Sky resource's rotation expressed as a Basis.

Public propertyBackgroundSkyRotation

The Sky resource's rotation expressed as Euler angles in radians.

Public propertyBackgroundSkyRotationDegrees

The Sky resource's rotation expressed as Euler angles in degrees.

Public propertyDofBlurFarAmount

The amount of far blur for the depth-of-field effect.

Public propertyDofBlurFarDistance

The distance from the camera where the far blur effect affects the rendering.

Public propertyDofBlurFarEnabled

If true, enables the depth-of-field far blur effect.

Public propertyDofBlurFarQuality

The depth-of-field far blur's quality. Higher values can mitigate the visible banding effect seen at higher strengths, but are much slower.

Public propertyDofBlurFarTransition

The length of the transition between the no-blur area and far blur.

Public propertyDofBlurNearAmount

The amount of near blur for the depth-of-field effect.

Public propertyDofBlurNearDistance

Distance from the camera where the near blur effect affects the rendering.

Public propertyDofBlurNearEnabled

If true, enables the depth-of-field near blur effect.

Public propertyDofBlurNearQuality

The depth-of-field near blur's quality. Higher values can mitigate the visible banding effect seen at higher strengths, but are much slower.

Public propertyDofBlurNearTransition

The length of the transition between the near blur and no-blur area.

Public propertyDynamicObject
Gets a new DynamicGodotObject associated with this instance.
(Inherited from Object.)
Public propertyFogColor

The fog's Color.

Public propertyFogDepthBegin

The fog's depth starting distance from the camera.

Public propertyFogDepthCurve

The fog depth's intensity curve. A number of presets are available in the Inspector by right-clicking the curve.

Public propertyFogDepthEnabled

If true, the depth fog effect is enabled. When enabled, fog will appear in the distance (relative to the camera).

Public propertyFogDepthEnd

The fog's depth end distance from the camera. If this value is set to 0, it will be equal to the current camera's Far value.

Public propertyFogEnabled

If true, fog effects are enabled. FogHeightEnabled and/or FogDepthEnabled must be set to true to actually display fog.

Public propertyFogHeightCurve

The height fog's intensity. A number of presets are available in the Inspector by right-clicking the curve.

Public propertyFogHeightEnabled

If true, the height fog effect is enabled. When enabled, fog will appear in a defined height range, regardless of the distance from the camera. This can be used to simulate "deep water" effects with a lower performance cost compared to a dedicated shader.

Public propertyFogHeightMax

The Y coordinate where the height fog will be the most intense. If this value is greater than FogHeightMin, fog will be displayed from bottom to top. Otherwise, it will be displayed from top to bottom.

Public propertyFogHeightMin

The Y coordinate where the height fog will be the least intense. If this value is greater than FogHeightMax, fog will be displayed from top to bottom. Otherwise, it will be displayed from bottom to top.

Public propertyFogSunAmount

The intensity of the depth fog color transition when looking towards the sun. The sun's direction is determined automatically using the DirectionalLight node in the scene.

Public propertyFogSunColor

The depth fog's Color when looking towards the sun.

Public propertyFogTransmitCurve

The intensity of the fog light transmittance effect. Amount of light that the fog transmits.

Public propertyFogTransmitEnabled

Enables fog's light transmission effect. If true, light will be more visible in the fog to simulate light scattering as in real life.

Public propertyGlowBicubicUpscale

Smooths out the blockiness created by sampling higher levels, at the cost of performance.

Note: When using the GLES2 renderer, this is only available if the GPU supports the GL_EXT_gpu_shader4 extension.

Public propertyGlowBlendMode

The glow blending mode.

Public propertyGlowBloom

The bloom's intensity. If set to a value higher than 0, this will make glow visible in areas darker than the GlowHdrThreshold.

Public propertyGlowEnabled

If true, the glow effect is enabled.

Public propertyGlowHdrLuminanceCap

The higher threshold of the HDR glow. Areas brighter than this threshold will be clamped for the purposes of the glow effect.

Public propertyGlowHdrScale

The bleed scale of the HDR glow.

Public propertyGlowHdrThreshold

The lower threshold of the HDR glow. When using the GLES2 renderer (which doesn't support HDR), this needs to be below 1.0 for glow to be visible. A value of 0.9 works well in this case.

Public propertyGlowIntensity

The glow intensity. When using the GLES2 renderer, this should be increased to 1.5 to compensate for the lack of HDR rendering.

Public propertyGlowLevels__1

If true, the 1st level of glow is enabled. This is the most "local" level (least blurry).

Public propertyGlowLevels__2

If true, the 2th level of glow is enabled.

Public propertyGlowLevels__3

If true, the 3th level of glow is enabled.

Public propertyGlowLevels__4

If true, the 4th level of glow is enabled.

Public propertyGlowLevels__5

If true, the 5th level of glow is enabled.

Public propertyGlowLevels__6

If true, the 6th level of glow is enabled.

Public propertyGlowLevels__7

If true, the 7th level of glow is enabled. This is the most "global" level (blurriest).

Public propertyGlowStrength

The glow strength. When using the GLES2 renderer, this should be increased to 1.3 to compensate for the lack of HDR rendering.

Public propertyNativeInstance (Inherited from Object.)
Public propertyResourceLocalToScene

If true, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

(Inherited from Resource.)
Public propertyResourceName

The name of the resource. This is an optional identifier. If ResourceName is not empty, its value will be displayed to represent the current resource in the editor inspector. For built-in scripts, the ResourceName will be displayed as the tab name in the script editor.

(Inherited from Resource.)
Public propertyResourcePath

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

(Inherited from Resource.)
Public propertySsaoAoChannelAffect

The screen-space ambient occlusion intensity on materials that have an AO texture defined. Values higher than 0 will make the SSAO effect visible in areas darkened by AO textures.

Public propertySsaoBias

The screen-space ambient occlusion bias. This should be kept high enough to prevent "smooth" curves from being affected by ambient occlusion.

Public propertySsaoBlur

The screen-space ambient occlusion blur quality. See EnvironmentSSAOBlur for possible values.

Public propertySsaoColor

The screen-space ambient occlusion color.

Public propertySsaoEdgeSharpness

The screen-space ambient occlusion edge sharpness.

Public propertySsaoEnabled

If true, the screen-space ambient occlusion effect is enabled. This darkens objects' corners and cavities to simulate ambient light not reaching the entire object as in real life. This works well for small, dynamic objects, but baked lighting or ambient occlusion textures will do a better job at displaying ambient occlusion on large static objects. This is a costly effect and should be disabled first when running into performance issues.

Public propertySsaoIntensity

The primary screen-space ambient occlusion intensity. See also SsaoRadius.

Public propertySsaoIntensity2

The secondary screen-space ambient occlusion intensity. See also SsaoRadius2.

Public propertySsaoLightAffect

The screen-space ambient occlusion intensity in direct light. In real life, ambient occlusion only applies to indirect light, which means its effects can't be seen in direct light. Values higher than 0 will make the SSAO effect visible in direct light.

Public propertySsaoQuality

The screen-space ambient occlusion quality. Higher qualities will make better use of small objects for ambient occlusion, but are slower.

Public propertySsaoRadius

The primary screen-space ambient occlusion radius.

Public propertySsaoRadius2

The secondary screen-space ambient occlusion radius. If set to a value higher than 0, enables the secondary screen-space ambient occlusion effect which can be used to improve the effect's appearance (at the cost of performance).

Public propertySsReflectionsDepthTolerance

The depth tolerance for screen-space reflections.

Public propertySsReflectionsEnabled

If true, screen-space reflections are enabled. Screen-space reflections are more accurate than reflections from GIProbes or ReflectionProbes, but are slower and can't reflect surfaces occluded by others.

Public propertySsReflectionsFadeIn

The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection).

Public propertySsReflectionsFadeOut

The fade-out distance for screen-space reflections. Affects the area from the screen-space reflection to the "global" reflection.

Public propertySsReflectionsMaxSteps

The maximum number of steps for screen-space reflections. Higher values are slower.

Public propertySsReflectionsRoughness

If true, screen-space reflections will take the material roughness into account.

Public propertyTonemapExposure

The default exposure used for tonemapping.

Public propertyTonemapMode

The tonemapping mode to use. Tonemapping is the process that "converts" HDR values to be suitable for rendering on a LDR display. (Godot doesn't support rendering on HDR displays yet.)

Public propertyTonemapWhite

The white reference value for tonemapping. Only effective if the TonemapMode isn't set to .

Top
See Also