Struct Camera

pub struct Camera { /* private fields */ }

A camera used for transforming the stage during rendering.

• Use Stage::new_camera to create a new camera.
• Use Stage::use_camera to set a camera on the stage.

Note

Clones of this type all point to the same underlying data.

Implementations

impl Camera

pub fn new(slab: &SlabAllocator<impl IsRuntime>) -> Self

Stage a new camera on the given slab.

pub fn id(&self) -> Id<CameraDescriptor>

Returns a pointer to the underlying descriptor on the GPU.

pub fn descriptor(&self) -> CameraDescriptor

Returns a copy of the underlying descriptor.

pub fn set_default_perspective(&self, width: f32, height: f32) -> &Self

Set the camera to a default perspective projection and view based on the width and height of the viewport.

The default projection and view matrices are defined as:

use glam::*;

let width = 800.0;
let height = 600.0;
let aspect = width / height;
let fovy = core::f32::consts::PI / 4.0;
let znear = 0.1;
let zfar = 100.0;
let projection = Mat4::perspective_rh(fovy, aspect, znear, zfar);
let eye = Vec3::new(0.0, 12.0, 20.0);
let target = Vec3::ZERO;
let up = Vec3::Y;
let view = Mat4::look_at_rh(eye, target, up);
assert_eq!(renderling::camera::default_perspective(width, height), (projection, view));

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

Set the camera to a default perspective projection and view based on the width and height of the viewport.

The default projection and view matrices are defined as:

use glam::*;

let width = 800.0;
let height = 600.0;
let aspect = width / height;
let fovy = core::f32::consts::PI / 4.0;
let znear = 0.1;
let zfar = 100.0;
let projection = Mat4::perspective_rh(fovy, aspect, znear, zfar);
let eye = Vec3::new(0.0, 12.0, 20.0);
let target = Vec3::ZERO;
let up = Vec3::Y;
let view = Mat4::look_at_rh(eye, target, up);
assert_eq!(renderling::camera::default_perspective(width, height), (projection, view));

pub fn set_default_ortho2d(&self, width: f32, height: f32) -> &Self

Set the camera to a default orthographic 2d projection and view based on the width and height of the viewport.

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

Set the camera to a default orthographic 2d projection and view based on the width and height of the viewport.

pub fn set_projection_and_view( &self, projection: impl Into<Mat4>, view: impl Into<Mat4>, ) -> &Self

Set the projection and view matrices of this camera.

pub fn with_projection_and_view( self, projection: impl Into<Mat4>, view: impl Into<Mat4>, ) -> Self

Set the projection and view matrices and return this camera.

pub fn projection_and_view(&self) -> (Mat4, Mat4)

Returns the projection and view matrices.

pub fn set_projection(&self, projection: impl Into<Mat4>) -> &Self

Set the projection matrix of this camera.

pub fn with_projection(self, projection: impl Into<Mat4>) -> Self

Set the projection matrix and return this camera.

pub fn projection(&self) -> Mat4

Returns the projection matrix.

pub fn set_view(&self, view: impl Into<Mat4>) -> &Self

Set the view matrix of this camera.

pub fn with_view(self, view: impl Into<Mat4>) -> Self

Set the view matrix and return this camera.

pub fn view(&self) -> Mat4

Returns the view matrix.

Trait Implementations

impl AsRef<Camera> for Camera

fn as_ref(&self) -> &Camera

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Camera> for GltfCamera

fn as_ref(&self) -> &Camera

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Camera

fn clone(&self) -> Camera

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Camera

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

Formats the value using the given formatter.