Documentation
¶
Overview ¶
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.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsMaterial() Material.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsPanoramaSkyMaterial() Instance
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) EnergyMultiplier() Float.X
- func (self Instance) Filter() bool
- func (self Instance) ID() ID
- func (self Instance) Panorama() Texture2D.Instance
- func (self Instance) SetEnergyMultiplier(value Float.X)
- func (self Instance) SetFilter(value bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPanorama(value Texture2D.Instance)
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsMaterial ¶
func (*Extension[T]) AsPanoramaSkyMaterial ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.PanoramaSkyMaterial
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsMaterial ¶
func (Instance) AsPanoramaSkyMaterial ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) EnergyMultiplier ¶
The sky's overall brightness multiplier. Higher values result in a brighter sky.
func (Instance) Filter ¶
A boolean value to determine if the background texture should be filtered or not.
func (Instance) Panorama ¶
Texture2D to be applied to the PanoramaSkyMaterial.
func (Instance) SetEnergyMultiplier ¶
SetEnergyMultiplier sets the property returned by [GetEnergyMultiplier].
func (Instance) SetPanorama ¶
SetPanorama sets the property returned by [GetPanorama].