Struct gdnative::api::ViewportContainer

pub struct ViewportContainer { /* fields omitted */ }

core class ViewportContainer inherits Container (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.

ViewportContainer is a reference-only type. Persistent references can only exist in the unsafe Ref<ViewportContainer> form.

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 Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

ViewportContainer inherits methods from:

• Container
• Control
• CanvasItem
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl ViewportContainer

pub fn new() -> Ref<ViewportContainer, Unique>

Creates a new instance of this object.

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 Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn stretch_shrink(&self) -> i64

Divides the viewport's effective resolution by this value while preserving its scale. This can be used to speed up rendering.
			For example, a 1280×720 viewport with [member stretch_shrink] set to [code]2[/code] will be rendered at 640×360 while occupying the same size in the container.
			[b]Note:[/b] [member stretch] must be [code]true[/code] for this property to work.

pub fn is_stretch_enabled(&self) -> bool

If [code]true[/code], the viewport will be scaled to the control's size.

pub fn set_stretch(&self, enable: bool)

If [code]true[/code], the viewport will be scaled to the control's size.

pub fn set_stretch_shrink(&self, amount: i64)

Divides the viewport's effective resolution by this value while preserving its scale. This can be used to speed up rendering.
			For example, a 1280×720 viewport with [member stretch_shrink] set to [code]2[/code] will be rendered at 640×360 while occupying the same size in the container.
			[b]Note:[/b] [member stretch] must be [code]true[/code] for this property to work.

Methods from Deref<Target = Container>

pub const NOTIFICATION_SORT_CHILDREN: i64

pub fn fit_child_in_rect(
    &self,
    child: impl AsArg<Control>,
    rect: Rect<f32, UnknownUnit>
)

Fit a child control in a given rect. This is mainly a helper for creating custom container classes.

pub fn queue_sort(&self)

Queue resort of the contained children. This is called automatically anyway, but can be called upon request.

Trait Implementations

impl Debug for ViewportContainer

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

Formats the value using the given formatter.

impl Deref for ViewportContainer

type Target = Container

The resulting type after dereferencing.

fn deref(&self) -> &Container

Dereferences the value.

impl DerefMut for ViewportContainer

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

Mutably dereferences the value.

impl GodotObject for ViewportContainer

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for ViewportContainer

fn construct() -> Ref<ViewportContainer, Unique>

impl QueueFree for ViewportContainer

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for ViewportContainer

impl SubClass<Container> for ViewportContainer

impl SubClass<Control> for ViewportContainer

impl SubClass<Node> for ViewportContainer

impl SubClass<Object> for ViewportContainer