PanoramaSkyMaterial

package
v0.0.0-...-357ca8a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 20, 2025 License: MIT Imports: 26 Imported by: 0

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

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 Any

type Any interface {
	gd.IsClass
	AsPanoramaSkyMaterial() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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 (self *Extension[T]) AsMaterial() Material.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsPanoramaSkyMaterial

func (self *Extension[T]) AsPanoramaSkyMaterial() Instance

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

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 New

func New() Instance

func (Instance) AsMaterial

func (self Instance) AsMaterial() Material.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsPanoramaSkyMaterial

func (self Instance) AsPanoramaSkyMaterial() Instance

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) EnergyMultiplier

func (self Instance) EnergyMultiplier() Float.X

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

func (Instance) Filter

func (self Instance) Filter() bool

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

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Panorama

func (self Instance) Panorama() Texture2D.Instance

Texture2D to be applied to the PanoramaSkyMaterial.

func (Instance) SetEnergyMultiplier

func (self Instance) SetEnergyMultiplier(value Float.X)

SetEnergyMultiplier sets the property returned by [GetEnergyMultiplier].

func (Instance) SetFilter

func (self Instance) SetFilter(value bool)

SetFilter sets the property returned by [IsFilteringEnabled].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetPanorama

func (self Instance) SetPanorama(value Texture2D.Instance)

SetPanorama sets the property returned by [GetPanorama].

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL