Struct thin_engine::prelude::Vec2

pub struct Vec2 {
    pub x: f32,
    pub y: f32,
}

a vector made from a x and y coordinate.

Fields

x: f32

y: f32

Implementations

impl Vec2

pub const ZERO: Vec2 = _

a zero vector

pub const ONE: Vec2 = _

a vector full of ones

pub const X: Vec2 = _

the x axis

pub const Y: Vec2 = _

the y axis

pub fn new(x: f32, y: f32) -> Vec2

pub fn extend(self, z: f32) -> Vec3

pub fn truncate(self) -> f32

pub fn splat(value: f32) -> Vec2

create a vector where x and y equals value.

pub fn length_squared(self) -> f32

the length of the vector before being square rooted.

pub fn length(self) -> f32

length of the vector.

pub fn distance_squared(self, other: Vec2) -> f32

distance between two vectors before being square rooted.

pub fn distance(self, other: Vec2) -> f32

distance between two vectors.

pub fn dot(self, other: Vec2) -> f32

get the dot product of 2 vectors. equal to the cosign of the angle between vectors.

pub fn scale(self, scalar: f32) -> Vec2

multiplies each value by the scalar.

Examples found in repository

examples/simple.rs (line 69)

fn main() {
    use Action::*;
    let (event_loop, window, display) = thin_engine::set_up().unwrap();
    window.set_title("Walk Test");
    let _ = window.set_cursor_grab(CursorGrabMode::Locked);
    window.set_cursor_visible(false);

    let mut input = InputMap::new([
        (vec![Input::keycode(KeyCode::Space)], Jump),
        (vec![Input::keycode(KeyCode::ArrowLeft), Input::keycode(KeyCode::KeyA)], Left),
        (vec![Input::keycode(KeyCode::ArrowRight), Input::keycode(KeyCode::KeyD)], Right),
        (vec![Input::keycode(KeyCode::ArrowUp), Input::keycode(KeyCode::KeyW)], Forward),
        (vec![Input::keycode(KeyCode::ArrowDown), Input::keycode(KeyCode::KeyS)], Back)
    ]);

    let (indices, verts, norms) = mesh!(
        &display, &teapot::INDICES, &teapot::VERTICES, &teapot::NORMALS
    );
    let draw_parameters = DrawParameters {
        backface_culling: draw_parameters::BackfaceCullingMode::CullClockwise,
        ..params::alias_3d()
    };
    let program = Program::from_source(
        &display, shaders::VERTEX,
        "#version 140
        out vec4 colour;
        in vec3 v_normal;
        uniform vec3 light;

        const vec3 albedo = vec3(0.1, 1.0, 0.3);
        void main(){
            float light_level = dot(light, v_normal);
            colour = vec4(albedo * light_level, 1.0);
        }", None,
    ).unwrap();

    let mut pos = vec3(0.0, 0.0, -30.0);
    let mut rot = vec2(0.0, 0.0);
    let mut gravity = 0.0;

    const DELTA: f32 = 0.016;

    thin_engine::run(event_loop, &mut input, |input| {
        display.resize(window.inner_size().into());
        let mut frame = display.draw();
        let view = Mat4::view_matrix_3d(frame.get_dimensions(), 1.0, 1024.0, 0.1);

        //handle gravity and jump
        gravity += DELTA * 9.5;
        if input.pressed(Jump) {
            gravity = -10.0;
        }

        //set camera rotation
        rot += input.mouse_move.scale(DELTA * 2.0);
        rot.y = rot.y.clamp(-PI / 2.0, PI / 2.0);
        let rx = Quaternion::from_y_rotation(rot.x);
        let ry = Quaternion::from_x_rotation(rot.y);
        let rot = rx * ry;

        //move player based on view and gravity
        let x = input.axis(Right, Left);
        let y = input.axis(Forward, Back);
        let move_dir = vec3(x, 0.0, y).normalise();
        pos += move_dir.transform(&Mat3::from_rot(rx)).scale(5.0 * DELTA);
        pos.y = (pos.y - gravity * DELTA).max(0.0);

        frame.clear_color_and_depth((0.0, 0.0, 0.0, 1.0), 1.0);
        //draw teapot
        frame.draw(
            (&verts, &norms), &indices,
            &program, &uniform! {
                view: view,
                model: Mat4::from_scale(Vec3::splat(0.1)),
                camera: Mat4::from_inverse_transform(pos, Vec3::ONE, rot),
                light: vec3(1.0, -0.9, -1.0).normalise()
            },
            &draw_parameters,
        ).unwrap();

        frame.finish().unwrap();
        thread::sleep(Duration::from_millis(16));
    }).unwrap();
}

