AtlasTexture

package
v0.0.0-...-c858641 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 14, 2025 License: MIT Imports: 26 Imported by: 0

Documentation

Overview

graphics.gd/classdb/Texture2D resource that draws only part of its Instance.Atlas texture, as defined by the Instance.Region. An additional Instance.Margin can also be set, which is useful for small adjustments.

Multiple graphics.gd/classdb/AtlasTexture resources can be cropped from the same Instance.Atlas. Packing many smaller textures into a singular large texture helps to optimize video memory costs and render calls.

Note: graphics.gd/classdb/AtlasTexture cannot be used in an graphics.gd/classdb/AnimatedTexture, and will not tile properly in nodes such as graphics.gd/classdb/TextureRect or graphics.gd/classdb/Sprite2D. To tile an graphics.gd/classdb/AtlasTexture, modify its Instance.Region instead.

Index

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 Any

type Any interface {
	gd.IsClass
	AsAtlasTexture() 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]) AsAtlasTexture

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

func (*Extension[T]) AsObject

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

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

func (*Extension[T]) AsTexture

func (self *Extension[T]) AsTexture() Texture.Instance

func (*Extension[T]) AsTexture2D

func (self *Extension[T]) AsTexture2D() Texture2D.Instance

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.AtlasTexture

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) AsAtlasTexture

func (self Instance) AsAtlasTexture() Instance

func (Instance) AsObject

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

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) AsTexture

func (self Instance) AsTexture() Texture.Instance

func (Instance) AsTexture2D

func (self Instance) AsTexture2D() Texture2D.Instance

func (Instance) Atlas

func (self Instance) Atlas() Texture2D.Instance

func (Instance) FilterClip

func (self Instance) FilterClip() bool

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Margin

func (self Instance) Margin() Rect2.PositionSize

func (Instance) Region

func (self Instance) Region() Rect2.PositionSize

func (Instance) SetAtlas

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

func (Instance) SetFilterClip

func (self Instance) SetFilterClip(value bool)

func (Instance) SetMargin

func (self Instance) SetMargin(value Rect2.PositionSize)

func (*Instance) SetObject

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

func (Instance) SetRegion

func (self Instance) SetRegion(value Rect2.PositionSize)

func (Instance) Virtual

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL