[−][src]Struct gdnative_bindings::ViewportContainer
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:
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
[src]
pub fn new() -> Ref<Self, Unique>
[src]
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
[src]
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
[src]
If [code]true[/code], the viewport will be scaled to the control's size.
pub fn set_stretch(&self, enable: bool)
[src]
If [code]true[/code], the viewport will be scaled to the control's size.
pub fn set_stretch_shrink(&self, amount: i64)
[src]
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
[src]
pub fn fit_child_in_rect(&self, child: impl AsArg<Control>, rect: Rect2)
[src]
Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
pub fn queue_sort(&self)
[src]
Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
Trait Implementations
impl Debug for ViewportContainer
[src]
impl Deref for ViewportContainer
[src]
impl DerefMut for ViewportContainer
[src]
impl GodotObject for ViewportContainer
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for ViewportContainer
[src]
impl QueueFree for ViewportContainer
[src]
unsafe fn godot_queue_free(obj: *mut godot_object)
[src]
impl Sealed for ViewportContainer
[src]
impl SubClass<CanvasItem> for ViewportContainer
[src]
impl SubClass<Container> for ViewportContainer
[src]
impl SubClass<Control> for ViewportContainer
[src]
impl SubClass<Node> for ViewportContainer
[src]
impl SubClass<Object> for ViewportContainer
[src]
Auto Trait Implementations
impl RefUnwindSafe for ViewportContainer
impl !Send for ViewportContainer
impl !Sync for ViewportContainer
impl Unpin for ViewportContainer
impl UnwindSafe for ViewportContainer
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,