Struct gdnative_bindings::camera_2d::Camera2D

pub struct Camera2D { /* fields omitted */ }

core class Camera2D inherits Node2D (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.

Camera2D is a reference-only type. Persistent references can only exist in the unsafe Ref<Camera2D> 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 Ptr::free, or Ptr::queue_free if it is a Node.

Class hierarchy

Camera2D inherits methods from:

• Node2D
• CanvasItem
• 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 Camera2D

Constants

pub const ANCHOR_MODE_DRAG_CENTER: i64

pub const ANCHOR_MODE_FIXED_TOP_LEFT: i64

pub const CAMERA2D_PROCESS_IDLE: i64

pub const CAMERA2D_PROCESS_PHYSICS: i64

impl Camera2D

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

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 Ptr::free, or preferably Ptr::queue_free if it is a Node.

pub fn align(&self)

pub fn clear_current(&self)

pub fn force_update_scroll(&self)

pub fn anchor_mode(&self) -> AnchorMode

pub fn get_camera_position(&self) -> Vector2

pub fn get_camera_screen_center(&self) -> Vector2

pub fn custom_viewport(&self) -> Option<Ref<Node, Shared>>

pub fn drag_margin(&self, margin: i64) -> f64

pub fn follow_smoothing(&self) -> f64

pub fn h_offset(&self) -> f64

pub fn limit(&self, margin: i64) -> i64

pub fn offset(&self) -> Vector2

pub fn process_mode(&self) -> Camera2DProcessMode

pub fn v_offset(&self) -> f64

pub fn zoom(&self) -> Vector2

pub fn is_current(&self) -> bool

pub fn is_follow_smoothing_enabled(&self) -> bool

pub fn is_h_drag_enabled(&self) -> bool

pub fn is_limit_drawing_enabled(&self) -> bool

pub fn is_limit_smoothing_enabled(&self) -> bool

pub fn is_margin_drawing_enabled(&self) -> bool

pub fn is_rotating(&self) -> bool

pub fn is_screen_drawing_enabled(&self) -> bool

pub fn is_v_drag_enabled(&self) -> bool

pub fn make_current(&self)

pub fn reset_smoothing(&self)

pub fn set_anchor_mode(&self, anchor_mode: i64)

pub fn set_custom_viewport(&self, viewport: impl AsArg<Node>)

pub fn set_drag_margin(&self, margin: i64, drag_margin: f64)

pub fn set_enable_follow_smoothing(&self, follow_smoothing: bool)

pub fn set_follow_smoothing(&self, follow_smoothing: f64)

pub fn set_h_drag_enabled(&self, enabled: bool)

pub fn set_h_offset(&self, ofs: f64)

pub fn set_limit(&self, margin: i64, limit: i64)

pub fn set_limit_drawing_enabled(&self, limit_drawing_enabled: bool)

pub fn set_limit_smoothing_enabled(&self, limit_smoothing_enabled: bool)

pub fn set_margin_drawing_enabled(&self, margin_drawing_enabled: bool)

pub fn set_offset(&self, offset: Vector2)

pub fn set_process_mode(&self, mode: i64)

pub fn set_rotating(&self, rotating: bool)

pub fn set_screen_drawing_enabled(&self, screen_drawing_enabled: bool)

pub fn set_v_drag_enabled(&self, enabled: bool)

pub fn set_v_offset(&self, ofs: f64)

pub fn set_zoom(&self, zoom: Vector2)

Methods from Deref<Target = Node2D>

pub fn apply_scale(&self, ratio: Vector2)

pub fn get_angle_to(&self, point: Vector2) -> f64

pub fn global_position(&self) -> Vector2

pub fn global_rotation(&self) -> f64

pub fn global_rotation_degrees(&self) -> f64

pub fn global_scale(&self) -> Vector2

pub fn position(&self) -> Vector2

pub fn get_relative_transform_to_parent(
    &self,
    parent: impl AsArg<Node>
) -> Transform2D

pub fn rotation(&self) -> f64

pub fn rotation_degrees(&self) -> f64

pub fn scale(&self) -> Vector2

pub fn z_index(&self) -> i64

pub fn global_translate(&self, offset: Vector2)

pub fn is_z_relative(&self) -> bool

pub fn look_at(&self, point: Vector2)

pub fn move_local_x(&self, delta: f64, scaled: bool)

pub fn move_local_y(&self, delta: f64, scaled: bool)

pub fn rotate(&self, radians: f64)

pub fn set_global_position(&self, position: Vector2)

pub fn set_global_rotation(&self, radians: f64)

pub fn set_global_rotation_degrees(&self, degrees: f64)

pub fn set_global_scale(&self, scale: Vector2)

pub fn set_global_transform(&self, xform: Transform2D)

pub fn set_position(&self, position: Vector2)

pub fn set_rotation(&self, radians: f64)

pub fn set_rotation_degrees(&self, degrees: f64)

pub fn set_scale(&self, scale: Vector2)

pub fn set_transform(&self, xform: Transform2D)

pub fn set_z_as_relative(&self, enable: bool)

pub fn set_z_index(&self, z_index: i64)

pub fn to_global(&self, local_point: Vector2) -> Vector2

pub fn to_local(&self, global_point: Vector2) -> Vector2

pub fn translate(&self, offset: Vector2)

Trait Implementations

impl Debug for Camera2D

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

Formats the value using the given formatter.

impl Deref for Camera2D

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for Camera2D

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

Mutably dereferences the value.

impl GodotObject for Camera2D

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 Instanciable for Camera2D

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

impl QueueFree for Camera2D

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for Camera2D

impl SubClass<CanvasItem> for Camera2D

impl SubClass<Node> for Camera2D

impl SubClass<Node2D> for Camera2D

impl SubClass<Object> for Camera2D