Struct CanvasItem

pub struct CanvasItem { /* private fields */ }

core class CanvasItem inherits Node (unsafe).

Official documentation

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

Feature flag

This type is behind the gdnative crate’s common feature flag.

Class hierarchy

CanvasItem inherits methods from:

• Node
• Object

Implementations

impl CanvasItem

pub unsafe fn _draw(&mut self)

pub unsafe fn _toplevel_raise_self(&mut self)

pub unsafe fn _update_callback(&mut self)

pub unsafe fn _edit_set_state(&mut self, state: Dictionary)

pub unsafe fn _edit_get_state(&self) -> Dictionary

pub unsafe fn _edit_set_position(&mut self, position: Vector2)

pub unsafe fn _edit_get_position(&self) -> Vector2

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

pub unsafe fn _edit_get_scale(&self) -> Vector2

pub unsafe fn _edit_set_rect(&mut self, rect: Rect2)

pub unsafe fn _edit_get_rect(&self) -> Rect2

pub unsafe fn _edit_use_rect(&self) -> bool

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

pub unsafe fn _edit_get_rotation(&self) -> f64

pub unsafe fn _edit_use_rotation(&self) -> bool

pub unsafe fn _edit_set_pivot(&mut self, pivot: Vector2)

pub unsafe fn _edit_get_pivot(&self) -> Vector2

pub unsafe fn _edit_use_pivot(&self) -> bool

pub unsafe fn get_canvas_item(&self) -> Rid

pub unsafe fn set_visible(&mut self, visible: bool)

pub unsafe fn is_visible(&self) -> bool

pub unsafe fn is_visible_in_tree(&self) -> bool

pub unsafe fn show(&mut self)

pub unsafe fn hide(&mut self)

pub unsafe fn update(&mut self)

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

pub unsafe fn is_set_as_toplevel(&self) -> bool

pub unsafe fn set_light_mask(&mut self, light_mask: i64)

pub unsafe fn get_light_mask(&self) -> i64

pub unsafe fn set_modulate(&mut self, modulate: Color)

pub unsafe fn get_modulate(&self) -> Color

pub unsafe fn set_self_modulate(&mut self, self_modulate: Color)

pub unsafe fn get_self_modulate(&self) -> Color

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

pub unsafe fn is_draw_behind_parent_enabled(&self) -> bool

pub unsafe fn _set_on_top(&mut self, on_top: bool)

pub unsafe fn _is_on_top(&self) -> bool

pub unsafe fn draw_line( &mut self, from: Vector2, to: Vector2, color: Color, width: f64, antialiased: bool, )

pub unsafe fn draw_polyline( &mut self, points: Vector2Array, color: Color, width: f64, antialiased: bool, )

pub unsafe fn draw_polyline_colors( &mut self, points: Vector2Array, colors: ColorArray, width: f64, antialiased: bool, )

pub unsafe fn draw_multiline( &mut self, points: Vector2Array, color: Color, width: f64, antialiased: bool, )

pub unsafe fn draw_multiline_colors( &mut self, points: Vector2Array, colors: ColorArray, width: f64, antialiased: bool, )

pub unsafe fn draw_rect(&mut self, rect: Rect2, color: Color, filled: bool)

pub unsafe fn draw_circle( &mut self, position: Vector2, radius: f64, color: Color, )

pub unsafe fn draw_texture( &mut self, texture: Option<Texture>, position: Vector2, modulate: Color, normal_map: Option<Texture>, )

pub unsafe fn draw_texture_rect( &mut self, texture: Option<Texture>, rect: Rect2, tile: bool, modulate: Color, transpose: bool, normal_map: Option<Texture>, )

pub unsafe fn draw_texture_rect_region( &mut self, texture: Option<Texture>, rect: Rect2, src_rect: Rect2, modulate: Color, transpose: bool, normal_map: Option<Texture>, clip_uv: bool, )

