Environment

Resource for environment nodes (like WorldEnvironment) that define multiple rendering options.

Resource for environment nodes (like WorldEnvironment) that define multiple environment operations (such as background Sky or Color, ambient light, fog, depth-of-field...). These parameters affect the final render of the scene. The order of these operations is: - Depth of Field Blur - Glow - Tonemap (Auto Exposure) - Adjustments These effects will only apply when the Viewport's intended usage is "3D" or "3D Without Effects". This can be configured for the root Viewport with ProjectSettings.rendering/quality/intendedUsage/framebufferAllocation, or for specific Viewports via the Viewport.usage property.

@GodotBaseClass

struct Environment {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(Environment other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static Environment _new();

enum ToneMapper;

enum GlowBlendMode;

enum SSAOQuality;

enum DOFBlurQuality;

enum Constants;

double getAdjustmentBrightness();

Ref!Texture getAdjustmentColorCorrection();

double getAdjustmentContrast();

double getAdjustmentSaturation();

Color getAmbientLightColor();

double getAmbientLightEnergy();

double getAmbientLightSkyContribution();

Environment.BGMode getBackground();

Color getBgColor();

double getBgEnergy();

long getCameraFeedId();

long getCanvasMaxLayer();

double getDofBlurFarAmount();

double getDofBlurFarDistance();

Environment.DOFBlurQuality getDofBlurFarQuality();

double getDofBlurFarTransition();

double getDofBlurNearAmount();

double getDofBlurNearDistance();

Environment.DOFBlurQuality getDofBlurNearQuality();

double getDofBlurNearTransition();

Color getFogColor();

double getFogDepthBegin();

double getFogDepthCurve();

double getFogDepthEnd();

double getFogHeightCurve();

double getFogHeightMax();

double getFogHeightMin();

double getFogSunAmount();

Color getFogSunColor();

double getFogTransmitCurve();

Environment.GlowBlendMode getGlowBlendMode();

double getGlowBloom();

double getGlowHdrBleedScale();

double getGlowHdrBleedThreshold();

double getGlowHdrLuminanceCap();

double getGlowIntensity();

double getGlowStrength();

Ref!Sky getSky();

double getSkyCustomFov();

Basis getSkyOrientation();

Vector3 getSkyRotation();

Vector3 getSkyRotationDegrees();

double getSsaoAoChannelAffect();

double getSsaoBias();

Environment.SSAOBlur getSsaoBlur();

Color getSsaoColor();

double getSsaoDirectLightAffect();

double getSsaoEdgeSharpness();

double getSsaoIntensity();

double getSsaoIntensity2();

Environment.SSAOQuality getSsaoQuality();

double getSsaoRadius();

double getSsaoRadius2();

double getSsrDepthTolerance();

double getSsrFadeIn();

double getSsrFadeOut();

long getSsrMaxSteps();

bool getTonemapAutoExposure();

double getTonemapAutoExposureGrey();

double getTonemapAutoExposureMax();

double getTonemapAutoExposureMin();

double getTonemapAutoExposureSpeed();

double getTonemapExposure();

double getTonemapWhite();

Environment.ToneMapper getTonemapper();

bool isAdjustmentEnabled();

bool isDofBlurFarEnabled();

bool isDofBlurNearEnabled();

bool isFogDepthEnabled();

bool isFogEnabled();

bool isFogHeightEnabled();

bool isFogTransmitEnabled();

bool isGlowBicubicUpscaleEnabled();

bool isGlowEnabled();

bool isGlowLevelEnabled(long idx);

bool isSsaoEnabled();

bool isSsrEnabled();

bool isSsrRough();

void setAdjustmentBrightness(double brightness);

void setAdjustmentColorCorrection(Texture color_correction);

void setAdjustmentContrast(double contrast);

void setAdjustmentEnable(bool enabled);

void setAdjustmentSaturation(double saturation);

void setAmbientLightColor(Color color);

void setAmbientLightEnergy(double energy);

void setAmbientLightSkyContribution(double energy);

void setBackground(long mode);

void setBgColor(Color color);

void setBgEnergy(double energy);

void setCameraFeedId(long camera_feed_id);

void setCanvasMaxLayer(long layer);

void setDofBlurFarAmount(double intensity);

void setDofBlurFarDistance(double intensity);

void setDofBlurFarEnabled(bool enabled);

void setDofBlurFarQuality(long intensity);

void setDofBlurFarTransition(double intensity);

void setDofBlurNearAmount(double intensity);

void setDofBlurNearDistance(double intensity);

void setDofBlurNearEnabled(bool enabled);

void setDofBlurNearQuality(long level);

void setDofBlurNearTransition(double intensity);

void setFogColor(Color color);

void setFogDepthBegin(double distance);

void setFogDepthCurve(double curve);

void setFogDepthEnabled(bool enabled);

void setFogDepthEnd(double distance);

void setFogEnabled(bool enabled);

void setFogHeightCurve(double curve);

void setFogHeightEnabled(bool enabled);

void setFogHeightMax(double height);

void setFogHeightMin(double height);

void setFogSunAmount(double amount);

void setFogSunColor(Color color);

void setFogTransmitCurve(double curve);

void setFogTransmitEnabled(bool enabled);

void setGlowBicubicUpscale(bool enabled);

void setGlowBlendMode(long mode);

void setGlowBloom(double amount);

void setGlowEnabled(bool enabled);

void setGlowHdrBleedScale(double scale);

void setGlowHdrBleedThreshold(double threshold);

void setGlowHdrLuminanceCap(double amount);

void setGlowIntensity(double intensity);

void setGlowLevel(long idx, bool enabled);

void setGlowStrength(double strength);

void setSky(Sky sky);

void setSkyCustomFov(double scale);

void setSkyOrientation(Basis orientation);

void setSkyRotation(Vector3 euler_radians);

void setSkyRotationDegrees(Vector3 euler_degrees);

void setSsaoAoChannelAffect(double amount);

void setSsaoBias(double bias);

void setSsaoBlur(long mode);

void setSsaoColor(Color color);

void setSsaoDirectLightAffect(double amount);

void setSsaoEdgeSharpness(double edge_sharpness);

void setSsaoEnabled(bool enabled);

void setSsaoIntensity(double intensity);

void setSsaoIntensity2(double intensity);

void setSsaoQuality(long quality);

void setSsaoRadius(double radius);

void setSsaoRadius2(double radius);

void setSsrDepthTolerance(double depth_tolerance);

void setSsrEnabled(bool enabled);

void setSsrFadeIn(double fade_in);

void setSsrFadeOut(double fade_out);

void setSsrMaxSteps(long max_steps);

void setSsrRough(bool rough);

void setTonemapAutoExposure(bool auto_exposure);

void setTonemapAutoExposureGrey(double exposure_grey);

void setTonemapAutoExposureMax(double exposure_max);

void setTonemapAutoExposureMin(double exposure_min);

void setTonemapAutoExposureSpeed(double exposure_speed);

void setTonemapExposure(double exposure);

void setTonemapWhite(double white);

void setTonemapper(long mode);

double adjustmentBrightness [@property getter];

double adjustmentBrightness [@property setter];

Texture adjustmentColorCorrection [@property getter];

Texture adjustmentColorCorrection [@property setter];

double adjustmentContrast [@property getter];

double adjustmentContrast [@property setter];

bool adjustmentEnabled [@property getter];

bool adjustmentEnabled [@property setter];

double adjustmentSaturation [@property getter];

double adjustmentSaturation [@property setter];

Color ambientLightColor [@property getter];

Color ambientLightColor [@property setter];

double ambientLightEnergy [@property getter];

double ambientLightEnergy [@property setter];

double ambientLightSkyContribution [@property getter];

double ambientLightSkyContribution [@property setter];

bool autoExposureEnabled [@property getter];

bool autoExposureEnabled [@property setter];

double autoExposureMaxLuma [@property getter];

double autoExposureMaxLuma [@property setter];

double autoExposureMinLuma [@property getter];

double autoExposureMinLuma [@property setter];

double autoExposureScale [@property getter];

double autoExposureScale [@property setter];

double autoExposureSpeed [@property getter];

double autoExposureSpeed [@property setter];

long backgroundCameraFeedId [@property getter];

long backgroundCameraFeedId [@property setter];

long backgroundCanvasMaxLayer [@property getter];

long backgroundCanvasMaxLayer [@property setter];

Color backgroundColor [@property getter];

Color backgroundColor [@property setter];

double backgroundEnergy [@property getter];

double backgroundEnergy [@property setter];

Environment.BGMode backgroundMode [@property getter];

long backgroundMode [@property setter];

Sky backgroundSky [@property getter];

Sky backgroundSky [@property setter];

double backgroundSkyCustomFov [@property getter];

double backgroundSkyCustomFov [@property setter];

Basis backgroundSkyOrientation [@property getter];

Basis backgroundSkyOrientation [@property setter];

Vector3 backgroundSkyRotation [@property getter];

Vector3 backgroundSkyRotation [@property setter];

Vector3 backgroundSkyRotationDegrees [@property getter];

Vector3 backgroundSkyRotationDegrees [@property setter];

double dofBlurFarAmount [@property getter];

double dofBlurFarAmount [@property setter];

double dofBlurFarDistance [@property getter];

double dofBlurFarDistance [@property setter];

bool dofBlurFarEnabled [@property getter];

bool dofBlurFarEnabled [@property setter];

Environment.DOFBlurQuality dofBlurFarQuality [@property getter];

long dofBlurFarQuality [@property setter];

double dofBlurFarTransition [@property getter];

double dofBlurFarTransition [@property setter];

double dofBlurNearAmount [@property getter];

double dofBlurNearAmount [@property setter];

double dofBlurNearDistance [@property getter];

double dofBlurNearDistance [@property setter];

bool dofBlurNearEnabled [@property getter];

bool dofBlurNearEnabled [@property setter];

Environment.DOFBlurQuality dofBlurNearQuality [@property getter];

long dofBlurNearQuality [@property setter];

double dofBlurNearTransition [@property getter];

double dofBlurNearTransition [@property setter];

Color fogColor [@property getter];

Color fogColor [@property setter];

double fogDepthBegin [@property getter];

double fogDepthBegin [@property setter];

double fogDepthCurve [@property getter];

double fogDepthCurve [@property setter];

bool fogDepthEnabled [@property getter];

bool fogDepthEnabled [@property setter];

double fogDepthEnd [@property getter];

double fogDepthEnd [@property setter];

bool fogEnabled [@property getter];

bool fogEnabled [@property setter];

double fogHeightCurve [@property getter];

double fogHeightCurve [@property setter];

bool fogHeightEnabled [@property getter];

bool fogHeightEnabled [@property setter];

double fogHeightMax [@property getter];

double fogHeightMax [@property setter];

double fogHeightMin [@property getter];

double fogHeightMin [@property setter];

double fogSunAmount [@property getter];

double fogSunAmount [@property setter];

Color fogSunColor [@property getter];

Color fogSunColor [@property setter];

double fogTransmitCurve [@property getter];

double fogTransmitCurve [@property setter];

bool fogTransmitEnabled [@property getter];

bool fogTransmitEnabled [@property setter];

bool glowBicubicUpscale [@property getter];

bool glowBicubicUpscale [@property setter];

Environment.GlowBlendMode glowBlendMode [@property getter];

long glowBlendMode [@property setter];

double glowBloom [@property getter];

double glowBloom [@property setter];

bool glowEnabled [@property getter];

bool glowEnabled [@property setter];

double glowHdrLuminanceCap [@property getter];

double glowHdrLuminanceCap [@property setter];

double glowHdrScale [@property getter];

double glowHdrScale [@property setter];

double glowHdrThreshold [@property getter];

double glowHdrThreshold [@property setter];

double glowIntensity [@property getter];

double glowIntensity [@property setter];

bool glowLevels1 [@property getter];

bool glowLevels1 [@property setter];

bool glowLevels2 [@property getter];

bool glowLevels2 [@property setter];

bool glowLevels3 [@property getter];

bool glowLevels3 [@property setter];

bool glowLevels4 [@property getter];

bool glowLevels4 [@property setter];

bool glowLevels5 [@property getter];

bool glowLevels5 [@property setter];

bool glowLevels6 [@property getter];

bool glowLevels6 [@property setter];

bool glowLevels7 [@property getter];

bool glowLevels7 [@property setter];

double glowStrength [@property getter];

double glowStrength [@property setter];

double ssReflectionsDepthTolerance [@property getter];

double ssReflectionsDepthTolerance [@property setter];

bool ssReflectionsEnabled [@property getter];

bool ssReflectionsEnabled [@property setter];

double ssReflectionsFadeIn [@property getter];

double ssReflectionsFadeIn [@property setter];

double ssReflectionsFadeOut [@property getter];

double ssReflectionsFadeOut [@property setter];

long ssReflectionsMaxSteps [@property getter];

long ssReflectionsMaxSteps [@property setter];

bool ssReflectionsRoughness [@property getter];

bool ssReflectionsRoughness [@property setter];

double ssaoAoChannelAffect [@property getter];

double ssaoAoChannelAffect [@property setter];

double ssaoBias [@property getter];

double ssaoBias [@property setter];

Environment.SSAOBlur ssaoBlur [@property getter];

long ssaoBlur [@property setter];

Color ssaoColor [@property getter];

Color ssaoColor [@property setter];

double ssaoEdgeSharpness [@property getter];

double ssaoEdgeSharpness [@property setter];

bool ssaoEnabled [@property getter];

bool ssaoEnabled [@property setter];

double ssaoIntensity [@property getter];

double ssaoIntensity [@property setter];

double ssaoIntensity2 [@property getter];

double ssaoIntensity2 [@property setter];

double ssaoLightAffect [@property getter];

double ssaoLightAffect [@property setter];

Environment.SSAOQuality ssaoQuality [@property getter];

long ssaoQuality [@property setter];

double ssaoRadius [@property getter];

double ssaoRadius [@property setter];

double ssaoRadius2 [@property getter];

double ssaoRadius2 [@property setter];

double tonemapExposure [@property getter];

double tonemapExposure [@property setter];

Environment.ToneMapper tonemapMode [@property getter];

long tonemapMode [@property setter];

double tonemapWhite [@property getter];

double tonemapWhite [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

BGMode enum BGMode
Constants enum Constants
DOFBlurQuality enum DOFBlurQuality
GlowBlendMode enum GlowBlendMode
SSAOBlur enum SSAOBlur
SSAOQuality enum SSAOQuality
ToneMapper enum ToneMapper

Functions

getAdjustmentBrightness double getAdjustmentBrightness()
getAdjustmentColorCorrection Ref!Texture getAdjustmentColorCorrection()
getAdjustmentContrast double getAdjustmentContrast()
getAdjustmentSaturation double getAdjustmentSaturation()
getAmbientLightColor Color getAmbientLightColor()
getAmbientLightEnergy double getAmbientLightEnergy()
getAmbientLightSkyContribution double getAmbientLightSkyContribution()
getBackground Environment.BGMode getBackground()
getBgColor Color getBgColor()
getBgEnergy double getBgEnergy()
getCameraFeedId long getCameraFeedId()
getCanvasMaxLayer long getCanvasMaxLayer()
getDofBlurFarAmount double getDofBlurFarAmount()
getDofBlurFarDistance double getDofBlurFarDistance()
getDofBlurFarQuality Environment.DOFBlurQuality getDofBlurFarQuality()
getDofBlurFarTransition double getDofBlurFarTransition()
getDofBlurNearAmount double getDofBlurNearAmount()
getDofBlurNearDistance double getDofBlurNearDistance()
getDofBlurNearQuality Environment.DOFBlurQuality getDofBlurNearQuality()
getDofBlurNearTransition double getDofBlurNearTransition()
getFogColor Color getFogColor()
getFogDepthBegin double getFogDepthBegin()
getFogDepthCurve double getFogDepthCurve()
getFogDepthEnd double getFogDepthEnd()
getFogHeightCurve double getFogHeightCurve()
getFogHeightMax double getFogHeightMax()
getFogHeightMin double getFogHeightMin()
getFogSunAmount double getFogSunAmount()
getFogSunColor Color getFogSunColor()
getFogTransmitCurve double getFogTransmitCurve()
getGlowBlendMode Environment.GlowBlendMode getGlowBlendMode()
getGlowBloom double getGlowBloom()
getGlowHdrBleedScale double getGlowHdrBleedScale()
getGlowHdrBleedThreshold double getGlowHdrBleedThreshold()
getGlowHdrLuminanceCap double getGlowHdrLuminanceCap()
getGlowIntensity double getGlowIntensity()
getGlowStrength double getGlowStrength()
getSky Ref!Sky getSky()
getSkyCustomFov double getSkyCustomFov()
getSkyOrientation Basis getSkyOrientation()
getSkyRotation Vector3 getSkyRotation()
getSkyRotationDegrees Vector3 getSkyRotationDegrees()
getSsaoAoChannelAffect double getSsaoAoChannelAffect()
getSsaoBias double getSsaoBias()
getSsaoBlur Environment.SSAOBlur getSsaoBlur()
getSsaoColor Color getSsaoColor()
getSsaoDirectLightAffect double getSsaoDirectLightAffect()
getSsaoEdgeSharpness double getSsaoEdgeSharpness()
getSsaoIntensity double getSsaoIntensity()
getSsaoIntensity2 double getSsaoIntensity2()
getSsaoQuality Environment.SSAOQuality getSsaoQuality()
getSsaoRadius double getSsaoRadius()
getSsaoRadius2 double getSsaoRadius2()
getSsrDepthTolerance double getSsrDepthTolerance()
getSsrFadeIn double getSsrFadeIn()
getSsrFadeOut double getSsrFadeOut()
getSsrMaxSteps long getSsrMaxSteps()
getTonemapAutoExposure bool getTonemapAutoExposure()
getTonemapAutoExposureGrey double getTonemapAutoExposureGrey()
getTonemapAutoExposureMax double getTonemapAutoExposureMax()
getTonemapAutoExposureMin double getTonemapAutoExposureMin()
getTonemapAutoExposureSpeed double getTonemapAutoExposureSpeed()
getTonemapExposure double getTonemapExposure()
getTonemapWhite double getTonemapWhite()
getTonemapper Environment.ToneMapper getTonemapper()
isAdjustmentEnabled bool isAdjustmentEnabled()
isDofBlurFarEnabled bool isDofBlurFarEnabled()
isDofBlurNearEnabled bool isDofBlurNearEnabled()
isFogDepthEnabled bool isFogDepthEnabled()
isFogEnabled bool isFogEnabled()
isFogHeightEnabled bool isFogHeightEnabled()
isFogTransmitEnabled bool isFogTransmitEnabled()
isGlowBicubicUpscaleEnabled bool isGlowBicubicUpscaleEnabled()
isGlowEnabled bool isGlowEnabled()
isGlowLevelEnabled bool isGlowLevelEnabled(long idx): Returns true if the glow level idx is specified, false otherwise.
isSsaoEnabled bool isSsaoEnabled()
isSsrEnabled bool isSsrEnabled()
isSsrRough bool isSsrRough()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(typeof(null) n)
opEquals bool opEquals(Environment other)
setAdjustmentBrightness void setAdjustmentBrightness(double brightness)
setAdjustmentColorCorrection void setAdjustmentColorCorrection(Texture color_correction)
setAdjustmentContrast void setAdjustmentContrast(double contrast)
setAdjustmentEnable void setAdjustmentEnable(bool enabled)
setAdjustmentSaturation void setAdjustmentSaturation(double saturation)
setAmbientLightColor void setAmbientLightColor(Color color)
setAmbientLightEnergy void setAmbientLightEnergy(double energy)
setAmbientLightSkyContribution void setAmbientLightSkyContribution(double energy)
setBackground void setBackground(long mode)
setBgColor void setBgColor(Color color)
setBgEnergy void setBgEnergy(double energy)
setCameraFeedId void setCameraFeedId(long camera_feed_id)
setCanvasMaxLayer void setCanvasMaxLayer(long layer)
setDofBlurFarAmount void setDofBlurFarAmount(double intensity)
setDofBlurFarDistance void setDofBlurFarDistance(double intensity)
setDofBlurFarEnabled void setDofBlurFarEnabled(bool enabled)
setDofBlurFarQuality void setDofBlurFarQuality(long intensity)
setDofBlurFarTransition void setDofBlurFarTransition(double intensity)
setDofBlurNearAmount void setDofBlurNearAmount(double intensity)
setDofBlurNearDistance void setDofBlurNearDistance(double intensity)
setDofBlurNearEnabled void setDofBlurNearEnabled(bool enabled)
setDofBlurNearQuality void setDofBlurNearQuality(long level)
setDofBlurNearTransition void setDofBlurNearTransition(double intensity)
setFogColor void setFogColor(Color color)
setFogDepthBegin void setFogDepthBegin(double distance)
setFogDepthCurve void setFogDepthCurve(double curve)
setFogDepthEnabled void setFogDepthEnabled(bool enabled)
setFogDepthEnd void setFogDepthEnd(double distance)
setFogEnabled void setFogEnabled(bool enabled)
setFogHeightCurve void setFogHeightCurve(double curve)
setFogHeightEnabled void setFogHeightEnabled(bool enabled)
setFogHeightMax void setFogHeightMax(double height)
setFogHeightMin void setFogHeightMin(double height)
setFogSunAmount void setFogSunAmount(double amount)
setFogSunColor void setFogSunColor(Color color)
setFogTransmitCurve void setFogTransmitCurve(double curve)
setFogTransmitEnabled void setFogTransmitEnabled(bool enabled)
setGlowBicubicUpscale void setGlowBicubicUpscale(bool enabled)
setGlowBlendMode void setGlowBlendMode(long mode)
setGlowBloom void setGlowBloom(double amount)
setGlowEnabled void setGlowEnabled(bool enabled)
setGlowHdrBleedScale void setGlowHdrBleedScale(double scale)
setGlowHdrBleedThreshold void setGlowHdrBleedThreshold(double threshold)
setGlowHdrLuminanceCap void setGlowHdrLuminanceCap(double amount)
setGlowIntensity void setGlowIntensity(double intensity)
setGlowLevel void setGlowLevel(long idx, bool enabled): Enables or disables the glow level at index idx. Each level relies on the previous level. This means that enabling higher glow levels will slow down the glow effect rendering, even if previous levels aren't enabled.
setGlowStrength void setGlowStrength(double strength)
setSky void setSky(Sky sky)
setSkyCustomFov void setSkyCustomFov(double scale)
setSkyOrientation void setSkyOrientation(Basis orientation)
setSkyRotation void setSkyRotation(Vector3 euler_radians)
setSkyRotationDegrees void setSkyRotationDegrees(Vector3 euler_degrees)
setSsaoAoChannelAffect void setSsaoAoChannelAffect(double amount)
setSsaoBias void setSsaoBias(double bias)
setSsaoBlur void setSsaoBlur(long mode)
setSsaoColor void setSsaoColor(Color color)
setSsaoDirectLightAffect void setSsaoDirectLightAffect(double amount)
setSsaoEdgeSharpness void setSsaoEdgeSharpness(double edge_sharpness)
setSsaoEnabled void setSsaoEnabled(bool enabled)
setSsaoIntensity void setSsaoIntensity(double intensity)
setSsaoIntensity2 void setSsaoIntensity2(double intensity)
setSsaoQuality void setSsaoQuality(long quality)
setSsaoRadius void setSsaoRadius(double radius)
setSsaoRadius2 void setSsaoRadius2(double radius)
setSsrDepthTolerance void setSsrDepthTolerance(double depth_tolerance)
setSsrEnabled void setSsrEnabled(bool enabled)
setSsrFadeIn void setSsrFadeIn(double fade_in)
setSsrFadeOut void setSsrFadeOut(double fade_out)
setSsrMaxSteps void setSsrMaxSteps(long max_steps)
setSsrRough void setSsrRough(bool rough)
setTonemapAutoExposure void setTonemapAutoExposure(bool auto_exposure)
setTonemapAutoExposureGrey void setTonemapAutoExposureGrey(double exposure_grey)
setTonemapAutoExposureMax void setTonemapAutoExposureMax(double exposure_max)
setTonemapAutoExposureMin void setTonemapAutoExposureMin(double exposure_min)
setTonemapAutoExposureSpeed void setTonemapAutoExposureSpeed(double exposure_speed)
setTonemapExposure void setTonemapExposure(double exposure)
setTonemapWhite void setTonemapWhite(double white)
setTonemapper void setTonemapper(long mode)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

adjustmentBrightness double adjustmentBrightness [@property getter]
double adjustmentBrightness [@property setter]: The global brightness value of the rendered scene. Effective only if adjustment_enabled is true.
adjustmentColorCorrection Texture adjustmentColorCorrection [@property getter]
Texture adjustmentColorCorrection [@property setter]: Applies the provided Texture resource to affect the global color aspect of the rendered scene. Effective only if adjustment_enabled is true.
adjustmentContrast double adjustmentContrast [@property getter]
double adjustmentContrast [@property setter]: The global contrast value of the rendered scene (default value is 1). Effective only if adjustment_enabled is true.
adjustmentEnabled bool adjustmentEnabled [@property getter]
bool adjustmentEnabled [@property setter]: 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.
adjustmentSaturation double adjustmentSaturation [@property getter]
double adjustmentSaturation [@property setter]: The global color saturation value of the rendered scene (default value is 1). Effective only if adjustment_enabled is true.
ambientLightColor Color ambientLightColor [@property getter]
Color ambientLightColor [@property setter]: The ambient light's Color.
ambientLightEnergy double ambientLightEnergy [@property getter]
double ambientLightEnergy [@property setter]: The ambient light's energy. The higher the value, the stronger the light.
ambientLightSkyContribution double ambientLightSkyContribution [@property getter]
double ambientLightSkyContribution [@property setter]: 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.
autoExposureEnabled bool autoExposureEnabled [@property getter]
bool autoExposureEnabled [@property setter]: 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.
autoExposureMaxLuma double autoExposureMaxLuma [@property getter]
double autoExposureMaxLuma [@property setter]: The maximum luminance value for the auto exposure.
autoExposureMinLuma double autoExposureMinLuma [@property getter]
double autoExposureMinLuma [@property setter]: The minimum luminance value for the auto exposure.
autoExposureScale double autoExposureScale [@property getter]
double autoExposureScale [@property setter]: The scale of the auto exposure effect. Affects the intensity of auto exposure.
autoExposureSpeed double autoExposureSpeed [@property getter]
double autoExposureSpeed [@property setter]: The speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.
backgroundCameraFeedId long backgroundCameraFeedId [@property getter]
long backgroundCameraFeedId [@property setter]: The ID of the camera feed to show in the background.
backgroundCanvasMaxLayer long backgroundCanvasMaxLayer [@property getter]
long backgroundCanvasMaxLayer [@property setter]: The maximum layer ID to display. Only effective when using the constant BG_CANVAS background mode.
backgroundColor Color backgroundColor [@property getter]
Color backgroundColor [@property setter]: The Color displayed for clear areas of the scene. Only effective when using the constant BG_COLOR or constant BG_COLOR_SKY background modes).
backgroundEnergy double backgroundEnergy [@property getter]
double backgroundEnergy [@property setter]: The power of the light emitted by the background.
backgroundMode Environment.BGMode backgroundMode [@property getter]
long backgroundMode [@property setter]: The background mode. See bgmode for possible values.
backgroundSky Sky backgroundSky [@property getter]
Sky backgroundSky [@property setter]: The Sky resource defined as background.
backgroundSkyCustomFov double backgroundSkyCustomFov [@property getter]
double backgroundSkyCustomFov [@property setter]: The Sky resource's custom field of view.
backgroundSkyOrientation Basis backgroundSkyOrientation [@property getter]
Basis backgroundSkyOrientation [@property setter]: The Sky resource's rotation expressed as a Basis.
backgroundSkyRotation Vector3 backgroundSkyRotation [@property getter]
Vector3 backgroundSkyRotation [@property setter]: The Sky resource's rotation expressed as Euler angles in radians.
backgroundSkyRotationDegrees Vector3 backgroundSkyRotationDegrees [@property getter]
Vector3 backgroundSkyRotationDegrees [@property setter]: The Sky resource's rotation expressed as Euler angles in degrees.
dofBlurFarAmount double dofBlurFarAmount [@property getter]
double dofBlurFarAmount [@property setter]: The amount of far blur for the depth-of-field effect.
dofBlurFarDistance double dofBlurFarDistance [@property getter]
double dofBlurFarDistance [@property setter]: The distance from the camera where the far blur effect affects the rendering.
dofBlurFarEnabled bool dofBlurFarEnabled [@property getter]
bool dofBlurFarEnabled [@property setter]: If true, enables the depth-of-field far blur effect.
dofBlurFarQuality Environment.DOFBlurQuality dofBlurFarQuality [@property getter]
long dofBlurFarQuality [@property setter]: The depth-of-field far blur's quality. Higher values can mitigate the visible banding effect seen at higher strengths, but are much slower.
dofBlurFarTransition double dofBlurFarTransition [@property getter]
double dofBlurFarTransition [@property setter]: The length of the transition between the no-blur area and far blur.
dofBlurNearAmount double dofBlurNearAmount [@property getter]
double dofBlurNearAmount [@property setter]: The amount of near blur for the depth-of-field effect.
dofBlurNearDistance double dofBlurNearDistance [@property getter]
double dofBlurNearDistance [@property setter]: Distance from the camera where the near blur effect affects the rendering.
dofBlurNearEnabled bool dofBlurNearEnabled [@property getter]
bool dofBlurNearEnabled [@property setter]: If true, enables the depth-of-field near blur effect.
dofBlurNearQuality Environment.DOFBlurQuality dofBlurNearQuality [@property getter]
long dofBlurNearQuality [@property setter]: The depth-of-field near blur's quality. Higher values can mitigate the visible banding effect seen at higher strengths, but are much slower.
dofBlurNearTransition double dofBlurNearTransition [@property getter]
double dofBlurNearTransition [@property setter]: The length of the transition between the near blur and no-blur area.
fogColor Color fogColor [@property getter]
Color fogColor [@property setter]: The fog's Color.
fogDepthBegin double fogDepthBegin [@property getter]
double fogDepthBegin [@property setter]: The fog's depth starting distance from the camera.
fogDepthCurve double fogDepthCurve [@property getter]
double fogDepthCurve [@property setter]: The fog depth's intensity curve. A number of presets are available in the Inspector by right-clicking the curve.
fogDepthEnabled bool fogDepthEnabled [@property setter]: If true, the depth fog effect is enabled. When enabled, fog will appear in the distance (relative to the camera).
fogDepthEnabled bool fogDepthEnabled [@property getter]: If true, the depth fog effect is enabled. When enabled, fog will appear in the distance (relative to the camera).
fogDepthEnd double fogDepthEnd [@property setter]: 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 Camera.far value.
fogDepthEnd double fogDepthEnd [@property getter]: 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 Camera.far value.
fogEnabled bool fogEnabled [@property setter]: If true, fog effects are enabled. fogHeightEnabled and/or fogDepthEnabled must be set to true to actually display fog.
fogEnabled bool fogEnabled [@property getter]: If true, fog effects are enabled. fogHeightEnabled and/or fogDepthEnabled must be set to true to actually display fog.
fogHeightCurve double fogHeightCurve [@property getter]
double fogHeightCurve [@property setter]: The height fog's intensity. A number of presets are available in the Inspector by right-clicking the curve.
fogHeightEnabled bool fogHeightEnabled [@property getter]
bool fogHeightEnabled [@property setter]: 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.
fogHeightMax double fogHeightMax [@property getter]
double fogHeightMax [@property setter]: 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.
fogHeightMin double fogHeightMin [@property getter]
double fogHeightMin [@property setter]: 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.
fogSunAmount double fogSunAmount [@property getter]
double fogSunAmount [@property setter]: 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.
fogSunColor Color fogSunColor [@property getter]
Color fogSunColor [@property setter]: The depth fog's Color when looking towards the sun.
fogTransmitCurve double fogTransmitCurve [@property getter]
double fogTransmitCurve [@property setter]: The intensity of the fog light transmittance effect. Amount of light that the fog transmits.
fogTransmitEnabled bool fogTransmitEnabled [@property getter]
bool fogTransmitEnabled [@property setter]: Enables fog's light transmission effect. If true, light will be more visible in the fog to simulate light scattering as in real life.
glowBicubicUpscale bool glowBicubicUpscale [@property getter]
bool glowBicubicUpscale [@property setter]: 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.
glowBlendMode Environment.GlowBlendMode glowBlendMode [@property getter]
long glowBlendMode [@property setter]: The glow blending mode.
glowBloom double glowBloom [@property getter]
double glowBloom [@property setter]: The bloom's intensity. If set to a value higher than 0, this will make glow visible in areas darker than the glowHdrThreshold.
glowEnabled bool glowEnabled [@property getter]
bool glowEnabled [@property setter]: If true, the glow effect is enabled.
glowHdrLuminanceCap double glowHdrLuminanceCap [@property getter]
double glowHdrLuminanceCap [@property setter]: The higher threshold of the HDR glow. Areas brighter than this threshold will be clamped for the purposes of the glow effect.
glowHdrScale double glowHdrScale [@property getter]
double glowHdrScale [@property setter]: The bleed scale of the HDR glow.
glowHdrThreshold double glowHdrThreshold [@property getter]
double glowHdrThreshold [@property setter]: 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.
glowIntensity double glowIntensity [@property getter]
double glowIntensity [@property setter]: The glow intensity. When using the GLES2 renderer, this should be increased to 1.5 to compensate for the lack of HDR rendering.
glowLevels1 bool glowLevels1 [@property getter]
bool glowLevels1 [@property setter]: If true, the 1st level of glow is enabled. This is the most "local" level (least blurry).
glowLevels2 bool glowLevels2 [@property getter]
bool glowLevels2 [@property setter]: If true, the 2th level of glow is enabled.
glowLevels3 bool glowLevels3 [@property getter]
bool glowLevels3 [@property setter]: If true, the 3th level of glow is enabled.
glowLevels4 bool glowLevels4 [@property getter]
bool glowLevels4 [@property setter]: If true, the 4th level of glow is enabled.
glowLevels5 bool glowLevels5 [@property getter]
bool glowLevels5 [@property setter]: If true, the 5th level of glow is enabled.
glowLevels6 bool glowLevels6 [@property getter]
bool glowLevels6 [@property setter]: If true, the 6th level of glow is enabled.
glowLevels7 bool glowLevels7 [@property getter]
bool glowLevels7 [@property setter]: If true, the 7th level of glow is enabled. This is the most "global" level (blurriest).
glowStrength double glowStrength [@property getter]
double glowStrength [@property setter]: The glow strength. When using the GLES2 renderer, this should be increased to 1.3 to compensate for the lack of HDR rendering.
ssReflectionsDepthTolerance double ssReflectionsDepthTolerance [@property getter]
double ssReflectionsDepthTolerance [@property setter]: The depth tolerance for screen-space reflections.
ssReflectionsEnabled bool ssReflectionsEnabled [@property getter]
bool ssReflectionsEnabled [@property setter]: 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.
ssReflectionsFadeIn double ssReflectionsFadeIn [@property getter]
double ssReflectionsFadeIn [@property setter]: The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection).
ssReflectionsFadeOut double ssReflectionsFadeOut [@property getter]
double ssReflectionsFadeOut [@property setter]: The fade-out distance for screen-space reflections. Affects the area from the screen-space reflection to the "global" reflection.
ssReflectionsMaxSteps long ssReflectionsMaxSteps [@property getter]
long ssReflectionsMaxSteps [@property setter]: The maximum number of steps for screen-space reflections. Higher values are slower.
ssReflectionsRoughness bool ssReflectionsRoughness [@property getter]
bool ssReflectionsRoughness [@property setter]: If true, screen-space reflections will take the material roughness into account.
ssaoAoChannelAffect double ssaoAoChannelAffect [@property getter]
double ssaoAoChannelAffect [@property setter]: 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.
ssaoBias double ssaoBias [@property getter]
double ssaoBias [@property setter]: The screen-space ambient occlusion bias. This should be kept high enough to prevent "smooth" curves from being affected by ambient occlusion.
ssaoBlur Environment.SSAOBlur ssaoBlur [@property getter]
long ssaoBlur [@property setter]: The screen-space ambient occlusion blur quality. See ssaoblur for possible values.
ssaoColor Color ssaoColor [@property getter]
Color ssaoColor [@property setter]: The screen-space ambient occlusion color.
ssaoEdgeSharpness double ssaoEdgeSharpness [@property getter]
double ssaoEdgeSharpness [@property setter]: The screen-space ambient occlusion edge sharpness.
ssaoEnabled bool ssaoEnabled [@property getter]
bool ssaoEnabled [@property setter]: 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.
ssaoIntensity double ssaoIntensity [@property getter]
double ssaoIntensity [@property setter]: The primary screen-space ambient occlusion intensity. See also ssaoRadius.
ssaoIntensity2 double ssaoIntensity2 [@property getter]
double ssaoIntensity2 [@property setter]: The secondary screen-space ambient occlusion intensity. See also ssaoRadius2.
ssaoLightAffect double ssaoLightAffect [@property getter]
double ssaoLightAffect [@property setter]: 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.
ssaoQuality Environment.SSAOQuality ssaoQuality [@property getter]
long ssaoQuality [@property setter]: The screen-space ambient occlusion quality. Higher qualities will make better use of small objects for ambient occlusion, but are slower.
ssaoRadius double ssaoRadius [@property getter]
double ssaoRadius [@property setter]: The primary screen-space ambient occlusion radius.
ssaoRadius2 double ssaoRadius2 [@property setter]: 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).
ssaoRadius2 double ssaoRadius2 [@property getter]: 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).
tonemapExposure double tonemapExposure [@property setter]: The default exposure used for tonemapping.
tonemapExposure double tonemapExposure [@property getter]: The default exposure used for tonemapping.
tonemapMode long tonemapMode [@property setter]: 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.)
tonemapMode Environment.ToneMapper tonemapMode [@property getter]: 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.)
tonemapWhite double tonemapWhite [@property getter]
double tonemapWhite [@property setter]: The white reference value for tonemapping. Only effective if the tonemapMode isn't set to constant TONE_MAPPER_LINEAR.

Static functions

_new Environment _new(): Construct a new instance of Environment. Note: use memnew!Environment instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot environment structs

Environment