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:

- DOF Blur - Motion Blur - Bloom - Tonemap (auto exposure) - Adjustments

@GodotBaseClass

struct Environment {

enum string _GODOT_internal_name;

union __anonymous;

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

bool opEquals(Environment other);

Environment opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static Environment _new();

enum ToneMapper;

enum GlowBlendMode;

enum SSAOQuality;

enum DOFBlurQuality;

enum Constants;

void setBackground(long mode);

void setSky(Sky sky);

void setSkyCustomFov(double scale);

void setBgColor(Color color);

void setBgEnergy(double energy);

void setCanvasMaxLayer(long layer);

void setAmbientLightColor(Color color);

void setAmbientLightEnergy(double energy);

void setAmbientLightSkyContribution(double energy);

Environment.BGMode getBackground();

Ref!Sky getSky();

double getSkyCustomFov();

Color getBgColor();

double getBgEnergy();

long getCanvasMaxLayer();

Color getAmbientLightColor();

double getAmbientLightEnergy();

double getAmbientLightSkyContribution();

void setFogEnabled(bool enabled);

bool isFogEnabled();

void setFogColor(Color color);

Color getFogColor();

void setFogSunColor(Color color);

Color getFogSunColor();

void setFogSunAmount(double amount);

double getFogSunAmount();

void setFogDepthEnabled(bool enabled);

bool isFogDepthEnabled();

void setFogDepthBegin(double distance);

double getFogDepthBegin();

void setFogDepthCurve(double curve);

double getFogDepthCurve();

void setFogTransmitEnabled(bool enabled);

bool isFogTransmitEnabled();

void setFogTransmitCurve(double curve);

double getFogTransmitCurve();

void setFogHeightEnabled(bool enabled);

bool isFogHeightEnabled();

void setFogHeightMin(double height);

double getFogHeightMin();

void setFogHeightMax(double height);

double getFogHeightMax();

void setFogHeightCurve(double curve);

double getFogHeightCurve();

void setTonemapper(long mode);

Environment.ToneMapper getTonemapper();

void setTonemapExposure(double exposure);

double getTonemapExposure();

void setTonemapWhite(double white);

double getTonemapWhite();

void setTonemapAutoExposure(bool auto_exposure);

bool getTonemapAutoExposure();

void setTonemapAutoExposureMax(double exposure_max);

double getTonemapAutoExposureMax();

void setTonemapAutoExposureMin(double exposure_min);

double getTonemapAutoExposureMin();

void setTonemapAutoExposureSpeed(double exposure_speed);

double getTonemapAutoExposureSpeed();

void setTonemapAutoExposureGrey(double exposure_grey);

double getTonemapAutoExposureGrey();

void setSsrEnabled(bool enabled);

bool isSsrEnabled();

void setSsrMaxSteps(long max_steps);

long getSsrMaxSteps();

void setSsrFadeIn(double fade_in);

double getSsrFadeIn();

void setSsrFadeOut(double fade_out);

double getSsrFadeOut();

void setSsrDepthTolerance(double depth_tolerance);

double getSsrDepthTolerance();

void setSsrRough(bool rough);

bool isSsrRough();

void setSsaoEnabled(bool enabled);

bool isSsaoEnabled();

void setSsaoRadius(double radius);

double getSsaoRadius();

void setSsaoIntensity(double intensity);

double getSsaoIntensity();

void setSsaoRadius2(double radius);

double getSsaoRadius2();

void setSsaoIntensity2(double intensity);

double getSsaoIntensity2();

void setSsaoBias(double bias);

double getSsaoBias();

void setSsaoDirectLightAffect(double amount);

double getSsaoDirectLightAffect();

void setSsaoAoChannelAffect(double amount);

double getSsaoAoChannelAffect();

void setSsaoColor(Color color);

Color getSsaoColor();

void setSsaoBlur(long mode);

Environment.SSAOBlur getSsaoBlur();

void setSsaoQuality(long quality);

Environment.SSAOQuality getSsaoQuality();

void setSsaoEdgeSharpness(double edge_sharpness);

double getSsaoEdgeSharpness();

void setDofBlurFarEnabled(bool enabled);

bool isDofBlurFarEnabled();

void setDofBlurFarDistance(double intensity);

double getDofBlurFarDistance();

void setDofBlurFarTransition(double intensity);

double getDofBlurFarTransition();

void setDofBlurFarAmount(double intensity);

double getDofBlurFarAmount();

void setDofBlurFarQuality(long intensity);

Environment.DOFBlurQuality getDofBlurFarQuality();

void setDofBlurNearEnabled(bool enabled);

bool isDofBlurNearEnabled();

void setDofBlurNearDistance(double intensity);

double getDofBlurNearDistance();

void setDofBlurNearTransition(double intensity);

double getDofBlurNearTransition();

void setDofBlurNearAmount(double intensity);

double getDofBlurNearAmount();

void setDofBlurNearQuality(long level);

Environment.DOFBlurQuality getDofBlurNearQuality();

void setGlowEnabled(bool enabled);

bool isGlowEnabled();

void setGlowLevel(long idx, bool enabled);

bool isGlowLevelEnabled(long idx);

void setGlowIntensity(double intensity);

double getGlowIntensity();

void setGlowStrength(double strength);

double getGlowStrength();

void setGlowBloom(double amount);

double getGlowBloom();

void setGlowBlendMode(long mode);

Environment.GlowBlendMode getGlowBlendMode();

void setGlowHdrBleedThreshold(double threshold);

double getGlowHdrBleedThreshold();

void setGlowHdrBleedScale(double scale);

double getGlowHdrBleedScale();

void setGlowBicubicUpscale(bool enabled);

bool isGlowBicubicUpscaleEnabled();

void setAdjustmentEnable(bool enabled);

bool isAdjustmentEnabled();

void setAdjustmentBrightness(double brightness);

double getAdjustmentBrightness();

void setAdjustmentContrast(double contrast);

double getAdjustmentContrast();

void setAdjustmentSaturation(double saturation);

double getAdjustmentSaturation();

void setAdjustmentColorCorrection(Texture color_correction);

Ref!Texture getAdjustmentColorCorrection();

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];

