Skip to main content

Viewport

Struct Viewport 

Source
pub struct Viewport {
    pub origin: Vec2,
    pub size: Vec2,
    pub logical_size: Vec2,
    pub scale: f32,
}
Expand description

A fitted content rectangle measured in logical window coordinates.

Fields§

§origin: Vec2

Top-left corner of the content, excluding letterbox bars.

§size: Vec2

Content dimensions in logical window coordinates.

§logical_size: Vec2

Content dimensions in game/UI units.

§scale: f32

Window logical pixels per UI unit.

Implementations§

Source§

impl Viewport

Source

pub fn new(window: Vec2, reference: Vec2, mode: ScaleMode) -> Option<Self>

Computes a viewport. Returns None for minimized or invalid dimensions.

Source

pub fn aspect(&self) -> f32

Aspect ratio seen by the camera and renderer.

Source

pub fn screen_to_ui(&self, screen: Vec2) -> Option<Vec2>

Converts a pointer to UI units, rejecting points inside the bars.

Source

pub fn ui_to_screen(&self, ui: Vec2) -> Vec2

Converts UI units to logical window coordinates.

Source

pub fn render_size(&self, dpi: Vec2) -> (u32, u32)

Target pixel dimensions at the given framebuffer scale, rounded and bounded.

Trait Implementations§

Source§

impl Clone for Viewport

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Viewport

Source§

impl Debug for Viewport

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Component for T
where T: Send + Sync + 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.