Documentation
¶
Overview ¶
Package TextureLayered provides methods for working with TextureLayered object instances.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Implementation
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsTexture() Texture.Instance
- func (self Instance) AsTextureLayered() Instance
- func (self Instance) GetFormat() Image.Format
- func (self Instance) GetHeight() int
- func (self Instance) GetLayerData(layer int) Image.Instance
- func (self Instance) GetLayeredType() LayeredType
- func (self Instance) GetLayers() int
- func (self Instance) GetWidth() int
- func (self Instance) HasMipmaps() bool
- func (self Instance) ID() ID
- func (self *Instance) UnsafePointer() unsafe.Pointer
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
- type LayeredType
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]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
func (*Extension[T]) AsTextureLayered ¶
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 Implementation ¶
type Implementation = implementation
Implementation implements Interface with empty methods.
type Instance ¶
type Instance [1]gdclass.TextureLayered
Base class for [ImageTextureLayered] and [CompressedTextureLayered]. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also [Texture3D]. Data is set on a per-layer basis. For [Texture2DArray]s, the layer specifies the array layer. All images need to have the same width, height and number of mipmap levels. A [TextureLayered] can be loaded with [method ResourceLoader.load]. Internally, Godot maps these files to their respective counterparts in the target rendering driver (Vulkan, OpenGL3).
See [Interface] for methods that can be overridden by a [Class] that extends it.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsTextureLayered ¶
func (Instance) GetFormat ¶
Returns the current format being used by this texture. See [enum Image.Format] for details.
func (Instance) GetHeight ¶
Returns the height of the texture in pixels. Height is typically represented by the Y axis.
func (Instance) GetLayerData ¶
Returns an [Image] resource with the data from specified [param layer].
func (Instance) GetLayeredType ¶
func (self Instance) GetLayeredType() LayeredType
Returns the [TextureLayered]'s type. The type determines how the data is accessed, with cubemaps having special types.
func (Instance) GetWidth ¶
Returns the width of the texture in pixels. Width is typically represented by the X axis.
func (Instance) HasMipmaps ¶
Returns [code]true[/code] if the layers have generated mipmaps.
func (*Instance) UnsafePointer ¶
type Interface ¶
type Interface interface {
//Called when the [TextureLayered]'s format is queried.
GetFormat() Image.Format
//Called when the layers' type in the [TextureLayered] is queried.
GetLayeredType() int
//Called when the [TextureLayered]'s width queried.
GetWidth() int
//Called when the [TextureLayered]'s height is queried.
GetHeight() int
//Called when the number of layers in the [TextureLayered] is queried.
GetLayers() int
//Called when the presence of mipmaps in the [TextureLayered] is queried.
HasMipmaps() bool
//Called when the data for a layer in the [TextureLayered] is queried.
GetLayerData(layer_index int) Image.Instance
}
type LayeredType ¶
type LayeredType int //gd:TextureLayered.LayeredType
const ( /*Texture is a generic [Texture2DArray].*/ LayeredType2dArray LayeredType = 0 /*Texture is a [Cubemap], with each side in its own layer (6 in total).*/ LayeredTypeCubemap LayeredType = 1 /*Texture is a [CubemapArray], with each cubemap being made of 6 layers.*/ LayeredTypeCubemapArray LayeredType = 2 )
Source Files