Documentation
¶
Overview ¶
The WorldEnvironment node is used to configure the default Environment for the scene.
The parameters defined in the WorldEnvironment can be overridden by an Environment node set on the current Camera3D. Additionally, only one WorldEnvironment may be instantiated in a given scene at a time.
The WorldEnvironment allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). Usually, these are added in order to improve the realism/color balance of the scene.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsWorldEnvironment() Instance
- func (self Instance) CameraAttributes() CameraAttributes.Instance
- func (self Instance) Compositor() Compositor.Instance
- func (self Instance) Environment() Environment.Instance
- func (self Instance) ID() ID
- func (self Instance) SetCameraAttributes(value CameraAttributes.Instance)
- func (self Instance) SetCompositor(value Compositor.Instance)
- func (self Instance) SetEnvironment(value Environment.Instance)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- 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]) AsWorldEnvironment ¶
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.WorldEnvironment
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) AsWorldEnvironment ¶
func (Instance) CameraAttributes ¶
func (self Instance) CameraAttributes() CameraAttributes.Instance
The default CameraAttributes resource to use if none set on the Camera3D.
func (Instance) Compositor ¶
func (self Instance) Compositor() Compositor.Instance
The default Compositor resource to use if none set on the Camera3D.
func (Instance) Environment ¶
func (self Instance) Environment() Environment.Instance
The Environment resource used by this WorldEnvironment, defining the default properties.
func (Instance) SetCameraAttributes ¶
func (self Instance) SetCameraAttributes(value CameraAttributes.Instance)
SetCameraAttributes sets the property returned by [GetCameraAttributes].
func (Instance) SetCompositor ¶
func (self Instance) SetCompositor(value Compositor.Instance)
SetCompositor sets the property returned by [GetCompositor].
func (Instance) SetEnvironment ¶
func (self Instance) SetEnvironment(value Environment.Instance)
SetEnvironment sets the property returned by [GetEnvironment].
Source Files