Color backgroundColor [@property getter];

Color backgroundColor [@property setter];

double backgroundEnergy [@property getter];

double backgroundEnergy [@property setter];

long backgroundCanvasMaxLayer [@property getter];

long backgroundCanvasMaxLayer [@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 fogEnabled [@property getter];

bool fogEnabled [@property setter];

Color fogColor [@property getter];

Color fogColor [@property setter];

Color fogSunColor [@property getter];

Color fogSunColor [@property setter];

double fogSunAmount [@property getter];

double fogSunAmount [@property setter];

bool fogDepthEnabled [@property getter];

bool fogDepthEnabled [@property setter];

double fogDepthBegin [@property getter];

double fogDepthBegin [@property setter];

double fogDepthCurve [@property getter];

double fogDepthCurve [@property setter];

bool fogTransmitEnabled [@property getter];

bool fogTransmitEnabled [@property setter];

double fogTransmitCurve [@property getter];

double fogTransmitCurve [@property setter];

bool fogHeightEnabled [@property getter];

bool fogHeightEnabled [@property setter];

double fogHeightMin [@property getter];

double fogHeightMin [@property setter];

double fogHeightMax [@property getter];

double fogHeightMax [@property setter];

double fogHeightCurve [@property getter];

double fogHeightCurve [@property setter];

Environment.ToneMapper tonemapMode [@property getter];

long tonemapMode [@property setter];

double tonemapExposure [@property getter];

double tonemapExposure [@property setter];

double tonemapWhite [@property getter];

double tonemapWhite [@property setter];

bool autoExposureEnabled [@property getter];

bool autoExposureEnabled [@property setter];

double autoExposureScale [@property getter];

double autoExposureScale [@property setter];

double autoExposureMinLuma [@property getter];

double autoExposureMinLuma [@property setter];

double autoExposureMaxLuma [@property getter];

double autoExposureMaxLuma [@property setter];

double autoExposureSpeed [@property getter];

double autoExposureSpeed [@property setter];

bool ssReflectionsEnabled [@property getter];

bool ssReflectionsEnabled [@property setter];

long ssReflectionsMaxSteps [@property getter];

long ssReflectionsMaxSteps [@property setter];

double ssReflectionsFadeIn [@property getter];

double ssReflectionsFadeIn [@property setter];

double ssReflectionsFadeOut [@property getter];

double ssReflectionsFadeOut [@property setter];

double ssReflectionsDepthTolerance [@property getter];

double ssReflectionsDepthTolerance [@property setter];

bool ssReflectionsRoughness [@property getter];

bool ssReflectionsRoughness [@property setter];

bool ssaoEnabled [@property getter];

bool ssaoEnabled [@property setter];

double ssaoRadius [@property getter];

double ssaoRadius [@property setter];

double ssaoIntensity [@property getter];

double ssaoIntensity [@property setter];

double ssaoRadius2 [@property getter];

double ssaoRadius2 [@property setter];

double ssaoIntensity2 [@property getter];

double ssaoIntensity2 [@property setter];

double ssaoBias [@property getter];

double ssaoBias [@property setter];

double ssaoLightAffect [@property getter];

double ssaoLightAffect [@property setter];

double ssaoAoChannelAffect [@property getter];

double ssaoAoChannelAffect [@property setter];

Color ssaoColor [@property getter];

Color ssaoColor [@property setter];

Environment.SSAOQuality ssaoQuality [@property getter];

long ssaoQuality [@property setter];

Environment.SSAOBlur ssaoBlur [@property getter];

long ssaoBlur [@property setter];

double ssaoEdgeSharpness [@property getter];

double ssaoEdgeSharpness [@property setter];

bool dofBlurFarEnabled [@property getter];

bool dofBlurFarEnabled [@property setter];

double dofBlurFarDistance [@property getter];

double dofBlurFarDistance [@property setter];

double dofBlurFarTransition [@property getter];

double dofBlurFarTransition [@property setter];

double dofBlurFarAmount [@property getter];

double dofBlurFarAmount [@property setter];

Environment.DOFBlurQuality dofBlurFarQuality [@property getter];

long dofBlurFarQuality [@property setter];

bool dofBlurNearEnabled [@property getter];

bool dofBlurNearEnabled [@property setter];

double dofBlurNearDistance [@property getter];

double dofBlurNearDistance [@property setter];

double dofBlurNearTransition [@property getter];

double dofBlurNearTransition [@property setter];

double dofBlurNearAmount [@property getter];

double dofBlurNearAmount [@property setter];

Environment.DOFBlurQuality dofBlurNearQuality [@property getter];

long dofBlurNearQuality [@property setter];

bool glowEnabled [@property getter];

bool glowEnabled [@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 glowIntensity [@property getter];

double glowIntensity [@property setter];

double glowStrength [@property getter];

double glowStrength [@property setter];

double glowBloom [@property getter];

double glowBloom [@property setter];

Environment.GlowBlendMode glowBlendMode [@property getter];

long glowBlendMode [@property setter];

double glowHdrThreshold [@property getter];

double glowHdrThreshold [@property setter];

double glowHdrScale [@property getter];

double glowHdrScale [@property setter];

bool glowBicubicUpscale [@property getter];

bool glowBicubicUpscale [@property setter];

bool adjustmentEnabled [@property getter];

bool adjustmentEnabled [@property setter];

double adjustmentBrightness [@property getter];

double adjustmentBrightness [@property setter];

double adjustmentContrast [@property getter];

double adjustmentContrast [@property setter];

double adjustmentSaturation [@property getter];

double adjustmentSaturation [@property setter];

Texture adjustmentColorCorrection [@property getter];

Texture adjustmentColorCorrection [@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()
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()
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()
getGlowIntensity double getGlowIntensity()
getGlowStrength double getGlowStrength()
getSky Ref!Sky getSky()
getSkyCustomFov double getSkyCustomFov()
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)
isSsaoEnabled bool isSsaoEnabled()
isSsrEnabled bool isSsrEnabled()
isSsrRough bool isSsrRough()
opAssign Environment opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(Environment other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
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)
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)
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)
setGlowIntensity void setGlowIntensity(double intensity)
setGlowLevel void setGlowLevel(long idx, bool enabled)
setGlowStrength void setGlowStrength(double strength)
setSky void setSky(Sky sky)
setSkyCustomFov void setSkyCustomFov(double scale)
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)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

