Struct tetra::graphics::scaling::ScreenScaler

pub struct ScreenScaler { /* fields omitted */ }

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

pub fn new(
    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>

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)

Draws the scaled image to the screen.

pub fn set_outer_size(&mut self, outer_width: i32, outer_height: i32)

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

Returns a reference to the canvas that is being scaled.

pub fn mode(&self) -> ScalingMode

Returns the current scaling mode.

pub fn set_mode(&mut self, mode: ScalingMode)

Sets the scaling mode that should be used.

pub fn project(&self, position: Vec2<f32>) -> Vec2<f32>

Converts a point from window co-ordinates to scaled screen co-ordinates.

pub fn unproject(&self, position: Vec2<f32>) -> Vec2<f32>

Converts a point from scaled screen co-ordinates to window co-ordinates.

pub fn mouse_position(&self, ctx: &Context) -> Vec2<f32>

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

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

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

impl Debug for ScreenScaler

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

Formats the value using the given formatter.