Struct gdnative::PopupPanel

pub struct PopupPanel { /* fields omitted */ }

core class PopupPanel inherits Popup (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.

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

Class hierarchy

PopupPanel inherits methods from:

• Popup
• Control
• CanvasItem
• Node
• Object

Implementations

impl PopupPanel

pub fn new() -> PopupPanel

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn to_popup(&self) -> Popup

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

Generic dynamic cast.

Methods from Deref<Target = Popup>

pub const NOTIFICATION_POPUP_HIDE: i64

pub const NOTIFICATION_POST_POPUP: i64

pub unsafe fn is_exclusive(&self) -> bool

pub unsafe fn popup(&mut self, bounds: Rect<f32, UnknownUnit>)

pub unsafe fn popup_centered(&mut self, size: Vector2D<f32, UnknownUnit>)

pub unsafe fn popup_centered_clamped(
    &mut self,
    size: Vector2D<f32, UnknownUnit>,
    fallback_ratio: f64
)

pub unsafe fn popup_centered_minsize(
    &mut self,
    minsize: Vector2D<f32, UnknownUnit>
)

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

pub unsafe fn set_as_minsize(&mut self)

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

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

Generic dynamic cast.

Trait Implementations

impl Clone for PopupPanel

fn clone(&self) -> PopupPanel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PopupPanel

impl Debug for PopupPanel

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

Formats the value using the given formatter.

impl Deref for PopupPanel

type Target = Popup

The resulting type after dereferencing.

fn deref(&self) -> &Popup

Dereferences the value.

impl DerefMut for PopupPanel

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

Mutably dereferences the value.

impl Free for PopupPanel

unsafe fn godot_free(self)

impl FromVariant for PopupPanel

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

impl GodotObject for PopupPanel

fn class_name() -> &'static str

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

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

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

unsafe fn claim(&self) -> Self

Creates a wrapper around the same Godot object that has 'static lifetime.

impl Instanciable for PopupPanel

fn construct() -> PopupPanel

impl QueueFree for PopupPanel

unsafe fn godot_queue_free(&mut self)

impl ToVariant for PopupPanel

fn to_variant(&self) -> Variant