Struct gdnative_bindings::ProgressBar

pub struct ProgressBar { /* fields omitted */ }

core class ProgressBar inherits Range (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.

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

Class hierarchy

ProgressBar inherits methods from:

• Range
• Control
• CanvasItem
• Node
• Object

Methods

impl ProgressBar

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn is_percent_visible(&self) -> bool

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

pub unsafe fn to_range(&self) -> Range

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

pub unsafe fn get_as_ratio(&self) -> f64

pub unsafe fn get_max(&self) -> f64

pub unsafe fn get_min(&self) -> f64

pub unsafe fn get_page(&self) -> f64

pub unsafe fn get_step(&self) -> f64

pub unsafe fn get_value(&self) -> f64

pub unsafe fn is_greater_allowed(&self) -> bool

pub unsafe fn is_lesser_allowed(&self) -> bool

pub unsafe fn is_ratio_exp(&self) -> bool

pub unsafe fn is_using_rounded_values(&self) -> bool

pub unsafe fn set_allow_greater(&mut self, allow: bool)

pub unsafe fn set_allow_lesser(&mut self, allow: bool)

pub unsafe fn set_as_ratio(&mut self, value: f64)

pub unsafe fn set_exp_ratio(&mut self, enabled: bool)

pub unsafe fn set_max(&mut self, maximum: f64)

pub unsafe fn set_min(&mut self, minimum: f64)

pub unsafe fn set_page(&mut self, pagesize: f64)

pub unsafe fn set_step(&mut self, step: f64)

pub unsafe fn set_use_rounded_values(&mut self, enabled: bool)

pub unsafe fn set_value(&mut self, value: f64)

pub unsafe fn share(&mut self, with: Option<Node>)

pub unsafe fn unshare(&mut self)

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 ProgressBar

fn clone(&self) -> ProgressBar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ProgressBar

impl Debug for ProgressBar

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

Formats the value using the given formatter.

impl Deref for ProgressBar

type Target = Range

The resulting type after dereferencing.

fn deref(&self) -> &Range

Dereferences the value.

impl DerefMut for ProgressBar

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

Mutably dereferences the value.

impl Free for ProgressBar

unsafe fn godot_free(self)

impl FromVariant for ProgressBar

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

impl GodotObject for ProgressBar

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 ProgressBar

fn construct() -> Self

impl QueueFree for ProgressBar

unsafe fn godot_queue_free(&mut self)

impl ToVariant for ProgressBar

fn to_variant(&self) -> Variant