Documentation
¶
Overview ¶
A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. See also graphics.gd/classdb/SpriteBase3D where properties such as the billboard mode are defined.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsGeometryInstance3D() GeometryInstance3D.Instance
- func (self *Extension[T]) AsNode() Node.Instance
- func (self *Extension[T]) AsNode3D() Node3D.Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- func (self *Extension[T]) AsSprite3D() Instance
- func (self *Extension[T]) AsSpriteBase3D() SpriteBase3D.Instance
- func (self *Extension[T]) AsVisualInstance3D() VisualInstance3D.Instance
- type ID
- type Instance
- func (self Instance) AsGeometryInstance3D() GeometryInstance3D.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsSprite3D() Instance
- func (self Instance) AsSpriteBase3D() SpriteBase3D.Instance
- func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance
- func (self Instance) Frame() int
- func (self Instance) FrameCoords() Vector2i.XY
- func (self Instance) Hframes() int
- func (self Instance) ID() ID
- func (self Instance) OnFrameChanged(cb func(), flags ...Signal.Flags)
- func (self Instance) OnTextureChanged(cb func(), flags ...Signal.Flags)
- func (self Instance) RegionEnabled() bool
- func (self Instance) RegionRect() Rect2.PositionSize
- func (self Instance) SetFrame(value int)
- func (self Instance) SetFrameCoords(value Vector2i.XY)
- func (self Instance) SetHframes(value int)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetRegionEnabled(value bool)
- func (self Instance) SetRegionRect(value Rect2.PositionSize)
- func (self Instance) SetTexture(value Texture2D.Instance)
- func (self Instance) SetVframes(value int)
- func (self Instance) Texture() Texture2D.Instance
- func (self Instance) Vframes() int
- 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]) AsGeometryInstance3D ¶
func (self *Extension[T]) AsGeometryInstance3D() GeometryInstance3D.Instance
func (*Extension[T]) AsSprite3D ¶
func (*Extension[T]) AsSpriteBase3D ¶
func (self *Extension[T]) AsSpriteBase3D() SpriteBase3D.Instance
func (*Extension[T]) AsVisualInstance3D ¶
func (self *Extension[T]) AsVisualInstance3D() VisualInstance3D.Instance
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 ¶
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) AsGeometryInstance3D ¶
func (self Instance) AsGeometryInstance3D() GeometryInstance3D.Instance
func (Instance) AsSprite3D ¶
func (Instance) AsSpriteBase3D ¶
func (self Instance) AsSpriteBase3D() SpriteBase3D.Instance
func (Instance) AsVisualInstance3D ¶
func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance
func (Instance) FrameCoords ¶
func (Instance) OnFrameChanged ¶
func (Instance) OnTextureChanged ¶
func (Instance) RegionEnabled ¶
func (Instance) RegionRect ¶
func (self Instance) RegionRect() Rect2.PositionSize
func (Instance) SetFrameCoords ¶
func (Instance) SetHframes ¶
func (Instance) SetRegionEnabled ¶
func (Instance) SetRegionRect ¶
func (self Instance) SetRegionRect(value Rect2.PositionSize)
Source Files