Struct tetra::graphics::scaling::ScreenScaler [−][src]
A wrapper for a Canvas
that handles scaling the image to fit the screen.
Examples
The scaling
example demonstrates how to use a ScreenScaler
with each of the different
scaling algorithms.
Implementations
impl ScreenScaler
[src]
pub fn new(
ctx: &mut Context,
inner_width: i32,
inner_height: i32,
outer_width: i32,
outer_height: i32,
mode: ScalingMode
) -> Result<ScreenScaler>
[src]
ctx: &mut Context,
inner_width: i32,
inner_height: i32,
outer_width: i32,
outer_height: i32,
mode: ScalingMode
) -> Result<ScreenScaler>
Returns a new ScreenScaler
, with the specified inner and outer width and height.
The mode will determine how the image is scaled to fit the screen.
pub fn with_window_size(
ctx: &mut Context,
inner_width: i32,
inner_height: i32,
mode: ScalingMode
) -> Result<ScreenScaler>
[src]
ctx: &mut Context,
inner_width: i32,
inner_height: i32,
mode: ScalingMode
) -> Result<ScreenScaler>
Returns a new ScreenScaler
, with the specified inner width and height, and the outer
size set to the current dimensions of the window.
pub fn draw(&self, ctx: &mut Context)
[src]
Draws the scaled image to the screen.
pub fn set_outer_size(&mut self, outer_width: i32, outer_height: i32)
[src]
Updates the scaler's outer size (i.e. the size of the box that the screen will be scaled to fit within).
pub fn canvas(&self) -> &Canvas
[src]
Returns a reference to the canvas that is being scaled.
pub fn mode(&self) -> ScalingMode
[src]
Returns the current scaling mode.
pub fn set_mode(&mut self, mode: ScalingMode)
[src]
Sets the scaling mode that should be used.
pub fn project(&self, position: Vec2<f32>) -> Vec2<f32>
[src]
Converts a point from window co-ordinates to scaled screen co-ordinates.
pub fn unproject(&self, position: Vec2<f32>) -> Vec2<f32>
[src]
Converts a point from scaled screen co-ordinates to window co-ordinates.
pub fn mouse_position(&self, ctx: &Context) -> Vec2<f32>
[src]
Returns the position of the mouse in scaled screen co-ordinates.
This is a shortcut for calling .project(input::get_mouse_position(ctx))
.
pub fn mouse_x(&self, ctx: &Context) -> f32
[src]
Returns the X co-ordinate of the mouse in scaled screen co-ordinates.
This is a shortcut for calling project(input::get_mouse_position(ctx)).x
.
pub fn mouse_y(&self, ctx: &Context) -> f32
[src]
Returns the Y co-ordinate of the mouse in scaled screen co-ordinates.
This is a shortcut for calling project(input::get_mouse_position(ctx)).y
.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for ScreenScaler
[src]
impl !Send for ScreenScaler
[src]
impl !Sync for ScreenScaler
[src]
impl Unpin for ScreenScaler
[src]
impl !UnwindSafe for ScreenScaler
[src]
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,
pub 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, 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.
pub 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>,