Struct gdnative_bindings::ParallaxBackground

pub struct ParallaxBackground { /* fields omitted */ }

core class ParallaxBackground inherits CanvasLayer (unsafe).

Official documentation

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

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

ParallaxBackground is an unsafe pointer, and all of its methods are unsafe.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using ParallaxBackground::free.

Class hierarchy

ParallaxBackground inherits methods from:

• CanvasLayer
• Node
• Object

Methods

impl ParallaxBackground

pub fn new() -> Self

Constructor.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed. Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using ParallaxBackground::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _camera_moved(&mut self, arg0: Transform2D, arg1: Vector2)

pub unsafe fn get_limit_begin(&self) -> Vector2

pub unsafe fn get_limit_end(&self) -> Vector2

pub unsafe fn get_scroll_base_offset(&self) -> Vector2

pub unsafe fn get_scroll_base_scale(&self) -> Vector2

pub unsafe fn get_scroll_offset(&self) -> Vector2

pub unsafe fn is_ignore_camera_zoom(&mut self) -> bool

pub unsafe fn set_ignore_camera_zoom(&mut self, ignore: bool)

pub unsafe fn set_limit_begin(&mut self, ofs: Vector2)

pub unsafe fn set_limit_end(&mut self, ofs: Vector2)

pub unsafe fn set_scroll_base_offset(&mut self, ofs: Vector2)

pub unsafe fn set_scroll_base_scale(&mut self, scale: Vector2)

pub unsafe fn set_scroll_offset(&mut self, ofs: Vector2)

pub unsafe fn to_canvas_layer(&self) -> CanvasLayer

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Methods from Deref<Target = CanvasLayer>

pub unsafe fn get_canvas(&self) -> Rid

pub unsafe fn get_custom_viewport(&self) -> Option<Node>

pub unsafe fn get_layer(&self) -> i64

pub unsafe fn get_offset(&self) -> Vector2

pub unsafe fn get_rotation(&self) -> f64

pub unsafe fn get_rotation_degrees(&self) -> f64

pub unsafe fn get_scale(&self) -> Vector2

pub unsafe fn get_transform(&self) -> Transform2D

pub unsafe fn set_custom_viewport(&mut self, viewport: Option<Node>)

pub unsafe fn set_layer(&mut self, layer: i64)

pub unsafe fn set_offset(&mut self, offset: Vector2)

pub unsafe fn set_rotation(&mut self, radians: f64)

pub unsafe fn set_rotation_degrees(&mut self, degrees: f64)

pub unsafe fn set_scale(&mut self, scale: Vector2)

pub unsafe fn set_transform(&mut self, transform: Transform2D)

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for ParallaxBackground

fn clone(&self) -> ParallaxBackground

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ParallaxBackground

impl Debug for ParallaxBackground

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Deref for ParallaxBackground

type Target = CanvasLayer

The resulting type after dereferencing.

fn deref(&self) -> &CanvasLayer

Dereferences the value.

impl DerefMut for ParallaxBackground

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

Mutably dereferences the value.

impl Free for ParallaxBackground

unsafe fn godot_free(self)

impl FromVariant for ParallaxBackground

fn from_variant(variant: &Variant) -> Option<Self>

impl GodotObject for ParallaxBackground

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Instanciable for ParallaxBackground

fn construct() -> Self

impl QueueFree for ParallaxBackground

unsafe fn godot_queue_free(&mut self)

impl ToVariant for ParallaxBackground

fn to_variant(&self) -> Variant