Table of Contents

Class Sky

Namespace
Godot
Assembly
GodotSharp.dll

The Sky class uses a Material to render a 3D environment's background and the light it emits by updating the reflection/radiance cubemaps.

public class Sky : Resource, IDisposable
Inheritance
Sky
Implements
Inherited Members

Constructors

Sky() 

public Sky()

Properties

ProcessMode

Sets the method for generating the radiance map from the sky. The radiance map is a cubemap with increasingly blurry versions of the sky corresponding to different levels of roughness. Radiance maps can be expensive to calculate. See Sky.ProcessModeEnum for options.

public Sky.ProcessModeEnum ProcessMode { get; set; }

Property Value

Sky.ProcessModeEnum

RadianceSize

The Sky's radiance map size. The higher the radiance map size, the more detailed the lighting from the Sky will be.

See Sky.RadianceSizeEnum constants for values.

Note: Some hardware will have trouble with higher radiance sizes, especially Size512 and above. Only use such high values on high-end hardware.

public Sky.RadianceSizeEnum RadianceSize { get; set; }

Property Value

Sky.RadianceSizeEnum

SkyMaterial

Material used to draw the background. Can be PanoramaSkyMaterial, ProceduralSkyMaterial, PhysicalSkyMaterial, or even a ShaderMaterial if you want to use your own custom shader.

public Material SkyMaterial { get; set; }

Property Value

Material

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool
Edit this page