Documentation
¶
Overview ¶
A control that displays a texture, for example an icon inside a GUI. The texture's placement can be controlled with the Instance.StretchMode property. It can scale, tile, or stay centered inside its bounding rectangle.
Index ¶
- type Advanced
- type Any
- type ExpandMode
- type Extension
- type ID
- type Instance
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsControl() Control.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsTextureRect() Instance
- func (self Instance) ExpandMode() ExpandMode
- func (self Instance) FlipH() bool
- func (self Instance) FlipV() bool
- func (self Instance) ID() ID
- func (self Instance) SetExpandMode(value ExpandMode)
- func (self Instance) SetFlipH(value bool)
- func (self Instance) SetFlipV(value bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetStretchMode(value StretchMode)
- func (self Instance) SetTexture(value Texture2D.Instance)
- func (self Instance) StretchMode() StretchMode
- func (self Instance) Texture() Texture2D.Instance
- func (self Instance) Virtual(name string) reflect.Value
- type StretchMode
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 ExpandMode ¶
type ExpandMode int //gd:TextureRect.ExpandMode
const ( // The minimum size will be equal to texture size, i.e. [graphics.gd/classdb/TextureRect] can't be smaller than the texture. ExpandKeepSize ExpandMode = 0 // The size of the texture won't be considered for minimum size calculation, so the [graphics.gd/classdb/TextureRect] can be shrunk down past the texture size. ExpandIgnoreSize ExpandMode = 1 // The height of the texture will be ignored. Minimum width will be equal to the current height. Useful for horizontal layouts, e.g. inside [graphics.gd/classdb/HBoxContainer]. ExpandFitWidth ExpandMode = 2 // Same as [ExpandFitWidth], but keeps texture's aspect ratio. ExpandFitWidthProportional ExpandMode = 3 // The width of the texture will be ignored. Minimum height will be equal to the current width. Useful for vertical layouts, e.g. inside [graphics.gd/classdb/VBoxContainer]. ExpandFitHeight ExpandMode = 4 // Same as [ExpandFitHeight], but keeps texture's aspect ratio. ExpandFitHeightProportional ExpandMode = 5 )
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]) AsTextureRect ¶
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.TextureRect
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) AsTextureRect ¶
func (Instance) ExpandMode ¶
func (self Instance) ExpandMode() ExpandMode
func (Instance) SetExpandMode ¶
func (self Instance) SetExpandMode(value ExpandMode)
func (Instance) SetStretchMode ¶
func (self Instance) SetStretchMode(value StretchMode)
func (Instance) SetTexture ¶
func (Instance) StretchMode ¶
func (self Instance) StretchMode() StretchMode
type StretchMode ¶
type StretchMode int //gd:TextureRect.StretchMode
const ( // Scale to fit the node's bounding rectangle. StretchScale StretchMode = 0 // Tile inside the node's bounding rectangle. StretchTile StretchMode = 1 // The texture keeps its original size and stays in the bounding rectangle's top-left corner. StretchKeep StretchMode = 2 // The texture keeps its original size and stays centered in the node's bounding rectangle. StretchKeepCentered StretchMode = 3 // Scale the texture to fit the node's bounding rectangle, but maintain the texture's aspect ratio. StretchKeepAspect StretchMode = 4 // Scale the texture to fit the node's bounding rectangle, center it and maintain its aspect ratio. StretchKeepAspectCentered StretchMode = 5 // Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits. StretchKeepAspectCovered StretchMode = 6 )