adjustmentBrightness double adjustmentBrightness [@property getter]
double adjustmentBrightness [@property setter]: Global brightness value of the rendered scene (default value is 1).
adjustmentColorCorrection Texture adjustmentColorCorrection [@property getter]
Texture adjustmentColorCorrection [@property setter]: Applies the provided Texture resource to affect the global color aspect of the rendered scene.
adjustmentContrast double adjustmentContrast [@property getter]
double adjustmentContrast [@property setter]: Global contrast value of the rendered scene (default value is 1).
adjustmentEnabled bool adjustmentEnabled [@property setter]: Enables the adjustment_* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene.
adjustmentEnabled bool adjustmentEnabled [@property getter]: Enables the adjustment_* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene.
adjustmentSaturation double adjustmentSaturation [@property getter]
double adjustmentSaturation [@property setter]: Global color saturation value of the rendered scene (default value is 1).
ambientLightColor Color ambientLightColor [@property getter]
Color ambientLightColor [@property setter]: Color of the ambient light.
ambientLightEnergy double ambientLightEnergy [@property getter]
double ambientLightEnergy [@property setter]: Energy of the ambient light. 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]: Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light.
autoExposureMaxLuma double autoExposureMaxLuma [@property getter]
double autoExposureMaxLuma [@property setter]: Maximum luminance value for the auto exposure.
autoExposureMinLuma double autoExposureMinLuma [@property getter]
double autoExposureMinLuma [@property setter]: Minimum luminance value for the auto exposure.
autoExposureScale double autoExposureScale [@property getter]
double autoExposureScale [@property setter]: Scale of the auto exposure effect. Affects the intensity of auto exposure.
autoExposureSpeed double autoExposureSpeed [@property getter]
double autoExposureSpeed [@property setter]: Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.
backgroundCanvasMaxLayer long backgroundCanvasMaxLayer [@property getter]
long backgroundCanvasMaxLayer [@property setter]: Maximum layer id (if using Layer background mode).
backgroundColor Color backgroundColor [@property getter]
Color backgroundColor [@property setter]: Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).
backgroundEnergy double backgroundEnergy [@property getter]
double backgroundEnergy [@property setter]: Power of light emitted by the background.
backgroundMode Environment.BGMode backgroundMode [@property getter]
long backgroundMode [@property setter]: Defines the mode of background.
backgroundSky Sky backgroundSky [@property getter]
Sky backgroundSky [@property setter]: Sky resource defined as background.
backgroundSkyCustomFov double backgroundSkyCustomFov [@property getter]
double backgroundSkyCustomFov [@property setter]: Sky resource's custom field of view.
dofBlurFarAmount double dofBlurFarAmount [@property setter]: Amount of far blur.
dofBlurFarAmount double dofBlurFarAmount [@property getter]: Amount of far blur.
dofBlurFarDistance double dofBlurFarDistance [@property getter]
double dofBlurFarDistance [@property setter]: Distance from the camera where the far blur effect affects the rendering.
dofBlurFarEnabled bool dofBlurFarEnabled [@property setter]: Enables the far blur effect.
dofBlurFarEnabled bool dofBlurFarEnabled [@property getter]: Enables the far blur effect.
dofBlurFarQuality long dofBlurFarQuality [@property setter]: Quality of the far blur quality.
dofBlurFarQuality Environment.DOFBlurQuality dofBlurFarQuality [@property getter]: Quality of the far blur quality.
dofBlurFarTransition double dofBlurFarTransition [@property setter]: Transition between no-blur area and far blur.
dofBlurFarTransition double dofBlurFarTransition [@property getter]: Transition between no-blur area and far blur.
dofBlurNearAmount double dofBlurNearAmount [@property setter]: Amount of near blur.
dofBlurNearAmount double dofBlurNearAmount [@property getter]: Amount of near blur.
dofBlurNearDistance double dofBlurNearDistance [@property setter]: Distance from the camera where the near blur effect affects the rendering.
dofBlurNearDistance double dofBlurNearDistance [@property getter]: Distance from the camera where the near blur effect affects the rendering.
dofBlurNearEnabled bool dofBlurNearEnabled [@property setter]: Enables the near blur effect.
dofBlurNearEnabled bool dofBlurNearEnabled [@property getter]: Enables the near blur effect.
dofBlurNearQuality long dofBlurNearQuality [@property setter]: Quality of the near blur quality.
dofBlurNearQuality Environment.DOFBlurQuality dofBlurNearQuality [@property getter]: Quality of the near blur quality.
dofBlurNearTransition double dofBlurNearTransition [@property setter]: Transition between near blur and no-blur area.
dofBlurNearTransition double dofBlurNearTransition [@property getter]: Transition between near blur and no-blur area.
fogColor Color fogColor [@property getter]
Color fogColor [@property setter]: Fog's Color.
fogDepthBegin double fogDepthBegin [@property getter]
double fogDepthBegin [@property setter]: Fog's depth starting distance from the camera.
fogDepthCurve double fogDepthCurve [@property getter]
double fogDepthCurve [@property setter]: Value defining the fog depth intensity.
fogDepthEnabled bool fogDepthEnabled [@property getter]
bool fogDepthEnabled [@property setter]: Enables the fog depth.
fogEnabled bool fogEnabled [@property getter]
bool fogEnabled [@property setter]: Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.
fogHeightCurve double fogHeightCurve [@property getter]
double fogHeightCurve [@property setter]: Value defining the fog height intensity.
fogHeightEnabled bool fogHeightEnabled [@property getter]
bool fogHeightEnabled [@property setter]: Enables the fog height.
fogHeightMax double fogHeightMax [@property getter]
double fogHeightMax [@property setter]: Maximum height of fog.
fogHeightMin double fogHeightMin [@property getter]
double fogHeightMin [@property setter]: Minimum height of fog.
fogSunAmount double fogSunAmount [@property getter]
double fogSunAmount [@property setter]: Amount of sun that affects the fog rendering.
fogSunColor Color fogSunColor [@property getter]
Color fogSunColor [@property setter]: Sun Color.
fogTransmitCurve double fogTransmitCurve [@property getter]
double fogTransmitCurve [@property setter]: Amount of light that the fog transmits.
fogTransmitEnabled bool fogTransmitEnabled [@property getter]
bool fogTransmitEnabled [@property setter]: Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog.
glowBicubicUpscale bool glowBicubicUpscale [@property setter]
glowBicubicUpscale bool glowBicubicUpscale [@property getter]
glowBlendMode long glowBlendMode [@property setter]: Glow blending mode.
glowBlendMode Environment.GlowBlendMode glowBlendMode [@property getter]: Glow blending mode.
glowBloom double glowBloom [@property setter]: Bloom value (global glow).
glowBloom double glowBloom [@property getter]: Bloom value (global glow).
glowEnabled bool glowEnabled [@property setter]: Enables glow rendering.
glowEnabled bool glowEnabled [@property getter]: Enables glow rendering.
glowHdrScale double glowHdrScale [@property setter]: Bleed scale of the HDR glow.
glowHdrScale double glowHdrScale [@property getter]: Bleed scale of the HDR glow.
glowHdrThreshold double glowHdrThreshold [@property setter]: Bleed threshold of the HDR glow.
glowHdrThreshold double glowHdrThreshold [@property getter]: Bleed threshold of the HDR glow.
glowIntensity double glowIntensity [@property getter]
double glowIntensity [@property setter]: Glow intensity.
glowLevels1 bool glowLevels1 [@property getter]
bool glowLevels1 [@property setter]: First level of glow (most local).
glowLevels2 bool glowLevels2 [@property getter]
bool glowLevels2 [@property setter]: Second level of glow.
glowLevels3 bool glowLevels3 [@property getter]
bool glowLevels3 [@property setter]: Third level of glow.
glowLevels4 bool glowLevels4 [@property getter]
bool glowLevels4 [@property setter]: Fourth level of glow.
glowLevels5 bool glowLevels5 [@property getter]
bool glowLevels5 [@property setter]: Fifth level of glow.
glowLevels6 bool glowLevels6 [@property getter]
bool glowLevels6 [@property setter]: Sixth level of glow.
glowLevels7 bool glowLevels7 [@property getter]
bool glowLevels7 [@property setter]: Seventh level of glow (most global).
glowStrength double glowStrength [@property getter]
double glowStrength [@property setter]: Glow strength.
ssReflectionsDepthTolerance double ssReflectionsDepthTolerance [@property setter]
ssReflectionsDepthTolerance double ssReflectionsDepthTolerance [@property getter]
ssReflectionsEnabled bool ssReflectionsEnabled [@property setter]
ssReflectionsEnabled bool ssReflectionsEnabled [@property getter]
ssReflectionsFadeIn double ssReflectionsFadeIn [@property setter]
ssReflectionsFadeIn double ssReflectionsFadeIn [@property getter]
ssReflectionsFadeOut double ssReflectionsFadeOut [@property setter]
ssReflectionsFadeOut double ssReflectionsFadeOut [@property getter]
ssReflectionsMaxSteps long ssReflectionsMaxSteps [@property setter]
ssReflectionsMaxSteps long ssReflectionsMaxSteps [@property getter]
ssReflectionsRoughness bool ssReflectionsRoughness [@property setter]
ssReflectionsRoughness bool ssReflectionsRoughness [@property getter]
ssaoAoChannelAffect double ssaoAoChannelAffect [@property setter]
ssaoAoChannelAffect double ssaoAoChannelAffect [@property getter]
ssaoBias double ssaoBias [@property setter]
ssaoBias double ssaoBias [@property getter]
ssaoBlur Environment.SSAOBlur ssaoBlur [@property getter]
long ssaoBlur [@property setter]
ssaoColor Color ssaoColor [@property setter]
ssaoColor Color ssaoColor [@property getter]
ssaoEdgeSharpness double ssaoEdgeSharpness [@property getter]
double ssaoEdgeSharpness [@property setter]
ssaoEnabled bool ssaoEnabled [@property setter]
ssaoEnabled bool ssaoEnabled [@property getter]
ssaoIntensity double ssaoIntensity [@property setter]
ssaoIntensity double ssaoIntensity [@property getter]
ssaoIntensity2 double ssaoIntensity2 [@property setter]
ssaoIntensity2 double ssaoIntensity2 [@property getter]
ssaoLightAffect double ssaoLightAffect [@property setter]
ssaoLightAffect double ssaoLightAffect [@property getter]
ssaoQuality Environment.SSAOQuality ssaoQuality [@property getter]
long ssaoQuality [@property setter]
ssaoRadius double ssaoRadius [@property setter]
ssaoRadius double ssaoRadius [@property getter]
ssaoRadius2 double ssaoRadius2 [@property setter]
ssaoRadius2 double ssaoRadius2 [@property getter]
tonemapExposure double tonemapExposure [@property setter]: Default exposure for tonemap.
tonemapExposure double tonemapExposure [@property getter]: Default exposure for tonemap.
tonemapMode long tonemapMode [@property setter]: Tonemapping mode.
tonemapMode Environment.ToneMapper tonemapMode [@property getter]: Tonemapping mode.
tonemapWhite double tonemapWhite [@property setter]: White reference value for tonemap.
tonemapWhite double tonemapWhite [@property getter]: White reference value for tonemap.

Static functions

_new Environment _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: 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 To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as 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