Struct gdnative_bindings::CanvasLayer

pub struct CanvasLayer { /* fields omitted */ }

core class CanvasLayer inherits Node (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.

CanvasLayer 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 CanvasLayer::free.

Class hierarchy

CanvasLayer inherits methods from:

• Node
• Object

Methods

impl CanvasLayer

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 CanvasLayer::free.

pub unsafe fn free(self)

Manually deallocate the object.

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.

Methods from Deref<Target = Node>

pub const NOTIFICATION_READY: i64

pub const NOTIFICATION_PROCESS: i64

pub const PAUSE_MODE_INHERIT: i64

pub const NOTIFICATION_TRANSLATION_CHANGED: i64

pub const NOTIFICATION_DRAG_END: i64

pub const NOTIFICATION_PATH_CHANGED: i64

pub const NOTIFICATION_ENTER_TREE: i64

pub const NOTIFICATION_INTERNAL_PROCESS: i64

pub const NOTIFICATION_DRAG_BEGIN: i64

pub const PAUSE_MODE_STOP: i64

pub const NOTIFICATION_INSTANCED: i64

pub const PAUSE_MODE_PROCESS: i64

pub const DUPLICATE_SCRIPTS: i64

pub const NOTIFICATION_EXIT_TREE: i64

pub const NOTIFICATION_UNPAUSED: i64

pub const NOTIFICATION_MOVED_IN_PARENT: i64

pub const DUPLICATE_GROUPS: i64

pub const DUPLICATE_SIGNALS: i64

pub const NOTIFICATION_PARENTED: i64

pub const NOTIFICATION_INTERNAL_PHYSICS_PROCESS: i64

pub const NOTIFICATION_PAUSED: i64

pub const NOTIFICATION_PHYSICS_PROCESS: i64

pub const NOTIFICATION_UNPARENTED: i64

pub const DUPLICATE_USE_INSTANCING: i64

pub unsafe fn _enter_tree(&mut self)

pub unsafe fn _exit_tree(&mut self)

pub unsafe fn _get_configuration_warning(&mut self) -> GodotString

pub unsafe fn _get_import_path(&self) -> NodePath

pub unsafe fn _input(&mut self, event: Option<InputEvent>)

pub unsafe fn _physics_process(&mut self, delta: f64)

pub unsafe fn _process(&mut self, delta: f64)

pub unsafe fn _ready(&mut self)

pub unsafe fn _set_import_path(&mut self, import_path: NodePath)

pub unsafe fn _unhandled_input(&mut self, event: Option<InputEvent>)

pub unsafe fn _unhandled_key_input(&mut self, event: Option<InputEventKey>)

pub unsafe fn add_child(
    &mut self,
    node: Option<Node>,
    legible_unique_name: bool
)

pub unsafe fn add_child_below_node(
    &mut self,
    node: Option<Node>,
    child_node: Option<Node>,
    legible_unique_name: bool
)

pub unsafe fn add_to_group(&mut self, group: GodotString, persistent: bool)

pub unsafe fn can_process(&self) -> bool

pub unsafe fn duplicate(&self, flags: i64) -> Option<Node>

pub unsafe fn find_node(
    &self,
    mask: GodotString,
    recursive: bool,
    owned: bool
) -> Option<Node>

pub unsafe fn find_parent(&self, mask: GodotString) -> Option<Node>

pub unsafe fn get_child(&self, idx: i64) -> Option<Node>

pub unsafe fn get_child_count(&self) -> i64

pub unsafe fn get_children(&self) -> VariantArray

pub unsafe fn get_custom_multiplayer(&self) -> Option<MultiplayerAPI>

pub unsafe fn get_filename(&self) -> GodotString

pub unsafe fn get_groups(&self) -> VariantArray

pub unsafe fn get_index(&self) -> i64

pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>

pub unsafe fn get_name(&self) -> GodotString

pub unsafe fn get_network_master(&self) -> i64

pub unsafe fn get_node(&self, path: NodePath) -> Option<Node>

pub unsafe fn get_node_and_resource(&mut self, path: NodePath) -> VariantArray

pub unsafe fn get_node_or_null(&self, path: NodePath) -> Option<Node>

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

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

pub unsafe fn get_path(&self) -> NodePath

pub unsafe fn get_path_to(&self, node: Option<Node>) -> NodePath

pub unsafe fn get_pause_mode(&self) -> NodePauseMode

pub unsafe fn get_physics_process_delta_time(&self) -> f64

pub unsafe fn get_position_in_parent(&self) -> i64

pub unsafe fn get_process_delta_time(&self) -> f64

pub unsafe fn get_scene_instance_load_placeholder(&self) -> bool

pub unsafe fn get_tree(&self) -> Option<SceneTree>

pub unsafe fn get_viewport(&self) -> Option<Viewport>

pub unsafe fn has_node(&self, path: NodePath) -> bool

pub unsafe fn has_node_and_resource(&self, path: NodePath) -> bool

pub unsafe fn is_a_parent_of(&self, node: Option<Node>) -> bool

pub unsafe fn is_displayed_folded(&self) -> bool

pub unsafe fn is_greater_than(&self, node: Option<Node>) -> bool

pub unsafe fn is_in_group(&self, group: GodotString) -> bool

pub unsafe fn is_inside_tree(&self) -> bool

pub unsafe fn is_network_master(&self) -> bool

pub unsafe fn is_physics_processing(&self) -> bool

pub unsafe fn is_physics_processing_internal(&self) -> bool

pub unsafe fn is_processing(&self) -> bool

pub unsafe fn is_processing_input(&self) -> bool

pub unsafe fn is_processing_internal(&self) -> bool

pub unsafe fn is_processing_unhandled_input(&self) -> bool

pub unsafe fn is_processing_unhandled_key_input(&self) -> bool

pub unsafe fn move_child(&mut self, child_node: Option<Node>, to_position: i64)

pub unsafe fn print_stray_nodes(&mut self)

pub unsafe fn print_tree(&mut self)

pub unsafe fn print_tree_pretty(&mut self)

pub unsafe fn propagate_call(
    &mut self,
    method: GodotString,
    args: VariantArray,
    parent_first: bool
)

pub unsafe fn propagate_notification(&mut self, what: i64)

pub unsafe fn queue_free(&mut self)

pub unsafe fn raise(&mut self)

pub unsafe fn remove_and_skip(&mut self)

pub unsafe fn remove_child(&mut self, node: Option<Node>)

pub unsafe fn remove_from_group(&mut self, group: GodotString)

pub unsafe fn replace_by(&mut self, node: Option<Node>, keep_data: bool)

pub unsafe fn request_ready(&mut self)

pub unsafe fn rpc(
    &mut self,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

pub unsafe fn rpc_config(&mut self, method: GodotString, mode: i64)

pub unsafe fn rpc_id(
    &mut self,
    peer_id: i64,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

pub unsafe fn rpc_unreliable(
    &mut self,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

pub unsafe fn rpc_unreliable_id(
    &mut self,
    peer_id: i64,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

pub unsafe fn rset(&mut self, property: GodotString, value: Variant)

pub unsafe fn rset_config(&mut self, property: GodotString, mode: i64)

pub unsafe fn rset_id(
    &mut self,
    peer_id: i64,
    property: GodotString,
    value: Variant
)

pub unsafe fn rset_unreliable(&mut self, property: GodotString, value: Variant)

pub unsafe fn rset_unreliable_id(
    &mut self,
    peer_id: i64,
    property: GodotString,
    value: Variant
)

pub unsafe fn set_custom_multiplayer(&mut self, api: Option<MultiplayerAPI>)

pub unsafe fn set_display_folded(&mut self, fold: bool)

pub unsafe fn set_filename(&mut self, filename: GodotString)

pub unsafe fn set_name(&mut self, name: GodotString)

pub unsafe fn set_network_master(&mut self, id: i64, recursive: bool)

pub unsafe fn set_owner(&mut self, owner: Option<Node>)

pub unsafe fn set_pause_mode(&mut self, mode: i64)

pub unsafe fn set_physics_process(&mut self, enable: bool)

pub unsafe fn set_physics_process_internal(&mut self, enable: bool)

pub unsafe fn set_process(&mut self, enable: bool)

pub unsafe fn set_process_input(&mut self, enable: bool)

pub unsafe fn set_process_internal(&mut self, enable: bool)

pub unsafe fn set_process_priority(&mut self, priority: i64)

pub unsafe fn set_process_unhandled_input(&mut self, enable: bool)

pub unsafe fn set_process_unhandled_key_input(&mut self, enable: bool)

pub unsafe fn set_scene_instance_load_placeholder(
    &mut self,
    load_placeholder: bool
)

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 CanvasLayer

fn clone(&self) -> CanvasLayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CanvasLayer

impl Debug for CanvasLayer

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

Formats the value using the given formatter.

impl Deref for CanvasLayer

type Target = Node

The resulting type after dereferencing.

fn deref(&self) -> &Node

Dereferences the value.

impl DerefMut for CanvasLayer

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

Mutably dereferences the value.

impl Free for CanvasLayer

unsafe fn godot_free(self)

impl FromVariant for CanvasLayer

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

impl GodotObject for CanvasLayer

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 CanvasLayer

fn construct() -> Self

impl QueueFree for CanvasLayer

unsafe fn godot_queue_free(&mut self)

impl ToVariant for CanvasLayer

fn to_variant(&self) -> Variant