pub unsafe fn draw_style_box( &mut self, style_box: Option<StyleBox>, rect: Rect2, )

pub unsafe fn draw_primitive( &mut self, points: Vector2Array, colors: ColorArray, uvs: Vector2Array, texture: Option<Texture>, width: f64, normal_map: Option<Texture>, )

pub unsafe fn draw_polygon( &mut self, points: Vector2Array, colors: ColorArray, uvs: Vector2Array, texture: Option<Texture>, normal_map: Option<Texture>, antialiased: bool, )

pub unsafe fn draw_colored_polygon( &mut self, points: Vector2Array, color: Color, uvs: Vector2Array, texture: Option<Texture>, normal_map: Option<Texture>, antialiased: bool, )

pub unsafe fn draw_string( &mut self, font: Option<Font>, position: Vector2, text: GodotString, modulate: Color, clip_w: i64, )

pub unsafe fn draw_char( &mut self, font: Option<Font>, position: Vector2, char: GodotString, next: GodotString, modulate: Color, ) -> f64

pub unsafe fn draw_mesh( &mut self, mesh: Option<Mesh>, texture: Option<Texture>, normal_map: Option<Texture>, )

pub unsafe fn draw_multimesh( &mut self, mesh: Option<Mesh>, texture: Option<Texture>, normal_map: Option<Texture>, )

pub unsafe fn draw_set_transform( &mut self, position: Vector2, rotation: f64, scale: Vector2, )

pub unsafe fn draw_set_transform_matrix(&mut self, xform: Transform2D)

pub unsafe fn get_transform(&self) -> Transform2D

pub unsafe fn get_global_transform(&self) -> Transform2D

pub unsafe fn get_global_transform_with_canvas(&self) -> Transform2D

pub unsafe fn get_viewport_transform(&self) -> Transform2D

pub unsafe fn get_viewport_rect(&self) -> Rect2

pub unsafe fn get_canvas_transform(&self) -> Transform2D

pub unsafe fn get_local_mouse_position(&self) -> Vector2

pub unsafe fn get_global_mouse_position(&self) -> Vector2

pub unsafe fn get_canvas(&self) -> Rid

pub unsafe fn get_world_2d(&self) -> Option<World2D>

pub unsafe fn set_material(&mut self, material: Option<Material>)

pub unsafe fn get_material(&self) -> Option<Material>

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

pub unsafe fn get_use_parent_material(&self) -> bool

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

pub unsafe fn is_local_transform_notification_enabled(&self) -> bool

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

pub unsafe fn is_transform_notification_enabled(&self) -> bool

pub unsafe fn make_canvas_position_local( &self, screen_point: Vector2, ) -> Vector2

pub unsafe fn make_input_local( &self, event: Option<InputEvent>, ) -> Option<InputEvent>

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn _enter_tree(&mut self)

Inherited from Node.

pub unsafe fn _exit_tree(&mut self)

Inherited from Node.

pub unsafe fn _ready(&mut self)

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_name(&self) -> GodotString

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_child_count(&self) -> i64

Inherited from Node.

pub unsafe fn get_children(&self) -> VariantArray

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_inside_tree(&self) -> bool

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_path(&self) -> NodePath

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_groups(&self) -> VariantArray

Inherited from Node.

pub unsafe fn raise(&mut self)

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn remove_and_skip(&mut self)

Inherited from Node.

pub unsafe fn get_index(&self) -> i64

Inherited from Node.

pub unsafe fn print_tree(&mut self)

Inherited from Node.

pub unsafe fn print_tree_pretty(&mut self)

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_filename(&self) -> GodotString

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_physics_process_delta_time(&self) -> f64

Inherited from Node.

pub unsafe fn is_physics_processing(&self) -> bool

Inherited from Node.

