Documentation
¶
Overview ¶
Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an OccluderPolygon2D in order for the shadow to be computed.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsLightOccluder2D() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode2D() Node2D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) ID() ID
- func (self Instance) Occluder() OccluderPolygon2D.Instance
- func (self Instance) OccluderLightMask() int
- func (self Instance) SdfCollision() bool
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetOccluder(value OccluderPolygon2D.Instance)
- func (self Instance) SetOccluderLightMask(value int)
- func (self Instance) SetSdfCollision(value 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]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
func (*Extension[T]) AsLightOccluder2D ¶
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.LightOccluder2D
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) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) AsLightOccluder2D ¶
func (Instance) Occluder ¶
func (self Instance) Occluder() OccluderPolygon2D.Instance
The OccluderPolygon2D used to compute the shadow.
func (Instance) OccluderLightMask ¶
The LightOccluder2D's occluder light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s).
func (Instance) SdfCollision ¶
If enabled, the occluder will be part of a real-time generated signed distance field that can be used in custom shaders.
func (Instance) SetOccluder ¶
func (self Instance) SetOccluder(value OccluderPolygon2D.Instance)
SetOccluder sets the property returned by [GetOccluderPolygon].
func (Instance) SetOccluderLightMask ¶
SetOccluderLightMask sets the property returned by [GetOccluderLightMask].
func (Instance) SetSdfCollision ¶
SetSdfCollision sets the property returned by [IsSetAsSdfCollision].
Source Files