Struct amethyst_rendy::camera::Camera

pub struct Camera { /* fields omitted */ }

Camera struct.

Contains a projection matrix to convert from world/eye-space into normalized device coordinates. For rendy/gfx-hal these are y-down, x-right and y-away in range [0; 1]

World Coordinate system +y | +z | / |/___+x

NDC system +z / |¯¯¯+x | +y

Methods

impl Camera

pub fn standard_2d(width: f32, height: f32) -> Self

Create a normalized camera for 2D.

Will use an orthographic projection centered around (0, 0) of size (width, height) Bottom left corner is (-width/2.0, -height/2.0) View transformation will be multiplicative identity.

pub fn standard_3d(width: f32, height: f32) -> Self

Create a standard camera for 3D.

Will use a perspective projection with aspect from the given screen dimensions and a field of view of π/3 radians (60 degrees). View transformation will be multiplicative identity.

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

Returns a reference to the inner Projection matrix of this camera.

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

Returns a mutable reference to the inner Projection matrix of this camera.

pub fn projection(&self) -> &Projection

Returns a reference to the inner [Projection] of this camera.

pub fn projection_mut(&mut self) -> &mut Projection

Returns a mutable reference to the inner [Projection] of this camera.

pub fn set_projection(&mut self, new: Projection)

Sets the inner [Projection] of this camera.

Trait Implementations

impl Clone for Camera

fn clone(&self) -> Camera

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Camera> for Camera

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

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

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

This method tests for !=.

impl From<Projection> for Camera

fn from(proj: Projection) -> Self

Performs the conversion.

impl Debug for Camera

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

Formats the value using the given formatter.

impl Serialize for Camera

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 Camera

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

Deserialize this value from the given Serde deserializer.

impl Component for Camera

type Storage = HashMapStorage<Self>

Associated storage type for this component.