Struct gdnative::api::CanvasItem

pub struct CanvasItem { /* fields omitted */ }

core class CanvasItem inherits Node (unsafe).

Official documentation

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

Class hierarchy

CanvasItem inherits methods from:

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

Constants

pub const BLEND_MODE_ADD: i64

pub const BLEND_MODE_DISABLED: i64

pub const BLEND_MODE_MIX: i64

pub const BLEND_MODE_MUL: i64

pub const BLEND_MODE_PREMULT_ALPHA: i64

pub const BLEND_MODE_SUB: i64

pub const NOTIFICATION_DRAW: i64

pub const NOTIFICATION_ENTER_CANVAS: i64

pub const NOTIFICATION_EXIT_CANVAS: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

impl CanvasItem

pub fn draw_arc(
    &self,
    center: Vector2D<f32, UnknownUnit>,
    radius: f64,
    start_angle: f64,
    end_angle: f64,
    point_count: i64,
    color: Color,
    width: f64,
    antialiased: bool
)

pub fn draw_char(
    &self,
    font: impl AsArg<Font>,
    position: Vector2D<f32, UnknownUnit>,
    char: impl Into<GodotString>,
    next: impl Into<GodotString>,
    modulate: Color
) -> f64

pub fn draw_circle(
    &self,
    position: Vector2D<f32, UnknownUnit>,
    radius: f64,
    color: Color
)

pub fn draw_colored_polygon(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    color: Color,
    uvs: TypedArray<Vector2D<f32, UnknownUnit>>,
    texture: impl AsArg<Texture>,
    normal_map: impl AsArg<Texture>,
    antialiased: bool
)

pub fn draw_line(
    &self,
    from: Vector2D<f32, UnknownUnit>,
    to: Vector2D<f32, UnknownUnit>,
    color: Color,
    width: f64,
    antialiased: bool
)

pub fn draw_mesh(
    &self,
    mesh: impl AsArg<Mesh>,
    texture: impl AsArg<Texture>,
    normal_map: impl AsArg<Texture>,
    transform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    modulate: Color
)

pub fn draw_multiline(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    color: Color,
    width: f64,
    antialiased: bool
)

pub fn draw_multiline_colors(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    colors: TypedArray<Color>,
    width: f64,
    antialiased: bool
)

pub fn draw_multimesh(
    &self,
    multimesh: impl AsArg<MultiMesh>,
    texture: impl AsArg<Texture>,
    normal_map: impl AsArg<Texture>
)

pub fn draw_polygon(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    colors: TypedArray<Color>,
    uvs: TypedArray<Vector2D<f32, UnknownUnit>>,
    texture: impl AsArg<Texture>,
    normal_map: impl AsArg<Texture>,
    antialiased: bool
)

pub fn draw_polyline(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    color: Color,
    width: f64,
    antialiased: bool
)

pub fn draw_polyline_colors(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    colors: TypedArray<Color>,
    width: f64,
    antialiased: bool
)

pub fn draw_primitive(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    colors: TypedArray<Color>,
    uvs: TypedArray<Vector2D<f32, UnknownUnit>>,
    texture: impl AsArg<Texture>,
    width: f64,
    normal_map: impl AsArg<Texture>
)

pub fn draw_rect(
    &self,
    rect: Rect<f32, UnknownUnit>,
    color: Color,
    filled: bool,
    width: f64,
    antialiased: bool
)

pub fn draw_set_transform(
    &self,
    position: Vector2D<f32, UnknownUnit>,
    rotation: f64,
    scale: Vector2D<f32, UnknownUnit>
)

