Struct gdnative_bindings::VBoxContainer

pub struct VBoxContainer { /* fields omitted */ }

core class VBoxContainer inherits BoxContainer (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.

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

Class hierarchy

VBoxContainer inherits methods from:

• BoxContainer
• Container
• Control
• CanvasItem
• Node
• Object

Methods

impl VBoxContainer

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn to_box_container(&self) -> BoxContainer

Up-cast.

pub unsafe fn to_container(&self) -> Container

Up-cast.

pub unsafe fn to_control(&self) -> Control

Up-cast.

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

pub const ALIGN_CENTER: i64

pub const ALIGN_END: i64

pub const ALIGN_BEGIN: i64

pub unsafe fn add_spacer(&mut self, begin: bool)

pub unsafe fn get_alignment(&self) -> BoxContainerAlignMode

pub unsafe fn set_alignment(&mut self, alignment: i64)

pub unsafe fn to_container(&self) -> Container

Up-cast.

pub unsafe fn to_control(&self) -> Control

Up-cast.

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.

Trait Implementations

impl Clone for VBoxContainer

fn clone(&self) -> VBoxContainer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for VBoxContainer

impl Debug for VBoxContainer

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

Formats the value using the given formatter.

impl Deref for VBoxContainer

type Target = BoxContainer

The resulting type after dereferencing.

fn deref(&self) -> &BoxContainer

Dereferences the value.

impl DerefMut for VBoxContainer

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

Mutably dereferences the value.

impl Free for VBoxContainer

unsafe fn godot_free(self)

impl FromVariant for VBoxContainer

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

impl GodotObject for VBoxContainer

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 VBoxContainer

fn construct() -> Self

impl QueueFree for VBoxContainer

unsafe fn godot_queue_free(&mut self)

impl ToVariant for VBoxContainer

fn to_variant(&self) -> Variant