Struct citro3d::math::Projection

pub struct Projection<Kind> { /* private fields */ }

Configuration for a 3D projection. See specific Kind implementations for constructors, e.g. Projection::perspective and Projection::orthographic.

To use the resulting projection, convert it to a Matrix4 with [From]/[Into].

Implementations

impl<Kind> Projection<Kind>

pub fn coordinates(self, orientation: CoordinateOrientation) -> Self

Set the coordinate system’s orientation for the projection. See CoordinateOrientation for more details.

Example

let clip_planes = ClipPlanes {
    near: 0.1,
    far: 100.0,
};
let mtx: Matrix4 = Projection::perspective(40.0,  AspectRatio::TopScreen, clip_planes)
    .coordinates(CoordinateOrientation::LeftHanded)
    .into();

pub fn screen(self, orientation: ScreenOrientation) -> Self

Set the screen rotation for the projection. See ScreenOrientation for more details.

Example

let clip_planes = ClipPlanes {
    near: 0.1,
    far: 100.0,
};
let mtx: Matrix4 = Projection::perspective(40.0, AspectRatio::TopScreen, clip_planes)
    .screen(ScreenOrientation::None)
    .into();

impl Projection<Perspective>

pub fn perspective( vertical_fov_radians: f32, aspect_ratio: AspectRatio, clip_planes: ClipPlanes ) -> Self

Construct a projection matrix suitable for projecting 3D world space onto the 3DS screens.

Parameters

• vertical_fov: the vertical field of view, measured in radians
• aspect_ratio: the aspect ratio of the projection
• clip_planes: the near and far clip planes of the view frustum. ClipPlanes are always defined by near and far values, regardless of the projection’s CoordinateOrientation.

Examples

let clip_planes = ClipPlanes {
    near: 0.01,
    far: 100.0,
};

let bottom: Matrix4 =
    Projection::perspective(PI / 4.0, AspectRatio::BottomScreen, clip_planes).into();

let top: Matrix4 =
    Projection::perspective(PI / 4.0, AspectRatio::TopScreen, clip_planes).into();

pub fn stereo_matrices( self, left_eye: StereoDisplacement, right_eye: StereoDisplacement ) -> (Matrix4, Matrix4)

Helper function to build both eyes’ perspective projection matrices at once. See StereoDisplacement for details on how to configure stereoscopy.

let (left, right) = StereoDisplacement::new(0.5, 2.0);
let (left_eye, right_eye) = Projection::perspective(
    PI / 4.0,
    AspectRatio::TopScreen,
    ClipPlanes {
        near: 0.01,
        far: 100.0,
    },
)
.stereo_matrices(left, right);

impl Projection<Orthographic>

pub fn orthographic( clip_planes_x: Range<f32>, clip_planes_y: Range<f32>, clip_planes_z: ClipPlanes ) -> Self

Construct an orthographic projection. The X and Y clip planes are passed as ranges because their coordinates are always oriented the same way (+X right, +Y up).

The Z ClipPlanes, however, are always defined by near and far values, regardless of the projection’s CoordinateOrientation.

Example

let mtx: Matrix4 = Projection::orthographic(
    0.0..240.0,
    0.0..400.0,
    ClipPlanes {
        near: 0.0,
        far: 100.0,
    },
)
.into();

Trait Implementations

impl<Kind: Clone> Clone for Projection<Kind>

fn clone(&self) -> Projection<Kind>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Kind: Debug> Debug for Projection<Kind>

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

Formats the value using the given formatter.

impl From<Projection<Orthographic>> for Matrix4

fn from(projection: Projection<Orthographic>) -> Self

Converts to this type from the input type.

impl From<Projection<Perspective>> for Matrix4

fn from(projection: Projection<Perspective>) -> Self

Converts to this type from the input type.