FogVolume

Documentation

Overview

Package FogVolume provides methods for working with FogVolume object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsFogVolume() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance
  • func (self Instance) Material() [1]gdclass.Material
  • func (self Instance) SetMaterial(value [1]gdclass.Material)
  • func (self Instance) SetShape(value gdclass.RenderingServerFogVolumeShape)
  • func (self Instance) SetSize(value Vector3.XYZ)
  • func (self Instance) Shape() gdclass.RenderingServerFogVolumeShape
  • func (self Instance) Size() Vector3.XYZ
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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
	AsFogVolume() Instance
}

type Instance

type Instance [1]gdclass.FogVolume

[FogVolume]s are used to add localized fog into the global volumetric fog effect. [FogVolume]s can also remove volumetric fog from specific areas if using a [FogMaterial] with a negative [member FogMaterial.density]. Performance of [FogVolume]s is directly related to their relative size on the screen and the complexity of their attached [FogMaterial]. It is best to keep [FogVolume]s relatively small and simple where possible. [b]Note:[/b] [FogVolume]s only have a visible effect if [member Environment.volumetric_fog_enabled] is [code]true[/code]. If you don't want fog to be globally visible (but only within [FogVolume] nodes), set [member Environment.volumetric_fog_density] to [code]0.0[/code].

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsFogVolume

func (self Instance) AsFogVolume() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject

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

func (Instance) AsVisualInstance3D

func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance

func (Instance) Material

func (self Instance) Material() [1]gdclass.Material

func (Instance) SetMaterial

func (self Instance) SetMaterial(value [1]gdclass.Material)

func (Instance) SetShape

func (self Instance) SetShape(value gdclass.RenderingServerFogVolumeShape)

func (Instance) SetSize

func (self Instance) SetSize(value Vector3.XYZ)

func (Instance) Shape

func (self Instance) Shape() gdclass.RenderingServerFogVolumeShape

func (Instance) Size

func (self Instance) Size() Vector3.XYZ

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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