Class PanoramaSkyMaterial

A material that provides a special texture to a Sky, usually an HDR panorama.

Inheritance

Material

Resource

RefCounted

Object

PanoramaSkyMaterial

Remarks

A resource referenced in a Sky that is used to draw a background. PanoramaSkyMaterial functions similar to skyboxes in other engines, except it uses an equirectangular sky map instead of a Cubemap.

Using an HDR panorama is strongly recommended for accurate, high-quality reflections. Godot supports the Radiance HDR (.hdr) and OpenEXR (.exr) image formats for this purpose.

You can use this tool to convert a cubemap to an equirectangular sky map.

Properties

energy_multiplier

The sky's overall brightness multiplier. Higher values result in a brighter sky.

var energy_multiplier : float = 1.0

Property Value

float

Remarks

• void set_energy_multiplier(float value)
• float get_energy_multiplier

filter

A boolean value to determine if the background texture should be filtered or not.

var filter : bool = true

Property Value

bool

Remarks

• void set_filtering_enabled(bool value)
• bool is_filtering_enabled

panorama

Texture2D to be applied to the PanoramaSkyMaterial.

var panorama : Texture2D

Property Value

Texture2D

Remarks

• void set_panorama(Texture2D value)
• Texture2D get_panorama