Struct gdnative::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

Methods

impl CanvasItem

Constants

pub const BLEND_MODE_ADD: i64

pub const BLEND_MODE_MUL: i64

pub const BLEND_MODE_MIX: i64

pub const BLEND_MODE_DISABLED: i64

pub const NOTIFICATION_ENTER_CANVAS: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const BLEND_MODE_SUB: i64

pub const BLEND_MODE_PREMULT_ALPHA: i64

pub const NOTIFICATION_EXIT_CANVAS: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub const NOTIFICATION_DRAW: i64

impl CanvasItem

pub unsafe fn _draw(&mut self)

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

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

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

pub unsafe fn _edit_get_rotation(&self) -> f64

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

pub unsafe fn _edit_get_state(&self) -> Dictionary

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

pub unsafe fn _edit_set_pivot(&mut self, pivot: Vector2D<f32, UnknownUnit>)

pub unsafe fn _edit_set_position(
    &mut self,
    position: Vector2D<f32, UnknownUnit>
)

pub unsafe fn _edit_set_rect(&mut self, rect: Rect<f32, UnknownUnit>)

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

pub unsafe fn _edit_set_scale(&mut self, scale: Vector2D<f32, UnknownUnit>)

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

pub unsafe fn _edit_use_pivot(&self) -> bool

pub unsafe fn _edit_use_rect(&self) -> bool

pub unsafe fn _edit_use_rotation(&self) -> bool

pub unsafe fn _is_on_top(&self) -> bool

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

pub unsafe fn _toplevel_raise_self(&mut self)

pub unsafe fn _update_callback(&mut self)

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

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

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

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_line(
    &mut self,
    from: Vector2D<f32, UnknownUnit>,
    to: Vector2D<f32, UnknownUnit>,
    color: Color,
    width: f64,
    antialiased: bool
)

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

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_multimesh(
    &mut self,
    multimesh: Option<MultiMesh>,
    texture: Option<Texture>,
    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_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_primitive(
    &mut self,
    points: Vector2Array,
    colors: ColorArray,
    uvs: Vector2Array,
    texture: Option<Texture>,
    width: f64,
    normal_map: Option<Texture>
)

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

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

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

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

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

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

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

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

pub unsafe fn force_update_transform(&mut self)

pub unsafe fn get_canvas(&self) -> Rid

pub unsafe fn get_canvas_item(&self) -> Rid

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

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

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

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

pub unsafe fn get_light_mask(&self) -> i64

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

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

pub unsafe fn get_modulate(&self) -> Color

pub unsafe fn get_self_modulate(&self) -> Color

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

pub unsafe fn get_use_parent_material(&self) -> bool

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

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

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

pub unsafe fn hide(&mut self)

pub unsafe fn is_draw_behind_parent_enabled(&self) -> bool

pub unsafe fn is_local_transform_notification_enabled(&self) -> bool

pub unsafe fn is_set_as_toplevel(&self) -> bool

pub unsafe fn is_transform_notification_enabled(&self) -> bool

pub unsafe fn is_visible(&self) -> bool

pub unsafe fn is_visible_in_tree(&self) -> bool

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

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

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

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

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

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

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

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

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

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

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

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

pub unsafe fn show(&mut self)

pub unsafe fn update(&mut self)

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = Node>

pub const NOTIFICATION_PATH_CHANGED: i64

pub const NOTIFICATION_WM_FOCUS_IN: i64

pub const NOTIFICATION_PHYSICS_PROCESS: i64

pub const NOTIFICATION_INTERNAL_PHYSICS_PROCESS: i64

pub const NOTIFICATION_WM_MOUSE_EXIT: i64

pub const DUPLICATE_SCRIPTS: i64

pub const NOTIFICATION_APP_RESUMED: i64

pub const NOTIFICATION_WM_ABOUT: i64

pub const NOTIFICATION_APP_PAUSED: i64

pub const NOTIFICATION_UNPARENTED: i64

pub const NOTIFICATION_WM_FOCUS_OUT: i64

pub const NOTIFICATION_TRANSLATION_CHANGED: i64

pub const NOTIFICATION_OS_IME_UPDATE: i64

pub const NOTIFICATION_INSTANCED: i64

pub const NOTIFICATION_DRAG_BEGIN: i64

pub const NOTIFICATION_READY: i64

pub const NOTIFICATION_UNPAUSED: i64

pub const PAUSE_MODE_INHERIT: i64

pub const PAUSE_MODE_STOP: i64

pub const NOTIFICATION_WM_UNFOCUS_REQUEST: i64

pub const DUPLICATE_GROUPS: i64

pub const NOTIFICATION_CRASH: i64

pub const NOTIFICATION_INTERNAL_PROCESS: i64

pub const NOTIFICATION_DRAG_END: i64

pub const DUPLICATE_USE_INSTANCING: i64

pub const NOTIFICATION_PROCESS: i64

pub const DUPLICATE_SIGNALS: i64

pub const NOTIFICATION_EXIT_TREE: i64

pub const NOTIFICATION_WM_QUIT_REQUEST: i64

pub const NOTIFICATION_MOVED_IN_PARENT: i64

pub const NOTIFICATION_OS_MEMORY_WARNING: i64

pub const NOTIFICATION_PAUSED: i64

pub const NOTIFICATION_PARENTED: i64

pub const NOTIFICATION_ENTER_TREE: i64

pub const NOTIFICATION_WM_MOUSE_ENTER: i64

pub const PAUSE_MODE_PROCESS: i64

pub const NOTIFICATION_WM_GO_BACK_REQUEST: 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_editor_description(&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_editor_description(
    &mut self,
    editor_description: GodotString
)

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_process_priority(&self) -> i64

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 update_configuration_warning(&mut self)

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

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

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

fn from_variant(variant: &Variant) -> Result<CanvasItem, FromVariantError>

impl GodotObject for CanvasItem

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> CanvasItem

unsafe fn from_return_position_sys(obj: *mut c_void) -> CanvasItem

unsafe fn to_sys(&self) -> *mut c_void

impl QueueFree for CanvasItem

unsafe fn godot_queue_free(&mut self)

impl ToVariant for CanvasItem

fn to_variant(&self) -> Variant