pub fn draw_set_transform_matrix(
    &self,
    xform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

pub fn draw_string(
    &self,
    font: impl AsArg<Font>,
    position: Vector2D<f32, UnknownUnit>,
    text: impl Into<GodotString>,
    modulate: Color,
    clip_w: i64
)

pub fn draw_style_box(
    &self,
    style_box: impl AsArg<StyleBox>,
    rect: Rect<f32, UnknownUnit>
)

pub fn draw_texture(
    &self,
    texture: impl AsArg<Texture>,
    position: Vector2D<f32, UnknownUnit>,
    modulate: Color,
    normal_map: impl AsArg<Texture>
)

pub fn draw_texture_rect(
    &self,
    texture: impl AsArg<Texture>,
    rect: Rect<f32, UnknownUnit>,
    tile: bool,
    modulate: Color,
    transpose: bool,
    normal_map: impl AsArg<Texture>
)

pub fn draw_texture_rect_region(
    &self,
    texture: impl AsArg<Texture>,
    rect: Rect<f32, UnknownUnit>,
    src_rect: Rect<f32, UnknownUnit>,
    modulate: Color,
    transpose: bool,
    normal_map: impl AsArg<Texture>,
    clip_uv: bool
)

pub fn force_update_transform(&self)

pub fn get_canvas(&self) -> Rid

pub fn get_canvas_item(&self) -> Rid

pub fn get_canvas_transform(&self) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub fn get_global_mouse_position(&self) -> Vector2D<f32, UnknownUnit>

pub fn get_global_transform(&self) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub fn get_global_transform_with_canvas(
    &self
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub fn light_mask(&self) -> i64

pub fn get_local_mouse_position(&self) -> Vector2D<f32, UnknownUnit>

pub fn material(&self) -> Option<Ref<Material, Shared>>

pub fn modulate(&self) -> Color

pub fn self_modulate(&self) -> Color

pub fn get_transform(&self) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub fn use_parent_material(&self) -> bool

pub fn get_viewport_rect(&self) -> Rect<f32, UnknownUnit>

pub fn get_viewport_transform(
    &self
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub fn get_world_2d(&self) -> Option<Ref<World2D, Shared>>

pub fn hide(&self)

pub fn is_draw_behind_parent_enabled(&self) -> bool

pub fn is_local_transform_notification_enabled(&self) -> bool

pub fn is_set_as_toplevel(&self) -> bool

pub fn is_transform_notification_enabled(&self) -> bool

pub fn is_visible(&self) -> bool

pub fn is_visible_in_tree(&self) -> bool

pub fn make_canvas_position_local(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

pub fn make_input_local(
    &self,
    event: impl AsArg<InputEvent>
) -> Option<Ref<InputEvent, Shared>>

pub fn set_as_toplevel(&self, enable: bool)

pub fn set_draw_behind_parent(&self, enable: bool)

pub fn set_light_mask(&self, light_mask: i64)

pub fn set_material(&self, material: impl AsArg<Material>)

pub fn set_modulate(&self, modulate: Color)

pub fn set_notify_local_transform(&self, enable: bool)

pub fn set_notify_transform(&self, enable: bool)

pub fn set_self_modulate(&self, self_modulate: Color)

pub fn set_use_parent_material(&self, enable: bool)

pub fn set_visible(&self, visible: bool)

pub fn show(&self)

pub fn update(&self)

Methods from Deref<Target = Node>

pub const DUPLICATE_GROUPS: i64

pub const DUPLICATE_SCRIPTS: i64

pub const DUPLICATE_SIGNALS: i64

pub const DUPLICATE_USE_INSTANCING: i64

pub const NOTIFICATION_APP_PAUSED: i64

pub const NOTIFICATION_APP_RESUMED: i64

pub const NOTIFICATION_CRASH: i64

pub const NOTIFICATION_DRAG_BEGIN: i64

pub const NOTIFICATION_DRAG_END: i64

pub const NOTIFICATION_ENTER_TREE: i64

pub const NOTIFICATION_EXIT_TREE: i64

pub const NOTIFICATION_INSTANCED: i64

pub const NOTIFICATION_INTERNAL_PHYSICS_PROCESS: i64

pub const NOTIFICATION_INTERNAL_PROCESS: i64

pub const NOTIFICATION_MOVED_IN_PARENT: i64

pub const NOTIFICATION_OS_IME_UPDATE: i64

pub const NOTIFICATION_OS_MEMORY_WARNING: i64

pub const NOTIFICATION_PARENTED: i64

pub const NOTIFICATION_PATH_CHANGED: i64

pub const NOTIFICATION_PAUSED: i64

pub const NOTIFICATION_PHYSICS_PROCESS: i64

pub const NOTIFICATION_PROCESS: i64

pub const NOTIFICATION_READY: i64

pub const NOTIFICATION_TRANSLATION_CHANGED: i64

pub const NOTIFICATION_UNPARENTED: i64

pub const NOTIFICATION_UNPAUSED: i64

pub const NOTIFICATION_WM_ABOUT: i64

pub const NOTIFICATION_WM_FOCUS_IN: i64

pub const NOTIFICATION_WM_FOCUS_OUT: i64

pub const NOTIFICATION_WM_GO_BACK_REQUEST: i64

pub const NOTIFICATION_WM_MOUSE_ENTER: i64

pub const NOTIFICATION_WM_MOUSE_EXIT: i64

pub const NOTIFICATION_WM_QUIT_REQUEST: i64

pub const NOTIFICATION_WM_UNFOCUS_REQUEST: i64

pub const PAUSE_MODE_INHERIT: i64

pub const PAUSE_MODE_PROCESS: i64

pub const PAUSE_MODE_STOP: i64

pub fn add_child(&self, node: impl AsArg<Node>, legible_unique_name: bool)

pub fn add_child_below_node(
    &self,
    node: impl AsArg<Node>,
    child_node: impl AsArg<Node>,
    legible_unique_name: bool
)

pub fn add_to_group(&self, group: impl Into<GodotString>, persistent: bool)

pub fn can_process(&self) -> bool

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

pub fn find_node(
    &self,
    mask: impl Into<GodotString>,
    recursive: bool,
    owned: bool
) -> Option<Ref<Node, Shared>>

pub fn find_parent(
    &self,
    mask: impl Into<GodotString>
) -> Option<Ref<Node, Shared>>

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

pub fn get_child_count(&self) -> i64

pub fn get_children(&self) -> VariantArray<Shared>

pub fn custom_multiplayer(&self) -> Option<Ref<MultiplayerAPI, Shared>>

pub fn filename(&self) -> GodotString

pub fn get_groups(&self) -> VariantArray<Shared>

pub fn get_index(&self) -> i64

pub fn multiplayer(&self) -> Option<Ref<MultiplayerAPI, Shared>>

pub fn name(&self) -> GodotString

pub fn get_network_master(&self) -> i64

pub fn get_node(&self, path: impl Into<NodePath>) -> Option<Ref<Node, Shared>>

pub fn get_node_and_resource(
    &self,
    path: impl Into<NodePath>
) -> VariantArray<Shared>

pub fn get_node_or_null(
    &self,
    path: impl Into<NodePath>
) -> Option<Ref<Node, Shared>>

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

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

pub fn get_path(&self) -> NodePath

pub fn get_path_to(&self, node: impl AsArg<Node>) -> NodePath

pub fn pause_mode(&self) -> PauseMode

pub fn get_physics_process_delta_time(&self) -> f64

pub fn get_position_in_parent(&self) -> i64

pub fn get_process_delta_time(&self) -> f64

pub fn process_priority(&self) -> i64

pub fn get_scene_instance_load_placeholder(&self) -> bool

pub fn get_tree(&self) -> Option<Ref<SceneTree, Shared>>

pub fn get_viewport(&self) -> Option<Ref<Viewport, Shared>>

pub fn has_node(&self, path: impl Into<NodePath>) -> bool

pub fn has_node_and_resource(&self, path: impl Into<NodePath>) -> bool

pub fn is_a_parent_of(&self, node: impl AsArg<Node>) -> bool

pub fn is_displayed_folded(&self) -> bool

pub fn is_greater_than(&self, node: impl AsArg<Node>) -> bool

pub fn is_in_group(&self, group: impl Into<GodotString>) -> bool

pub fn is_inside_tree(&self) -> bool

pub fn is_network_master(&self) -> bool

pub fn is_physics_processing(&self) -> bool

pub fn is_physics_processing_internal(&self) -> bool

pub fn is_processing(&self) -> bool

pub fn is_processing_input(&self) -> bool

pub fn is_processing_internal(&self) -> bool

pub fn is_processing_unhandled_input(&self) -> bool

pub fn is_processing_unhandled_key_input(&self) -> bool

pub fn move_child(&self, child_node: impl AsArg<Node>, to_position: i64)

pub fn print_stray_nodes(&self)

pub fn print_tree(&self)

pub fn print_tree_pretty(&self)

pub fn propagate_call(
    &self,
    method: impl Into<GodotString>,
    args: VariantArray<Shared>,
    parent_first: bool
)

pub fn propagate_notification(&self, what: i64)

pub fn queue_free(&self)

pub fn raise(&self)

pub fn remove_and_skip(&self)

pub fn remove_child(&self, node: impl AsArg<Node>)

pub fn remove_from_group(&self, group: impl Into<GodotString>)

pub fn replace_by(&self, node: impl AsArg<Node>, keep_data: bool)

pub fn request_ready(&self)

pub fn rpc(
    &self,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn rpc_config(&self, method: impl Into<GodotString>, mode: i64)

pub fn rpc_id(
    &self,
    peer_id: i64,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn rpc_unreliable(
    &self,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn rpc_unreliable_id(
    &self,
    peer_id: i64,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn rset(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)

pub fn rset_config(&self, property: impl Into<GodotString>, mode: i64)

pub fn rset_id(
    &self,
    peer_id: i64,
    property: impl Into<GodotString>,
    value: impl OwnedToVariant
)

pub fn rset_unreliable(
    &self,
    property: impl Into<GodotString>,
    value: impl OwnedToVariant
)

pub fn rset_unreliable_id(
    &self,
    peer_id: i64,
    property: impl Into<GodotString>,
    value: impl OwnedToVariant
)

pub fn set_custom_multiplayer(&self, api: impl AsArg<MultiplayerAPI>)

pub fn set_display_folded(&self, fold: bool)

pub fn set_filename(&self, filename: impl Into<GodotString>)

pub fn set_name(&self, name: impl Into<GodotString>)

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

pub fn set_owner(&self, owner: impl AsArg<Node>)

pub fn set_pause_mode(&self, mode: i64)

pub fn set_physics_process(&self, enable: bool)

pub fn set_physics_process_internal(&self, enable: bool)

pub fn set_process(&self, enable: bool)

pub fn set_process_input(&self, enable: bool)

pub fn set_process_internal(&self, enable: bool)

pub fn set_process_priority(&self, priority: i64)

pub fn set_process_unhandled_input(&self, enable: bool)

pub fn set_process_unhandled_key_input(&self, enable: bool)

pub fn set_scene_instance_load_placeholder(&self, load_placeholder: bool)

pub fn update_configuration_warning(&self)

Trait Implementations

impl Debug for CanvasItem

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

Formats the value using the given formatter.

impl Deref for CanvasItem

type Target = Node

The resulting type after dereferencing.

fn deref(&self) -> &Node

Dereferences the value.

impl DerefMut for CanvasItem

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

Mutably dereferences the value.

impl GodotObject for CanvasItem

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 QueueFree for CanvasItem

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for AnimatedSprite

impl SubClass<CanvasItem> for Line2D

impl SubClass<CanvasItem> for LightOccluder2D

impl SubClass<CanvasItem> for Sprite

impl SubClass<CanvasItem> for HSlider

impl SubClass<CanvasItem> for EditorProperty

impl SubClass<CanvasItem> for BackBufferCopy

impl SubClass<CanvasItem> for Control

impl SubClass<CanvasItem> for Particles2D

impl SubClass<CanvasItem> for GrooveJoint2D

impl SubClass<CanvasItem> for ItemList

impl SubClass<CanvasItem> for Range

impl SubClass<CanvasItem> for ScrollBar

impl SubClass<CanvasItem> for CheckBox

impl SubClass<CanvasItem> for WindowDialog

impl SubClass<CanvasItem> for MenuButton

impl SubClass<CanvasItem> for TextureProgress

impl SubClass<CanvasItem> for ScrollContainer

impl SubClass<CanvasItem> for RemoteTransform2D

impl SubClass<CanvasItem> for Position2D

impl SubClass<CanvasItem> for RayCast2D

impl SubClass<CanvasItem> for CollisionPolygon2D

impl SubClass<CanvasItem> for ToolButton

impl SubClass<CanvasItem> for CenterContainer

impl SubClass<CanvasItem> for VSlider

impl SubClass<CanvasItem> for CPUParticles2D

impl SubClass<CanvasItem> for ViewportContainer

impl SubClass<CanvasItem> for TextEdit

impl SubClass<CanvasItem> for AudioStreamPlayer2D

impl SubClass<CanvasItem> for ColorPicker

impl SubClass<CanvasItem> for SplitContainer

impl SubClass<CanvasItem> for TileMap

impl SubClass<CanvasItem> for VSplitContainer

impl SubClass<CanvasItem> for HSeparator

impl SubClass<CanvasItem> for ConfirmationDialog

impl SubClass<CanvasItem> for Bone2D

impl SubClass<CanvasItem> for Skeleton2D

impl SubClass<CanvasItem> for BoxContainer

impl SubClass<CanvasItem> for CollisionShape2D

impl SubClass<CanvasItem> for Navigation2D

impl SubClass<CanvasItem> for OptionButton

impl SubClass<CanvasItem> for Panel

impl SubClass<CanvasItem> for GridContainer

impl SubClass<CanvasItem> for NinePatchRect

impl SubClass<CanvasItem> for ScriptEditor

impl SubClass<CanvasItem> for DampedSpringJoint2D

impl SubClass<CanvasItem> for MeshInstance2D

impl SubClass<CanvasItem> for Separator

impl SubClass<CanvasItem> for Area2D

impl SubClass<CanvasItem> for MultiMeshInstance2D

impl SubClass<CanvasItem> for Popup

impl SubClass<CanvasItem> for PinJoint2D

impl SubClass<CanvasItem> for GraphNode

impl SubClass<CanvasItem> for ParallaxLayer

impl SubClass<CanvasItem> for HSplitContainer

impl SubClass<CanvasItem> for VisibilityEnabler2D

impl SubClass<CanvasItem> for Label

impl SubClass<CanvasItem> for EditorFileDialog

impl SubClass<CanvasItem> for TabContainer

impl SubClass<CanvasItem> for KinematicBody2D

impl SubClass<CanvasItem> for Node2D

impl SubClass<CanvasItem> for Polygon2D

impl SubClass<CanvasItem> for ScriptCreateDialog

impl SubClass<CanvasItem> for PanelContainer

impl SubClass<CanvasItem> for VScrollBar

impl SubClass<CanvasItem> for Tabs

impl SubClass<CanvasItem> for CanvasModulate

impl SubClass<CanvasItem> for StaticBody2D

impl SubClass<CanvasItem> for Light2D

impl SubClass<CanvasItem> for AcceptDialog

impl SubClass<CanvasItem> for VisibilityNotifier2D

impl SubClass<CanvasItem> for LineEdit

impl SubClass<CanvasItem> for ColorRect

impl SubClass<CanvasItem> for CollisionObject2D

impl SubClass<CanvasItem> for Slider

impl SubClass<CanvasItem> for Camera2D

impl SubClass<CanvasItem> for VideoPlayer

impl SubClass<CanvasItem> for HScrollBar

impl SubClass<CanvasItem> for TouchScreenButton

impl SubClass<CanvasItem> for LinkButton

impl SubClass<CanvasItem> for FileDialog

impl SubClass<CanvasItem> for NavigationPolygonInstance

impl SubClass<CanvasItem> for EditorInspector

impl SubClass<CanvasItem> for HBoxContainer

impl SubClass<CanvasItem> for TextureRect

impl SubClass<CanvasItem> for PopupDialog

impl SubClass<CanvasItem> for PathFollow2D

impl SubClass<CanvasItem> for YSort

impl SubClass<CanvasItem> for ColorPickerButton

impl SubClass<CanvasItem> for RichTextLabel

impl SubClass<CanvasItem> for VBoxContainer

impl SubClass<CanvasItem> for PhysicsBody2D

impl SubClass<CanvasItem> for FileSystemDock

impl SubClass<CanvasItem> for MarginContainer

impl SubClass<CanvasItem> for RigidBody2D

impl SubClass<CanvasItem> for CheckButton

impl SubClass<CanvasItem> for PopupMenu

impl SubClass<CanvasItem> for TextureButton

impl SubClass<CanvasItem> for PopupPanel

impl SubClass<CanvasItem> for ReferenceRect

impl SubClass<CanvasItem> for GraphEdit

impl SubClass<CanvasItem> for Container

impl SubClass<CanvasItem> for Button

impl SubClass<CanvasItem> for SpinBox

impl SubClass<CanvasItem> for Joint2D

impl SubClass<CanvasItem> for BaseButton

impl SubClass<CanvasItem> for VSeparator

impl SubClass<CanvasItem> for EditorSpinSlider

impl SubClass<CanvasItem> for Tree

impl SubClass<CanvasItem> for ProgressBar

impl SubClass<CanvasItem> for Path2D

impl SubClass<Node> for CanvasItem

impl SubClass<Object> for CanvasItem