Class reference

Sky

Inherits Resource

Defines a 3D environment's background by using a Material.

Description

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

Properties

int process_mode = 0

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.

int radiance_size = 3

The Sky's radiance map size. The higher the radiance map size, the more detailed the lighting from the Sky will be. Note: Some hardware will have trouble with higher radiance sizes, especially RADIANCE_SIZE_512 and above. Only use such high values on high-end hardware.

Constants

RADIANCE_SIZE_32 = 0

Enum: RadianceSize

Radiance texture size is 32×32 pixels.

RADIANCE_SIZE_64 = 1

Enum: RadianceSize

Radiance texture size is 64×64 pixels.

RADIANCE_SIZE_128 = 2

Enum: RadianceSize

Radiance texture size is 128×128 pixels.

RADIANCE_SIZE_256 = 3

Enum: RadianceSize

Radiance texture size is 256×256 pixels.

RADIANCE_SIZE_512 = 4

Enum: RadianceSize

Radiance texture size is 512×512 pixels.

RADIANCE_SIZE_1024 = 5

Enum: RadianceSize

Radiance texture size is 1024×1024 pixels.

RADIANCE_SIZE_2048 = 6

Enum: RadianceSize

Radiance texture size is 2048×2048 pixels.

RADIANCE_SIZE_MAX = 7

Enum: RadianceSize

Represents the size of the RadianceSize enum.

PROCESS_MODE_AUTOMATIC = 0

Enum: ProcessMode

Automatically selects the appropriate process mode based on your sky shader. If your shader uses TIME or POSITION, this will use PROCESS_MODE_REALTIME. If your shader uses any of the LIGHT_* variables or any custom uniforms, this uses PROCESS_MODE_INCREMENTAL. Otherwise, this defaults to PROCESS_MODE_QUALITY.

PROCESS_MODE_QUALITY = 1

Enum: ProcessMode

Uses high quality importance sampling to process the radiance map. In general, this results in much higher quality than PROCESS_MODE_REALTIME but takes much longer to generate. This should not be used if you plan on changing the sky at runtime. If you are finding that the reflection is not blurry enough and is showing sparkles or fireflies, try increasing ProjectSettings.rendering/reflections/sky_reflections/ggx_samples.

PROCESS_MODE_REALTIME = 3

Enum: ProcessMode

Uses the fast filtering algorithm to process the radiance map. In general this results in lower quality, but substantially faster run times. If you need better quality, but still need to update the sky every frame, consider turning on ProjectSettings.rendering/reflections/sky_reflections/fast_filter_high_quality. Note: The fast filtering algorithm is limited to 256×256 cubemaps, so radiance_size must be set to RADIANCE_SIZE_256. Otherwise, a warning is printed and the overridden radiance size is ignored.

Source revision 4f5b14abade2
Connection interrupted. Reload×

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.