examples/simple-fxaa.rs (line 105)

fn main() {
    use Action::*;
    let (event_loop, window, display) = thin_engine::set_up().unwrap();
    window.set_title("FXAA Test");
    let _ = window.set_cursor_grab(CursorGrabMode::Locked);
    window.set_cursor_visible(false);

    let mut colour = ResizableTexture2D::default();
    let mut depth = ResizableDepthTexture2D::default();

    let mut input = InputMap::new([
        (vec![Input::keycode(KeyCode::ArrowLeft), Input::keycode(KeyCode::KeyA)], Left),
        (vec![Input::keycode(KeyCode::ArrowRight), Input::keycode(KeyCode::KeyD)], Right),
        (vec![Input::keycode(KeyCode::ArrowUp), Input::keycode(KeyCode::KeyW)], Forward),
        (vec![Input::keycode(KeyCode::ArrowDown), Input::keycode(KeyCode::KeyS)], Back),
        (vec![Input::keycode(KeyCode::KeyF)], FXAA),
        (vec![Input::keycode(KeyCode::Space)], Jump)
    ]);
    let (screen_indices, verts, uvs) = mesh!(
        &display, &screen::INDICES, &screen::VERTICES, &screen::UVS
    );
    let screen_mesh = (&verts, &uvs);
    let (indices, verts, norms) = mesh!(
        &display, &teapot::INDICES, &teapot::VERTICES, &teapot::NORMALS
    );
    let teapot_mesh = (&verts, &norms);
    let draw_parameters = DrawParameters {
        backface_culling: draw_parameters::BackfaceCullingMode::CullClockwise,
        ..params::alias_3d()
    };
    let mut fxaa_on = true;
    let program = Program::from_source(
        &display, shaders::VERTEX,
        "#version 140
        out vec4 colour;
        in vec3 v_normal;
        uniform vec3 light;
        uniform mat4 camera;
        uniform vec3 ambient;
        uniform vec3 albedo;
        uniform float shine;
        void main() {
            vec3 camera_dir = inverse(mat3(camera)) * vec3(0, 0, -1);
            vec3 half_dir = normalize(camera_dir + light);
            float specular = pow(max(dot(half_dir, v_normal), 0.0), shine);
            float light_level = max(dot(light, v_normal), 0.0);
            colour = vec4(albedo * light_level + ambient + vec3(specular), 1.0);
        }", None
    ).unwrap();
    let fxaa = shaders::fxaa_shader(&display).unwrap();
    let normal = Program::from_source(
        &display, shaders::SCREEN_VERTEX, 
        "#version 140
        in vec2 uv;
        uniform sampler2D tex;
        out vec4 colour;
        void main() {
            colour = texture(tex, uv);
        }", None
    ).unwrap();

    let mut pos = vec3(0.0, 0.0, -30.0);
    let mut rot = vec2(0.0, 0.0);
    const DELTA: f32 = 0.016;

    thin_engine::run(event_loop, &mut input, |input| {
        // using a small resolution to show the effect.
        // `let size = window.inner_size().into();` 
        // can be used isntead to set resolution to window size
        let size = (380, 216);
        display.resize(size);
        depth.resize_to_display(&display);
        colour.resize_to_display(&display);

        //press f to toggle FXAA
        if input.pressed(FXAA) { fxaa_on = !fxaa_on }

        let colour = colour.texture.as_ref().unwrap();
        let depth = depth.texture.as_ref().unwrap();
        let mut frame = SimpleFrameBuffer::with_depth_buffer(
            &display, colour, depth
        ).unwrap();

        let view = Mat4::view_matrix_3d(size, 1.0, 1024.0, 0.1);        
        //set camera rotation
        rot += input.mouse_move.scale(DELTA * 2.0);
        rot.y = rot.y.clamp(-PI / 2.0, PI / 2.0);
        let rx = Quaternion::from_y_rotation(rot.x);
        let ry = Quaternion::from_x_rotation(rot.y);
        let rot = rx * ry;

        //move player based on view
        let x = input.axis(Right, Left);
        let y = input.axis(Forward, Back);
        let move_dir = vec3(x, 0.0, y).normalise().scale(5.0*DELTA);
        pos += move_dir.transform(&Mat3::from_rot(rx));

        frame.clear_color_and_depth((0.0, 0.0, 0.0, 1.0), 1.0);
        //draw teapot
        frame.draw(
            teapot_mesh, &indices,
            &program, &uniform! {
                view: view,
                model: Mat4::from_scale(Vec3::splat(0.1)),
                camera: Mat4::from_inverse_transform(pos, Vec3::ONE, rot),
                light: vec3(0.1, 0.25, -1.0).normalise(),
                albedo: vec3(0.5, 0.1, 0.4),
                ambient: vec3(0.0, 0.05, 0.1),
                shine: 10.0f32,
            },
            &draw_parameters,
        ).unwrap();

        let mut frame = display.draw();
        frame.draw(
            screen_mesh, &screen_indices, if fxaa_on { &fxaa } else { &normal },
            &shaders::fxaa_uniforms(colour), &DrawParameters::default()
        ).unwrap();
        frame.finish().unwrap();
        thread::sleep(Duration::from_millis(16));
    }).unwrap();
}