pub unsafe fn get_process_delta_time(&self) -> f64

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_input(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_unhandled_input(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_unhandled_key_input(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_pause_mode(&self) -> NodePauseMode

Inherited from Node.

pub unsafe fn can_process(&self) -> bool

Inherited from Node.

pub unsafe fn print_stray_nodes(&mut self)

Inherited from Node.

pub unsafe fn get_position_in_parent(&self) -> i64

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_displayed_folded(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_internal(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_physics_processing_internal(&self) -> bool

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_scene_instance_load_placeholder(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn queue_free(&mut self)

Inherited from Node.

pub unsafe fn request_ready(&mut self)

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_network_master(&self) -> i64

Inherited from Node.

pub unsafe fn is_network_master(&self) -> bool

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

pub unsafe fn _get_import_path(&self) -> NodePath

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Node.

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

Inherited from Object.

pub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> bool

Inherited from Object.

pub unsafe fn _get(&mut self, property: GodotString) -> Variant

Inherited from Object.

pub unsafe fn _get_property_list(&mut self) -> VariantArray

Inherited from Object.

pub unsafe fn _init(&mut self)

Inherited from Object.

pub unsafe fn get_class(&self) -> GodotString

Inherited from Object.

pub unsafe fn is_class(&self, _type: GodotString) -> bool

Inherited from Object.

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

Inherited from Object.

pub unsafe fn get(&self, property: GodotString) -> Variant

Inherited from Object.

pub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)

Inherited from Object.

pub unsafe fn get_indexed(&self, property: NodePath) -> Variant

Inherited from Object.

pub unsafe fn get_property_list(&self) -> VariantArray

Inherited from Object.

pub unsafe fn get_method_list(&self) -> VariantArray

Inherited from Object.

pub unsafe fn notification(&mut self, what: i64, reversed: bool)

Inherited from Object.

pub unsafe fn get_instance_id(&self) -> i64

Inherited from Object.

pub unsafe fn set_script(&mut self, script: Option<Reference>)

Inherited from Object.

pub unsafe fn get_script(&self) -> Option<Reference>

Inherited from Object.

pub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)

Inherited from Object.

pub unsafe fn get_meta(&self, name: GodotString) -> Variant

Inherited from Object.

pub unsafe fn has_meta(&self, name: GodotString) -> bool

Inherited from Object.

pub unsafe fn get_meta_list(&self) -> StringArray

Inherited from Object.

pub unsafe fn add_user_signal( &mut self, signal: GodotString, arguments: VariantArray, )

Inherited from Object.

pub unsafe fn has_user_signal(&self, signal: GodotString) -> bool

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub unsafe fn callv( &mut self, method: GodotString, arg_array: VariantArray, ) -> Variant

Inherited from Object.

pub unsafe fn has_method(&self, method: GodotString) -> bool

Inherited from Object.

pub unsafe fn get_signal_list(&self) -> VariantArray

Inherited from Object.

pub unsafe fn get_signal_connection_list( &self, signal: GodotString, ) -> VariantArray

Inherited from Object.

pub unsafe fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

pub unsafe fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult

Inherited from Object.

pub unsafe fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )

Inherited from Object.

pub unsafe fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool

Inherited from Object.

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

Inherited from Object.

pub unsafe fn is_blocking_signals(&self) -> bool

Inherited from Object.

pub unsafe fn property_list_changed_notify(&mut self)

Inherited from Object.

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

Inherited from Object.

pub unsafe fn can_translate_messages(&self) -> bool

Inherited from Object.

pub unsafe fn tr(&self, message: GodotString) -> GodotString

Inherited from Object.

pub unsafe fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

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 CanvasItem

fn clone(&self) -> CanvasItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanvasItem

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

Formats the value using the given formatter.

impl GodotObject for CanvasItem

fn class_name() -> &'static str

impl QueueFree for CanvasItem

unsafe fn godot_queue_free(&mut self)

impl ToVariant for CanvasItem

fn to_variant(&self) -> Variant

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

impl Copy for CanvasItem