Struct gdnative::api::TextureArray

pub struct TextureArray { /* fields omitted */ }

core class TextureArray inherits TextureLayered (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

TextureArray inherits methods from:

• TextureLayered
• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl TextureArray

pub fn new() -> Ref<TextureArray, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

Methods from Deref<Target = TextureLayered>

pub const FLAGS_DEFAULT: i64

pub const FLAG_FILTER: i64

pub const FLAG_MIPMAPS: i64

pub const FLAG_REPEAT: i64

pub fn create(
    &self,
    width: i64,
    height: i64,
    depth: i64,
    format: i64,
    flags: i64
)

Creates the [Texture3D] or [TextureArray] with specified [code]width[/code], [code]height[/code], and [code]depth[/code]. See [enum Image.Format] for [code]format[/code] options. See [enum Flags] enumerator for [code]flags[/code] options.

Default Arguments

• flags - 4

pub fn get_depth(&self) -> i64

Returns the depth of the texture. Depth is the 3rd dimension (typically Z-axis).

pub fn flags(&self) -> i64

Specifies which [enum Flags] apply to this texture.

pub fn get_format(&self) -> Format

Returns the current format being used by this texture. See [enum Image.Format] for details.

pub fn get_height(&self) -> i64

Returns the height of the texture. Height is typically represented by the Y-axis.

pub fn get_layer_data(&self, layer: i64) -> Option<Ref<Image, Shared>>

Returns an [Image] resource with the data from specified [code]layer[/code].

pub fn get_width(&self) -> i64

Returns the width of the texture. Width is typically represented by the X-axis.

pub fn set_data_partial(
    &self,
    image: impl AsArg<Image>,
    x_offset: i64,
    y_offset: i64,
    layer: i64,
    mipmap: i64
)

Partially sets the data for a specified [code]layer[/code] by overwriting using the data of the specified [code]image[/code]. [code]x_offset[/code] and [code]y_offset[/code] determine where the [Image] is "stamped" over the texture. The [code]image[/code] must fit within the texture.

Default Arguments

• mipmap - 0

pub fn set_flags(&self, flags: i64)

Specifies which [enum Flags] apply to this texture.

pub fn set_layer_data(&self, image: impl AsArg<Image>, layer: i64)

Sets the data for the specified layer. Data takes the form of a 2-dimensional [Image] resource.

Trait Implementations

impl Debug for TextureArray

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for TextureArray

type Target = TextureLayered

The resulting type after dereferencing.

fn deref(&self) -> &TextureLayered

Dereferences the value.

impl DerefMut for TextureArray

fn deref_mut(&mut self) -> &mut TextureLayered

Mutably dereferences the value.

impl GodotObject for TextureArray

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for TextureArray

fn construct() -> Ref<TextureArray, Unique>

impl SubClass<Object> for TextureArray

impl SubClass<Reference> for TextureArray

impl SubClass<Resource> for TextureArray

impl SubClass<TextureLayered> for TextureArray