pub fn normalise(self) -> Vec2

makes the length of the vector equal to 1. on fail returns vec2 of zeros

pub fn transform(self, matrix: &Mat2) -> Vec2

transforms vector by the matrix

Trait Implementations

impl Add for Vec2

fn add(self, rhs: Vec2) -> <Vec2 as Add>::Output

Performs the + operation.

type Output = Vec2

The resulting type after applying the + operator.

impl AddAssign for Vec2

fn add_assign(&mut self, rhs: Vec2)

Performs the += operation.

impl AsUniformValue for Vec2

fn as_uniform_value(&self) -> UniformValue<'_>

Builds a UniformValue.

impl Clone for Vec2

fn clone(&self) -> Vec2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Div for Vec2

fn div(self, rhs: Vec2) -> <Vec2 as Div>::Output

Performs the / operation.

type Output = Vec2

The resulting type after applying the / operator.

impl DivAssign for Vec2

fn div_assign(&mut self, rhs: Vec2)

Performs the /= operation.

impl From<[f32; 2]> for Vec2

fn from(value: [f32; 2]) -> Vec2

Converts to this type from the input type.

impl From<(f32, f32)> for Vec2

fn from(value: (f32, f32)) -> Vec2

Converts to this type from the input type.

impl From<Vec2> for DVec2

fn from(value: Vec2) -> DVec2

Converts to this type from the input type.

impl From<Vec2> for IVec2

fn from(value: Vec2) -> IVec2

Converts to this type from the input type.

impl Mul for Vec2

fn mul(self, rhs: Vec2) -> <Vec2 as Mul>::Output

Performs the * operation.

type Output = Vec2

The resulting type after applying the * operator.

impl MulAssign for Vec2

fn mul_assign(&mut self, rhs: Vec2)

Performs the *= operation.

impl Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> <Vec2 as Neg>::Output

Performs the unary - operation.

impl PartialEq for Vec2

fn eq(&self, other: &Vec2) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Vec2

fn partial_cmp(&self, other: &Vec2) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem for Vec2

fn rem(self, rhs: Vec2) -> <Vec2 as Rem>::Output

Performs the % operation.

type Output = Vec2

The resulting type after applying the % operator.

impl RemAssign for Vec2

fn rem_assign(&mut self, rhs: Vec2)

Performs the %= operation.

impl Sub for Vec2

fn sub(self, rhs: Vec2) -> <Vec2 as Sub>::Output

Performs the - operation.

type Output = Vec2

The resulting type after applying the - operator.

impl SubAssign for Vec2

fn sub_assign(&mut self, rhs: Vec2)

Performs the -= operation.

impl Copy for Vec2

impl StructuralPartialEq for Vec2