Up to date

This page is up to date for Godot 4.1. If you still find outdated information, please open an issue.

PanoramaSkyMaterial¶

Inherits: Material < Resource < RefCounted < Object

A Material used with Sky to draw a background texture.

Description¶

A resource referenced in a Sky that is used to draw a background. The Panorama sky material 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¶

bool	filter	`true`
Texture2D	panorama

Property Descriptions¶

bool filter = true

void set_filtering_enabled ( bool value )
bool is_filtering_enabled ( )

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

Texture2D panorama

void set_panorama ( Texture2D value )
Texture2D get_panorama ( )

Texture2D to be applied to the PanoramaSkyMaterial.