Struct gdnative::PopupDialog

pub struct PopupDialog { /* fields omitted */ }

core class PopupDialog 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.

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

Class hierarchy

PopupDialog inherits methods from:

• Popup
• Control
• CanvasItem
• Node
• Object

Methods

impl PopupDialog

pub fn new() -> PopupDialog

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

fn clone(&self) -> PopupDialog

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PopupDialog

impl Debug for PopupDialog

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

Formats the value using the given formatter.

impl Deref for PopupDialog

type Target = Popup

The resulting type after dereferencing.

fn deref(&self) -> &Popup

Dereferences the value.

impl DerefMut for PopupDialog

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

Mutably dereferences the value.

impl Free for PopupDialog

unsafe fn godot_free(self)

impl FromVariant for PopupDialog

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

impl GodotObject for PopupDialog

fn class_name() -> &'static str

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

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

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

impl Instanciable for PopupDialog

fn construct() -> PopupDialog

impl QueueFree for PopupDialog

unsafe fn godot_queue_free(&mut self)

impl ToVariant for PopupDialog

fn to_variant(&self) -> Variant