Struct gdnative::api::AtlasTexture

pub struct AtlasTexture { /* fields omitted */ }

core class AtlasTexture inherits Texture (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

AtlasTexture inherits methods from:

• Texture
• 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 AtlasTexture

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

Creates a new instance of this object.

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

pub fn atlas(&self) -> Option<Ref<Texture, Shared>>

The texture that contains the atlas. Can be any [Texture] subtype.

pub fn margin(&self) -> Rect<f32, UnknownUnit>

The margin around the region. The [Rect2]'s [member Rect2.size] parameter ("w" and "h" in the editor) resizes the texture so it fits within the margin.

pub fn region(&self) -> Rect<f32, UnknownUnit>

The AtlasTexture's used region.

pub fn has_filter_clip(&self) -> bool

If [code]true[/code], clips the area outside of the region to avoid bleeding of the surrounding texture pixels.

pub fn set_atlas(&self, atlas: impl AsArg<Texture>)

The texture that contains the atlas. Can be any [Texture] subtype.

pub fn set_filter_clip(&self, enable: bool)

If [code]true[/code], clips the area outside of the region to avoid bleeding of the surrounding texture pixels.

pub fn set_margin(&self, margin: Rect<f32, UnknownUnit>)

The margin around the region. The [Rect2]'s [member Rect2.size] parameter ("w" and "h" in the editor) resizes the texture so it fits within the margin.

pub fn set_region(&self, region: Rect<f32, UnknownUnit>)

The AtlasTexture's used region.

Methods from Deref<Target = Texture>

pub const FLAGS_DEFAULT: i64

pub const FLAG_ANISOTROPIC_FILTER: i64

pub const FLAG_CONVERT_TO_LINEAR: i64

pub const FLAG_FILTER: i64

pub const FLAG_MIPMAPS: i64

pub const FLAG_MIRRORED_REPEAT: i64

pub const FLAG_REPEAT: i64

pub const FLAG_VIDEO_SURFACE: i64

pub fn draw(
    &self,
    canvas_item: Rid,
    position: Vector2D<f32, UnknownUnit>,
    modulate: Color,
    transpose: bool,
    normal_map: impl AsArg<Texture>
)

Draws the texture using a [CanvasItem] with the [VisualServer] API at the specified [code]position[/code]. Equivalent to [method VisualServer.canvas_item_add_texture_rect] with a rect at [code]position[/code] and the size of this [Texture].

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• transpose - false
• normal_map - null

pub fn draw_rect(
    &self,
    canvas_item: Rid,
    rect: Rect<f32, UnknownUnit>,
    tile: bool,
    modulate: Color,
    transpose: bool,
    normal_map: impl AsArg<Texture>
)

Draws the texture using a [CanvasItem] with the [VisualServer] API. Equivalent to [method VisualServer.canvas_item_add_texture_rect].

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• transpose - false
• normal_map - null

pub fn draw_rect_region(
    &self,
    canvas_item: Rid,
    rect: Rect<f32, UnknownUnit>,
    src_rect: Rect<f32, UnknownUnit>,
    modulate: Color,
    transpose: bool,
    normal_map: impl AsArg<Texture>,
    clip_uv: bool
)

Draws a part of the texture using a [CanvasItem] with the [VisualServer] API. Equivalent to [method VisualServer.canvas_item_add_texture_rect_region].

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• transpose - false
• normal_map - null
• clip_uv - true

pub fn get_data(&self) -> Option<Ref<Image, Shared>>

Returns an [Image] that is a copy of data from this [Texture]. [Image]s can be accessed and manipulated directly.

pub fn flags(&self) -> i64

The texture's [enum Flags]. [enum Flags] are used to set various properties of the [Texture].

pub fn get_height(&self) -> i64

Returns the texture height.

pub fn get_size(&self) -> Vector2D<f32, UnknownUnit>

Returns the texture size.

pub fn get_width(&self) -> i64

Returns the texture width.

pub fn has_alpha(&self) -> bool

Returns [code]true[/code] if this [Texture] has an alpha channel.

pub fn set_flags(&self, flags: i64)

The texture's [enum Flags]. [enum Flags] are used to set various properties of the [Texture].

Trait Implementations

impl Debug for AtlasTexture

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

Formats the value using the given formatter.

impl Deref for AtlasTexture

type Target = Texture

The resulting type after dereferencing.

fn deref(&self) -> &Texture

Dereferences the value.

impl DerefMut for AtlasTexture

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

Mutably dereferences the value.

impl GodotObject for AtlasTexture

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 AtlasTexture

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

impl SubClass<Object> for AtlasTexture

impl SubClass<Reference> for AtlasTexture

impl SubClass<Resource> for AtlasTexture

impl SubClass<Texture> for AtlasTexture