Enum amethyst_rendy::camera::Projection

[+] Show declaration

pub enum Projection {
    Orthographic(Orthographic),
    Perspective(Perspective),
}

[−] Expand description

The projection mode of a Camera.

TODO: Remove and integrate with Camera.

Variants

Orthographic(Orthographic)

[−] Expand description

An orthographic projection.

Perspective(Perspective)

[−] Expand description

A realistic perspective projection.

Methods

impl Projection[−]

pub fn orthographic(
    left: f32,
    right: f32,
    bottom: f32,
    top: f32,
    z_near: f32,
    z_far: f32
) -> Projection[−]

Creates an orthographic projection with the given left, right, bottom, and top plane distances. The projection matrix is right-handed and has a depth range of 0 to 1

pub fn perspective(aspect: f32, fov: f32, z_near: f32, z_far: f32) -> Projection[−]

Creates a perspective projection with the given aspect ratio and field-of-view. fov is specified in radians. The projection matrix is right-handed and has a depth range of 0 to 1

pub fn as_orthographic(&self) -> Option<&Orthographic>[−]

Returns a reference to this Projection as [Orthographic] if it is in fact an Orthographic projection. Otherwise, None is returned.

pub fn as_orthographic_mut(&mut self) -> Option<&mut Orthographic>[−]

Returns a mutable reference to this Projection as [Orthographic] if it is in fact an Orthographic projection. Otherwise, None is returned.

pub fn as_perspective(&self) -> Option<&Perspective>[−]

Returns a reference to this Projection as [Perspective] if it is in fact a Perspective projection. Otherwise, None is returned.

pub fn as_perspective_mut(&mut self) -> Option<&mut Perspective>[−]

Returns a mutable reference to this Projection as [Perspective] if it is in fact a Perspective projection. Otherwise, None is returned.

pub fn as_matrix(&self) -> &Matrix4<f32>[−]

Returns a reference to the inner matrix represpentation of this projection.

pub fn as_matrix_mut(&mut self) -> &mut Matrix4<f32>[−]

Returns a mutable reference to the inner matrix represpentation of this projection.

pub fn screen_to_world(
    &self,
    screen_position: Point2<f32>,
    screen_diagonal: Vector2<f32>,
    camera_transform: &Transform
) -> Point3<f32>[−]

Transforms position from screen space to camera space

pub fn world_to_screen(
    &self,
    world_position: Point3<f32>,
    screen_diagonal: Vector2<f32>,
    camera_transform: &Transform
) -> Point2<f32>[−]

Translate from world coordinates to screen coordinates

Trait Implementations

impl Clone for Projection[+]

[+] Show hidden undocumented items

fn clone(&self) -> Projection[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl PartialEq<Projection> for Projection[+]

[+] Show hidden undocumented items

fn eq(&self, other: &Projection) -> bool[−]

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

fn ne(&self, other: &Projection) -> bool[−]

This method tests for !=.

impl From<Orthographic> for Projection[+]

[+] Show hidden undocumented items

fn from(proj: Orthographic) -> Self[−]

Performs the conversion.

impl From<Perspective> for Projection[+]

[+] Show hidden undocumented items

fn from(proj: Perspective) -> Self[−]

Performs the conversion.

impl From<Projection> for Camera[+]

[+] Show hidden undocumented items

fn from(proj: Projection) -> Self[−]

Performs the conversion.

impl Debug for Projection[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Serialize for Projection[+]

[+] Show hidden undocumented items

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, [−]

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Projection[+]

[+] Show hidden undocumented items

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.