MeshInstance2D

Documentation

Overview

Node used for displaying a Mesh in 2D. A MeshInstance2D can be automatically created from an existing Sprite2D via a tool in the editor toolbar. Select the Sprite2D node, then choose Sprite2D > Convert to MeshInstance2D at the top of the 2D editor viewport.

Index

• type Advanced
• type Any
• type Extension
  • func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
  • func (self *Extension[T]) AsMeshInstance2D() Instance
  • func (self *Extension[T]) AsNode() Node.Instance
  • func (self *Extension[T]) AsNode2D() Node2D.Instance
  • func (self *Extension[T]) AsObject() [1]gd.Object
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) AsCanvasItem() CanvasItem.Instance
  • func (self Instance) AsMeshInstance2D() 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) Mesh() Mesh.Instance
  • func (self Instance) OnTextureChanged(cb func(), flags ...Signal.Flags)
  • func (self Instance) SetMesh(value Mesh.Instance)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) SetTexture(value Texture2D.Instance)
  • func (self Instance) Texture() Texture2D.Instance
  • 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
	AsMeshInstance2D() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]) AsMeshInstance2D

func (self *Extension[T]) AsMeshInstance2D() Instance

func (*Extension[T]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode2D

func (self *Extension[T]) AsNode2D() Node2D.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.MeshInstance2D

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 New

func New() Instance

func (Instance) AsCanvasItem

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsMeshInstance2D

func (self Instance) AsMeshInstance2D() 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) ID

func (self Instance) ID() ID

func (Instance) Mesh

func (self Instance) Mesh() Mesh.Instance

The Mesh that will be drawn by the MeshInstance2D.

func (Instance) OnTextureChanged

func (self Instance) OnTextureChanged(cb func(), flags ...Signal.Flags)

Emitted when the Texture is changed.

func (Instance) SetMesh

func (self Instance) SetMesh(value Mesh.Instance)

SetMesh sets the property returned by [GetMesh].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetTexture

func (self Instance) SetTexture(value Texture2D.Instance)

SetTexture sets the property returned by [GetTexture].

func (Instance) Texture

func (self Instance) Texture() Texture2D.Instance

The Texture2D that will be used if using the default CanvasItemMaterial. Can be accessed as TEXTURE in CanvasItem shader.

func (Instance) Virtual

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