ProceduralSkyMaterial

package
v0.0.0-...-5eaf078 Latest Latest
Warning

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

Go to latest
Published: Sep 4, 2025 License: MIT Imports: 27 Imported by: 0

Documentation

Overview

Package ProceduralSkyMaterial provides methods for working with ProceduralSkyMaterial object instances.

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
	AsProceduralSkyMaterial() 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]) AsProceduralSkyMaterial

func (self *Extension[T]) AsProceduralSkyMaterial() 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.ProceduralSkyMaterial

[ProceduralSkyMaterial] provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are defined by a main color, a color at the horizon, and an easing curve to interpolate between them. Suns are described by a position in the sky, a color, and a max angle from the sun at which the easing curve ends. The max angle therefore defines the size of the sun in the sky. [ProceduralSkyMaterial] supports up to 4 suns, using the color, and energy, direction, and angular distance of the first four [DirectionalLight3D] nodes in the scene. This means that the suns are defined individually by the properties of their corresponding [DirectionalLight3D]s and globally by [member sun_angle_max] and [member sun_curve]. [ProceduralSkyMaterial] uses a lightweight shader to draw the sky and is therefore suited for real-time updates. This makes it a great option for a sky that is simple and computationally cheap, but unrealistic. If you need a more realistic procedural option, use [PhysicalSkyMaterial].

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) AsProceduralSkyMaterial

func (self Instance) AsProceduralSkyMaterial() 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

func (Instance) GroundBottomColor

func (self Instance) GroundBottomColor() Color.RGBA

func (Instance) GroundCurve

func (self Instance) GroundCurve() Float.X

func (Instance) GroundEnergyMultiplier

func (self Instance) GroundEnergyMultiplier() Float.X

func (Instance) GroundHorizonColor

func (self Instance) GroundHorizonColor() Color.RGBA

func (Instance) ID

func (self Instance) ID() ID

func (Instance) SetEnergyMultiplier

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

func (Instance) SetGroundBottomColor

func (self Instance) SetGroundBottomColor(value Color.RGBA)

func (Instance) SetGroundCurve

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

func (Instance) SetGroundEnergyMultiplier

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

func (Instance) SetGroundHorizonColor

func (self Instance) SetGroundHorizonColor(value Color.RGBA)

func (*Instance) SetObject

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

func (Instance) SetSkyCover

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

func (Instance) SetSkyCoverModulate

func (self Instance) SetSkyCoverModulate(value Color.RGBA)

func (Instance) SetSkyCurve

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

func (Instance) SetSkyEnergyMultiplier

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

func (Instance) SetSkyHorizonColor

func (self Instance) SetSkyHorizonColor(value Color.RGBA)

func (Instance) SetSkyTopColor

func (self Instance) SetSkyTopColor(value Color.RGBA)

func (Instance) SetSunAngleMax

func (self Instance) SetSunAngleMax(value Angle.Radians)

func (Instance) SetSunCurve

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

func (Instance) SetUseDebanding

func (self Instance) SetUseDebanding(value bool)

func (Instance) SkyCover

func (self Instance) SkyCover() Texture2D.Instance

func (Instance) SkyCoverModulate

func (self Instance) SkyCoverModulate() Color.RGBA

func (Instance) SkyCurve

func (self Instance) SkyCurve() Float.X

func (Instance) SkyEnergyMultiplier

func (self Instance) SkyEnergyMultiplier() Float.X

func (Instance) SkyHorizonColor

func (self Instance) SkyHorizonColor() Color.RGBA

func (Instance) SkyTopColor

func (self Instance) SkyTopColor() Color.RGBA

func (Instance) SunAngleMax

func (self Instance) SunAngleMax() Angle.Radians

func (Instance) SunCurve

func (self Instance) SunCurve() Float.X

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) UseDebanding

func (self Instance) UseDebanding() bool

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