Table of Contents

Class Sky

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

Inheritance
Sky

Remarks

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

process_mode

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 ProcessMode for options.

var process_mode : int = 0

Property Value

int

Remarks

  • void set_process_mode(int value)
  • int get_process_mode

radiance_size

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

See RadianceSize constants for values.

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

var radiance_size : int = 3

Property Value

int

Remarks

  • void set_radiance_size(int value)
  • int get_radiance_size

sky_material

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

var sky_material : Material

Property Value

Material

Remarks