Struct gdnative_bindings::Control

pub struct Control { /* fields omitted */ }

core class Control inherits CanvasItem (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.

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

Class hierarchy

Control inherits methods from:

• CanvasItem
• Node
• Object

Methods

impl Control

Constants

pub const CURSOR_CAN_DROP: i64

pub const GROW_DIRECTION_END: i64

pub const SIZE_FILL: i64

pub const CURSOR_HSIZE: i64

pub const CURSOR_VSPLIT: i64

pub const PRESET_CENTER_TOP: i64

pub const CURSOR_BUSY: i64

pub const CURSOR_MOVE: i64

pub const FOCUS_ALL: i64

pub const PRESET_CENTER: i64

pub const CURSOR_BDIAGSIZE: i64

pub const PRESET_BOTTOM_LEFT: i64

pub const SIZE_SHRINK_END: i64

pub const NOTIFICATION_MOUSE_ENTER: i64

pub const CURSOR_VSIZE: i64

pub const GROW_DIRECTION_BEGIN: i64

pub const PRESET_TOP_WIDE: i64

pub const CURSOR_ARROW: i64

pub const NOTIFICATION_FOCUS_ENTER: i64

pub const CURSOR_WAIT: i64

pub const PRESET_VCENTER_WIDE: i64

pub const PRESET_HCENTER_WIDE: i64

pub const ANCHOR_END: i64

pub const PRESET_RIGHT_WIDE: i64

pub const NOTIFICATION_SCROLL_END: i64

pub const MOUSE_FILTER_PASS: i64

pub const NOTIFICATION_MODAL_CLOSE: i64

pub const PRESET_MODE_MINSIZE: i64

pub const NOTIFICATION_SCROLL_BEGIN: i64

pub const PRESET_WIDE: i64

pub const CURSOR_HSPLIT: i64

pub const CURSOR_POINTING_HAND: i64

pub const FOCUS_CLICK: i64

pub const CURSOR_FDIAGSIZE: i64

pub const SIZE_SHRINK_CENTER: i64

pub const NOTIFICATION_FOCUS_EXIT: i64

pub const ANCHOR_BEGIN: i64

pub const MOUSE_FILTER_IGNORE: i64

pub const CURSOR_HELP: i64

pub const FOCUS_NONE: i64

pub const CURSOR_DRAG: i64

pub const PRESET_TOP_LEFT: i64

pub const PRESET_TOP_RIGHT: i64

pub const PRESET_CENTER_RIGHT: i64

pub const MOUSE_FILTER_STOP: i64

pub const PRESET_MODE_KEEP_HEIGHT: i64

pub const NOTIFICATION_THEME_CHANGED: i64

pub const SIZE_EXPAND: i64

pub const PRESET_CENTER_BOTTOM: i64

pub const NOTIFICATION_MOUSE_EXIT: i64

pub const PRESET_LEFT_WIDE: i64

pub const PRESET_MODE_KEEP_WIDTH: i64

pub const CURSOR_CROSS: i64

pub const PRESET_CENTER_LEFT: i64

pub const GROW_DIRECTION_BOTH: i64

pub const PRESET_BOTTOM_WIDE: i64

pub const PRESET_BOTTOM_RIGHT: i64

pub const PRESET_MODE_KEEP_SIZE: i64

pub const CURSOR_FORBIDDEN: i64

pub const CURSOR_IBEAM: i64

pub const NOTIFICATION_RESIZED: i64

pub const SIZE_EXPAND_FILL: i64

impl Control

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _clips_input(&mut self) -> bool

pub unsafe fn _get_minimum_size(&mut self) -> Vector2

pub unsafe fn _get_tooltip(&self) -> GodotString

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

pub unsafe fn _make_custom_tooltip(
    &mut self,
    for_text: GodotString
) -> Option<Object>

pub unsafe fn _override_changed(&mut self)

pub unsafe fn _set_anchor(&mut self, margin: i64, anchor: f64)

pub unsafe fn _size_changed(&mut self)

pub unsafe fn _theme_changed(&mut self)

pub unsafe fn _update_minimum_size(&mut self)

pub unsafe fn accept_event(&mut self)

pub unsafe fn add_color_override(&mut self, name: GodotString, color: Color)

pub unsafe fn add_constant_override(&mut self, name: GodotString, constant: i64)

pub unsafe fn add_font_override(
    &mut self,
    name: GodotString,
    font: Option<Font>
)

pub unsafe fn add_icon_override(
    &mut self,
    name: GodotString,
    texture: Option<Texture>
)

pub unsafe fn add_shader_override(
    &mut self,
    name: GodotString,
    shader: Option<Shader>
)

pub unsafe fn add_stylebox_override(
    &mut self,
    name: GodotString,
    stylebox: Option<StyleBox>
)

pub unsafe fn can_drop_data(&mut self, position: Vector2, data: Variant) -> bool

pub unsafe fn drop_data(&mut self, position: Vector2, data: Variant)

pub unsafe fn force_drag(&mut self, data: Variant, preview: Option<Control>)

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

pub unsafe fn get_begin(&self) -> Vector2

pub unsafe fn get_color(&self, name: GodotString, _type: GodotString) -> Color

pub unsafe fn get_combined_minimum_size(&self) -> Vector2

pub unsafe fn get_constant(&self, name: GodotString, _type: GodotString) -> i64

pub unsafe fn get_cursor_shape(&self, position: Vector2) -> ControlCursorShape

pub unsafe fn get_custom_minimum_size(&self) -> Vector2

pub unsafe fn get_default_cursor_shape(&self) -> ControlCursorShape

pub unsafe fn get_drag_data(&mut self, position: Vector2) -> Option<Object>

pub unsafe fn get_end(&self) -> Vector2

pub unsafe fn get_focus_mode(&self) -> ControlFocusMode

pub unsafe fn get_focus_neighbour(&self, margin: i64) -> NodePath

pub unsafe fn get_focus_next(&self) -> NodePath

pub unsafe fn get_focus_owner(&self) -> Option<Control>

pub unsafe fn get_focus_previous(&self) -> NodePath

pub unsafe fn get_font(
    &self,
    name: GodotString,
    _type: GodotString
) -> Option<Font>

pub unsafe fn get_global_position(&self) -> Vector2

pub unsafe fn get_global_rect(&self) -> Rect2

pub unsafe fn get_h_grow_direction(&self) -> ControlGrowDirection

pub unsafe fn get_h_size_flags(&self) -> i64

pub unsafe fn get_icon(
    &self,
    name: GodotString,
    _type: GodotString
) -> Option<Texture>

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

pub unsafe fn get_minimum_size(&self) -> Vector2

pub unsafe fn get_mouse_filter(&self) -> ControlMouseFilter

pub unsafe fn get_parent_area_size(&self) -> Vector2

pub unsafe fn get_parent_control(&self) -> Option<Control>

pub unsafe fn get_pivot_offset(&self) -> Vector2

pub unsafe fn get_position(&self) -> Vector2

pub unsafe fn get_rect(&self) -> Rect2

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_size(&self) -> Vector2

pub unsafe fn get_stretch_ratio(&self) -> f64

pub unsafe fn get_stylebox(
    &self,
    name: GodotString,
    _type: GodotString
) -> Option<StyleBox>

pub unsafe fn get_theme(&self) -> Option<Theme>

pub unsafe fn get_tooltip(&self, at_position: Vector2) -> GodotString

pub unsafe fn get_v_grow_direction(&self) -> ControlGrowDirection

pub unsafe fn get_v_size_flags(&self) -> i64

pub unsafe fn grab_click_focus(&mut self)

pub unsafe fn grab_focus(&mut self)

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

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

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

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

pub unsafe fn has_focus(&self) -> bool

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

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

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

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

pub unsafe fn has_point(&mut self, point: Vector2) -> bool

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

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

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

pub unsafe fn is_clipping_contents(&mut self) -> bool

pub unsafe fn minimum_size_changed(&mut self)

pub unsafe fn release_focus(&mut self)

pub unsafe fn set_anchor(
    &mut self,
    margin: i64,
    anchor: f64,
    keep_margin: bool,
    push_opposite_anchor: bool
)

pub unsafe fn set_anchor_and_margin(
    &mut self,
    margin: i64,
    anchor: f64,
    offset: f64,
    push_opposite_anchor: bool
)

pub unsafe fn set_anchors_and_margins_preset(
    &mut self,
    preset: i64,
    resize_mode: i64,
    margin: i64
)

pub unsafe fn set_anchors_preset(&mut self, preset: i64, keep_margin: bool)

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

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

pub unsafe fn set_custom_minimum_size(&mut self, size: Vector2)

pub unsafe fn set_default_cursor_shape(&mut self, shape: i64)

pub unsafe fn set_drag_forwarding(&mut self, target: Option<Control>)

pub unsafe fn set_drag_preview(&mut self, control: Option<Control>)

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

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

pub unsafe fn set_focus_neighbour(&mut self, margin: i64, neighbour: NodePath)

pub unsafe fn set_focus_next(&mut self, next: NodePath)

pub unsafe fn set_focus_previous(&mut self, previous: NodePath)

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

pub unsafe fn set_h_grow_direction(&mut self, direction: i64)

pub unsafe fn set_h_size_flags(&mut self, flags: i64)

pub unsafe fn set_margin(&mut self, margin: i64, offset: f64)

pub unsafe fn set_margins_preset(
    &mut self,
    preset: i64,
    resize_mode: i64,
    margin: i64
)

pub unsafe fn set_mouse_filter(&mut self, filter: i64)

pub unsafe fn set_pivot_offset(&mut self, pivot_offset: Vector2)

pub unsafe fn set_position(&mut self, position: 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_size(&mut self, size: Vector2)

pub unsafe fn set_stretch_ratio(&mut self, ratio: f64)

pub unsafe fn set_theme(&mut self, theme: Option<Theme>)

pub unsafe fn set_tooltip(&mut self, tooltip: GodotString)

pub unsafe fn set_v_grow_direction(&mut self, direction: i64)

pub unsafe fn set_v_size_flags(&mut self, flags: i64)

pub unsafe fn show_modal(&mut self, exclusive: bool)

pub unsafe fn warp_mouse(&mut self, to_position: Vector2)

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

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

pub const BLEND_MODE_SUB: i64

pub const BLEND_MODE_ADD: i64

pub const BLEND_MODE_DISABLED: i64

pub const BLEND_MODE_MIX: i64

pub const NOTIFICATION_EXIT_CANVAS: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub const BLEND_MODE_MUL: i64

pub const BLEND_MODE_PREMULT_ALPHA: i64

pub const NOTIFICATION_DRAW: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_ENTER_CANVAS: i64

pub unsafe fn _draw(&mut self)

pub unsafe fn _edit_get_pivot(&self) -> Vector2

pub unsafe fn _edit_get_position(&self) -> Vector2

pub unsafe fn _edit_get_rect(&self) -> Rect2

pub unsafe fn _edit_get_rotation(&self) -> f64

pub unsafe fn _edit_get_scale(&self) -> Vector2

pub unsafe fn _edit_get_state(&self) -> Dictionary

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

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

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

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

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

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_char(
    &mut self,
    font: Option<Font>,
    position: Vector2,
    char: GodotString,
    next: GodotString,
    modulate: Color
) -> f64

pub unsafe fn draw_circle(
    &mut self,
    position: Vector2,
    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: Vector2,
    to: Vector2,
    color: Color,
    width: f64,
    antialiased: bool
)

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

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: Rect2, color: Color, filled: bool)

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 draw_string(
    &mut self,
    font: Option<Font>,
    position: Vector2,
    text: GodotString,
    modulate: Color,
    clip_w: i64
)

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

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

pub unsafe fn get_global_mouse_position(&self) -> Vector2

pub unsafe fn get_global_transform(&self) -> Transform2D

pub unsafe fn get_global_transform_with_canvas(&self) -> Transform2D

pub unsafe fn get_light_mask(&self) -> i64

pub unsafe fn get_local_mouse_position(&self) -> Vector2

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

pub unsafe fn get_use_parent_material(&self) -> bool

pub unsafe fn get_viewport_rect(&self) -> Rect2

pub unsafe fn get_viewport_transform(&self) -> Transform2D

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: Vector2
) -> Vector2

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: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for Control

fn clone(&self) -> Control

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Control

impl Debug for Control

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

Formats the value using the given formatter.

impl Deref for Control

type Target = CanvasItem

The resulting type after dereferencing.

fn deref(&self) -> &CanvasItem

Dereferences the value.

impl DerefMut for Control

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

Mutably dereferences the value.

impl Free for Control

unsafe fn godot_free(self)

impl FromVariant for Control

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

impl GodotObject for Control

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 Control

fn construct() -> Self

impl QueueFree for Control

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Control

fn to_variant(&self) -> Variant