Light2D

Documentation

Overview

Package Light2D provides methods for working with Light2D object instances.

Index

• type Advanced
• type Any
• type BlendMode
• type Instance
  • func New() Instance
  • func (self Instance) AsCanvasItem() CanvasItem.Instance
  • func (self Instance) AsLight2D() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode2D() Node2D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) BlendMode() gdclass.Light2DBlendMode
  • func (self Instance) Color() Color.RGBA
  • func (self Instance) EditorOnly() bool
  • func (self Instance) Enabled() bool
  • func (self Instance) Energy() Float.X
  • func (self Instance) GetHeight() Float.X
  • func (self Instance) RangeItemCullMask() int
  • func (self Instance) RangeLayerMax() int
  • func (self Instance) RangeLayerMin() int
  • func (self Instance) RangeZMax() int
  • func (self Instance) RangeZMin() int
  • func (self Instance) SetBlendMode(value gdclass.Light2DBlendMode)
  • func (self Instance) SetColor(value Color.RGBA)
  • func (self Instance) SetEditorOnly(value bool)
  • func (self Instance) SetEnabled(value bool)
  • func (self Instance) SetEnergy(value Float.X)
  • func (self Instance) SetHeight(height Float.X)
  • func (self Instance) SetRangeItemCullMask(value int)
  • func (self Instance) SetRangeLayerMax(value int)
  • func (self Instance) SetRangeLayerMin(value int)
  • func (self Instance) SetRangeZMax(value int)
  • func (self Instance) SetRangeZMin(value int)
  • func (self Instance) SetShadowColor(value Color.RGBA)
  • func (self Instance) SetShadowEnabled(value bool)
  • func (self Instance) SetShadowFilter(value gdclass.Light2DShadowFilter)
  • func (self Instance) SetShadowFilterSmooth(value Float.X)
  • func (self Instance) SetShadowItemCullMask(value int)
  • func (self Instance) ShadowColor() Color.RGBA
  • func (self Instance) ShadowEnabled() bool
  • func (self Instance) ShadowFilter() gdclass.Light2DShadowFilter
  • func (self Instance) ShadowFilterSmooth() Float.X
  • func (self Instance) ShadowItemCullMask() int
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type ShadowFilter

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

type BlendMode

type BlendMode = gdclass.Light2DBlendMode //gd:Light2D.BlendMode

const (
	/*Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behavior of a light.*/
	BlendModeAdd BlendMode = 0
	/*Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.*/
	BlendModeSub BlendMode = 1
	/*Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.*/
	BlendModeMix BlendMode = 2
)

type Instance

type Instance [1]gdclass.Light2D

Casts light in a 2D environment. A light is defined as a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related).

var Nil Instance

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

func New

func New() Instance

func (Instance) AsCanvasItem

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsLight2D

func (self Instance) AsLight2D() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode2D

func (self Instance) AsNode2D() Node2D.Instance

func (Instance) AsObject

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

func (Instance) BlendMode

func (self Instance) BlendMode() gdclass.Light2DBlendMode

func (Instance) Color

func (self Instance) Color() Color.RGBA

func (Instance) EditorOnly

func (self Instance) EditorOnly() bool

func (Instance) Enabled

func (self Instance) Enabled() bool

func (Instance) Energy

func (self Instance) Energy() Float.X

func (Instance) GetHeight

func (self Instance) GetHeight() Float.X

Returns the light's height, which is used in 2D normal mapping. See [member PointLight2D.height] and [member DirectionalLight2D.height].

func (Instance) RangeItemCullMask

func (self Instance) RangeItemCullMask() int

func (Instance) RangeLayerMax

func (self Instance) RangeLayerMax() int

func (Instance) RangeLayerMin

func (self Instance) RangeLayerMin() int

func (Instance) RangeZMax

func (self Instance) RangeZMax() int

func (Instance) RangeZMin

func (self Instance) RangeZMin() int

func (Instance) SetBlendMode

func (self Instance) SetBlendMode(value gdclass.Light2DBlendMode)

func (Instance) SetColor

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

func (Instance) SetEditorOnly

func (self Instance) SetEditorOnly(value bool)

func (Instance) SetEnabled

func (self Instance) SetEnabled(value bool)

func (Instance) SetEnergy

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

func (Instance) SetHeight

func (self Instance) SetHeight(height Float.X)

Sets the light's height, which is used in 2D normal mapping. See [member PointLight2D.height] and [member DirectionalLight2D.height].

func (Instance) SetRangeItemCullMask

func (self Instance) SetRangeItemCullMask(value int)

func (Instance) SetRangeLayerMax

func (self Instance) SetRangeLayerMax(value int)

func (Instance) SetRangeLayerMin

func (self Instance) SetRangeLayerMin(value int)

func (Instance) SetRangeZMax

func (self Instance) SetRangeZMax(value int)

func (Instance) SetRangeZMin

func (self Instance) SetRangeZMin(value int)

func (Instance) SetShadowColor

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

func (Instance) SetShadowEnabled

func (self Instance) SetShadowEnabled(value bool)

func (Instance) SetShadowFilter

func (self Instance) SetShadowFilter(value gdclass.Light2DShadowFilter)

func (Instance) SetShadowFilterSmooth

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

func (Instance) SetShadowItemCullMask

func (self Instance) SetShadowItemCullMask(value int)

func (Instance) ShadowColor

func (self Instance) ShadowColor() Color.RGBA

func (Instance) ShadowEnabled

func (self Instance) ShadowEnabled() bool

func (Instance) ShadowFilter

func (self Instance) ShadowFilter() gdclass.Light2DShadowFilter

func (Instance) ShadowFilterSmooth

func (self Instance) ShadowFilterSmooth() Float.X

func (Instance) ShadowItemCullMask

func (self Instance) ShadowItemCullMask() int

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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

type ShadowFilter

type ShadowFilter = gdclass.Light2DShadowFilter //gd:Light2D.ShadowFilter

const (
	/*No filter applies to the shadow map. This provides hard shadow edges and is the fastest to render. See [member shadow_filter].*/
	ShadowFilterNone ShadowFilter = 0
	/*Percentage closer filtering (5 samples) applies to the shadow map. This is slower compared to hard shadow rendering. See [member shadow_filter].*/
	ShadowFilterPcf5 ShadowFilter = 1
	/*Percentage closer filtering (13 samples) applies to the shadow map. This is the slowest shadow filtering mode, and should be used sparingly. See [member shadow_filter].*/
	ShadowFilterPcf13 ShadowFilter = 2
)