Struct gdnative::api::SpriteBase3D

pub struct SpriteBase3D { /* fields omitted */ }

core class SpriteBase3D inherits GeometryInstance (unsafe).

Official documentation

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

Class hierarchy

SpriteBase3D inherits methods from:

• GeometryInstance
• VisualInstance
• Spatial
• Node
• 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 SpriteBase3D

Constants

pub const ALPHA_CUT_DISABLED: i64

pub const ALPHA_CUT_DISCARD: i64

pub const ALPHA_CUT_OPAQUE_PREPASS: i64

pub const FLAG_DOUBLE_SIDED: i64

pub const FLAG_MAX: i64

pub const FLAG_SHADED: i64

pub const FLAG_TRANSPARENT: i64

impl SpriteBase3D

pub fn generate_triangle_mesh(&self) -> Option<Ref<TriangleMesh, Shared>>

pub fn alpha_cut_mode(&self) -> AlphaCutMode

pub fn axis(&self) -> Axis

The direction in which the front of the texture faces.

pub fn billboard_mode(&self) -> BillboardMode

pub fn draw_flag(&self, flag: i64) -> bool

If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the sprite invisible.

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

Returns the rectangle representing this sprite.

pub fn modulate(&self) -> Color

A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light.

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

The texture's drawing offset.

pub fn opacity(&self) -> f64

The objects visibility on a scale from [code]0[/code] fully invisible to [code]1[/code] fully visible.

pub fn pixel_size(&self) -> f64

The size of one pixel's width on the sprite to scale it in 3D.

pub fn is_centered(&self) -> bool

If [code]true[/code], texture will be centered.

pub fn is_flipped_h(&self) -> bool

If [code]true[/code], texture is flipped horizontally.

pub fn is_flipped_v(&self) -> bool

If [code]true[/code], texture is flipped vertically.

pub fn set_alpha_cut_mode(&self, mode: i64)

pub fn set_axis(&self, axis: i64)

The direction in which the front of the texture faces.

pub fn set_billboard_mode(&self, mode: i64)

pub fn set_centered(&self, centered: bool)

If [code]true[/code], texture will be centered.

pub fn set_draw_flag(&self, flag: i64, enabled: bool)

If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the sprite invisible.

pub fn set_flip_h(&self, flip_h: bool)

If [code]true[/code], texture is flipped horizontally.

pub fn set_flip_v(&self, flip_v: bool)

If [code]true[/code], texture is flipped vertically.

pub fn set_modulate(&self, modulate: Color)

A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light.

pub fn set_offset(&self, offset: Vector2D<f32, UnknownUnit>)

The texture's drawing offset.

pub fn set_opacity(&self, opacity: f64)

The objects visibility on a scale from [code]0[/code] fully invisible to [code]1[/code] fully visible.

pub fn set_pixel_size(&self, pixel_size: f64)

The size of one pixel's width on the sprite to scale it in 3D.

Methods from Deref<Target = GeometryInstance>

pub const FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: i64

pub const FLAG_MAX: i64

pub const FLAG_USE_BAKED_LIGHT: i64

pub const SHADOW_CASTING_SETTING_DOUBLE_SIDED: i64

pub const SHADOW_CASTING_SETTING_OFF: i64

pub const SHADOW_CASTING_SETTING_ON: i64

pub const SHADOW_CASTING_SETTING_SHADOWS_ONLY: i64

pub fn cast_shadows_setting(&self) -> ShadowCastingSetting

The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.

pub fn extra_cull_margin(&self) -> f64

The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.

pub fn flag(&self, flag: i64) -> bool

If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap].

pub fn lod_max_distance(&self) -> f64

The GeometryInstance's max LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_max_hysteresis(&self) -> f64

The GeometryInstance's max LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_min_distance(&self) -> f64

The GeometryInstance's min LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_min_hysteresis(&self) -> f64

The GeometryInstance's min LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn material_override(&self) -> Option<Ref<Material, Shared>>

The material override for the whole geometry.
			If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

pub fn set_cast_shadows_setting(&self, shadow_casting_setting: i64)

The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.

pub fn set_custom_aabb(&self, aabb: Aabb)

Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero.

pub fn set_extra_cull_margin(&self, margin: f64)

The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.

pub fn set_flag(&self, flag: i64, value: bool)

If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap].

pub fn set_lod_max_distance(&self, mode: f64)

The GeometryInstance's max LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_max_hysteresis(&self, mode: f64)

The GeometryInstance's max LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_min_distance(&self, mode: f64)

The GeometryInstance's min LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_min_hysteresis(&self, mode: f64)

The GeometryInstance's min LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn set_material_override(&self, material: impl AsArg<Material>)

The material override for the whole geometry.
			If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

Trait Implementations

impl Debug for SpriteBase3D

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

Formats the value using the given formatter.

impl Deref for SpriteBase3D

type Target = GeometryInstance

The resulting type after dereferencing.

fn deref(&self) -> &GeometryInstance

Dereferences the value.

impl DerefMut for SpriteBase3D

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

Mutably dereferences the value.

impl GodotObject for SpriteBase3D

type RefKind = ManuallyManaged

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 QueueFree for SpriteBase3D

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<GeometryInstance> for SpriteBase3D

impl SubClass<Node> for SpriteBase3D

impl SubClass<Object> for SpriteBase3D

impl SubClass<Spatial> for SpriteBase3D

impl SubClass<SpriteBase3D> for AnimatedSprite3D

impl SubClass<SpriteBase3D> for Sprite3D

impl SubClass<VisualInstance> for SpriteBase3D