Struct gdnative_bindings_lily::ParallaxBackground [−][src]
pub struct ParallaxBackground { /* fields omitted */ }
Expand description
core class ParallaxBackground
inherits CanvasLayer
(unsafe).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
Non reference counted objects such as the ones of this type are usually owned by the engine.
ParallaxBackground
is a reference-only type. Persistent references can
only exist in the unsafe Ref<ParallaxBackground>
form.
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 Ref::free
, or Ref::queue_free
if it is a Node
.
Class hierarchy
ParallaxBackground inherits methods from:
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
Creates a new instance of this object.
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 Ref::free
, or preferably
Ref::queue_free
if it is a Node
.
Top-left limits for scrolling to begin. If the camera is outside of this limit, the background will stop scrolling. Must be lower than [member scroll_limit_end] to work.
Bottom-right limits for scrolling to end. If the camera is outside of this limit, the background will stop scrolling. Must be higher than [member scroll_limit_begin] to work.
The base position offset for all ParallaxLayer children.
The base motion scale for all ParallaxLayer children.
The ParallaxBackground’s scroll value. Calculated automatically when using a Camera2D, but can be used to manually manage scrolling when no camera is present.
If true
, elements in ParallaxLayer child aren’t affected by the zoom level of the camera.
If true
, elements in ParallaxLayer child aren’t affected by the zoom level of the camera.
Top-left limits for scrolling to begin. If the camera is outside of this limit, the background will stop scrolling. Must be lower than [member scroll_limit_end] to work.
Bottom-right limits for scrolling to end. If the camera is outside of this limit, the background will stop scrolling. Must be higher than [member scroll_limit_begin] to work.
The base position offset for all ParallaxLayer children.
The base motion scale for all ParallaxLayer children.
The ParallaxBackground’s scroll value. Calculated automatically when using a Camera2D, but can be used to manually manage scrolling when no camera is present.
Methods from Deref<Target = CanvasLayer>
Returns the RID of the canvas used by this layer.
The custom Viewport node assigned to the CanvasLayer. If null
, uses the default viewport instead.
Scales the layer when using [member follow_viewport_enable]. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.
The layer’s rotation in degrees.
The layer’s transform.
Sets the layer to follow the viewport in order to simulate a pseudo 3D effect.
The custom Viewport node assigned to the CanvasLayer. If null
, uses the default viewport instead.
Sets the layer to follow the viewport in order to simulate a pseudo 3D effect.
Scales the layer when using [member follow_viewport_enable]. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.
The layer’s base offset.
The layer’s rotation in radians.
The layer’s rotation in degrees.
The layer’s transform.
Trait Implementations
type Target = CanvasLayer
type Target = CanvasLayer
The resulting type after dereferencing.
Dereferences the value.
Mutably dereferences the value.
type RefKind = ManuallyManaged
type RefKind = ManuallyManaged
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
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. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for ParallaxBackground
impl !Send for ParallaxBackground
impl !Sync for ParallaxBackground
impl Unpin for ParallaxBackground
impl UnwindSafe for ParallaxBackground