Struct Camera

pub struct Camera {
    pub tone_mapping: ToneMapping,
    pub color_mapping: ColorMapping,
    /* private fields */
}

Represents a camera used for viewing 2D and 3D objects.

Fields

tone_mapping: ToneMapping

This tone mapping is applied to the final color of renders using this camera.

color_mapping: ColorMapping

This color mapping is applied to the final color of renders using this camera.

Implementations

impl Camera

pub fn new_orthographic( viewport: Viewport, position: Vec3, target: Vec3, up: Vec3, height: f32, z_near: f32, z_far: f32, ) -> Self

New camera which projects the world with an orthographic projection.

pub fn new_perspective( viewport: Viewport, position: Vec3, target: Vec3, up: Vec3, field_of_view_y: impl Into<Radians>, z_near: f32, z_far: f32, ) -> Self

New camera which projects the world with a perspective projection.

pub fn new_2d(viewport: Viewport) -> Self

Returns an orthographic camera for viewing 2D content. The camera is placed at the center of the given viewport. The (0, 0) position is at the bottom left corner and the (viewport.width, viewport.height) position is at the top right corner.

pub fn disable_tone_and_color_mapping(&mut self)

Disables the tone and color mapping so as to be ready for rendering into an intermediate render target with this camera.

pub fn set_default_tone_and_color_mapping(&mut self)

Sets the tone and color mapping to default so as to be ready for rendering into the final render target (usually the screen) with this camera.

Methods from Deref<Target = Camera>

pub fn set_perspective_projection( &mut self, field_of_view_y: impl Into<Rad<f32>>, z_near: f32, z_far: f32, )

Specify the camera to use perspective projection with the given field of view in the y-direction and near and far plane.

pub fn set_orthographic_projection( &mut self, height: f32, z_near: f32, z_far: f32, )

Specify the camera to use orthographic projection with the given dimensions. The view frustum height is +/- height/2. The view frustum width is calculated as height * viewport.width / viewport.height. The view frustum depth is z_near to z_far. All of the above values are scaled by the zoom factor which is one over the distance between the camera position and target.

pub fn set_viewport(&mut self, viewport: Viewport) -> bool

Set the current viewport. Returns whether or not the viewport actually changed.

pub fn set_view( &mut self, position: Vector3<f32>, target: Vector3<f32>, up: Vector3<f32>, )

Change the view of the camera. The camera is placed at the given position, looking at the given target and with the given up direction.

pub fn frustum(&self) -> Frustum

Returns the Frustum for this camera.

pub fn position_at_pixel(&self, pixel: impl Into<PixelPoint>) -> Vector3<f32>

Returns the 3D position at the given pixel coordinate.

pub fn position_at_uv_coordinates( &self, coords: impl Into<UvCoordinate>, ) -> Vector3<f32>

Returns the 3D position at the given uv coordinate of the viewport.

pub fn view_direction_at_pixel( &self, pixel: impl Into<PixelPoint>, ) -> Vector3<f32>

Returns the 3D view direction at the given pixel coordinate.

pub fn view_direction_at_uv_coordinates( &self, coords: impl Into<UvCoordinate>, ) -> Vector3<f32>

Returns the 3D view direction at the given uv coordinate of the viewport.

pub fn uv_coordinates_at_pixel( &self, pixel: impl Into<PixelPoint>, ) -> UvCoordinate

Returns the uv coordinate for the given pixel coordinate.

pub fn uv_coordinates_at_position(&self, position: Vector3<f32>) -> UvCoordinate

Returns the uv coordinate for the given world position.

pub fn pixel_at_uv_coordinates( &self, coords: impl Into<UvCoordinate>, ) -> PixelPoint

Returns the pixel coordinate for the given uv coordinate.

pub fn pixel_at_position(&self, position: Vector3<f32>) -> PixelPoint

Returns the pixel coordinate for the given world position.

pub fn projection_type(&self) -> &ProjectionType

Returns the type of projection (orthographic or perspective) including parameters.

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

Returns the view matrix, ie. the matrix that transforms objects from world space (as placed in the world) to view space (as seen from this camera).

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

Returns the projection matrix, ie. the matrix that projects objects in view space onto this cameras image plane.

pub fn viewport(&self) -> Viewport

Returns the viewport.

pub fn z_near(&self) -> f32

Returns the distance to the near plane of the camera frustum.

pub fn z_far(&self) -> f32

Returns the distance to the far plane of the camera frustum.

pub fn position(&self) -> Vector3<f32>

Returns the position of this camera.

pub fn target(&self) -> Vector3<f32>

Returns the target of this camera, ie the point that this camera looks towards.

pub fn up(&self) -> Vector3<f32>

Returns the up direction of this camera. This will probably not be orthogonal to the view direction, use up_orthogonal instead if that is needed.

pub fn up_orthogonal(&self) -> Vector3<f32>

Returns the up direction of this camera that is orthogonal to the view direction.

pub fn view_direction(&self) -> Vector3<f32>

Returns the view direction of this camera, ie. the direction the camera is looking.

pub fn right_direction(&self) -> Vector3<f32>

Returns the right direction of this camera.

pub fn translate(&mut self, change: Vector3<f32>)

Translate the camera by the given change while keeping the same view and up directions.

pub fn pitch(&mut self, delta: impl Into<Rad<f32>>)

Rotates the camera by the angle delta around the ‘right’ direction.

pub fn yaw(&mut self, delta: impl Into<Rad<f32>>)

Rotates the camera by the angle delta around the ‘up’ direction.

pub fn roll(&mut self, delta: impl Into<Rad<f32>>)

Rotates the camera by the angle delta around the ‘view’ direction.

pub fn rotate_around(&mut self, point: Vector3<f32>, x: f32, y: f32)

Rotate the camera around the given point while keeping the same distance to the point. The input x specifies the amount of rotation in the left direction and y specifies the amount of rotation in the up direction. If you want the camera up direction to stay fixed, use the rotate_around_with_fixed_up function instead.

pub fn rotate_around_with_fixed_up( &mut self, point: Vector3<f32>, x: f32, y: f32, )

Rotate the camera around the given point while keeping the same distance to the point and the same up direction. The input x specifies the amount of rotation in the left direction and y specifies the amount of rotation in the up direction.

pub fn zoom(&mut self, delta: f32, minimum_distance: f32, maximum_distance: f32)

Moves the camera towards the camera target by the amount delta while keeping the given minimum and maximum distance to the target.

pub fn zoom_towards( &mut self, point: Vector3<f32>, delta: f32, minimum_distance: f32, maximum_distance: f32, )

Moves the camera towards the given point by the amount delta while keeping the given minimum and maximum distance to the camera target. Note that the camera target is also updated so that the view direction is the same.

pub fn set_zoom_factor(&mut self, zoom_factor: f32)

Sets the zoom factor of this camera, ie. the distance to the camera will be 1/zoom_factor.

pub fn zoom_factor(&self) -> f32

The zoom factor for this camera, which is the same as one over the distance between the camera position and target.

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 Debug for Camera

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

Formats the value using the given formatter.

impl Deref for Camera

type Target = Camera

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Camera

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Viewer for Camera

fn position(&self) -> Vec3

The position of the viewer.

fn view(&self) -> Mat4

The view matrix which transforms from world space to view space.

fn projection(&self) -> Mat4

The projection matrix which transforms from view space to clip space (2D position on the screen).

fn viewport(&self) -> Viewport

The 2D Viewport of the viewer.

fn z_near(&self) -> f32

Defines the minimum depth in world space.

fn z_far(&self) -> f32

Defines the maximum depth in world space.

fn color_mapping(&self) -> ColorMapping

Defines the ColorMapping applied to the final rendered image.

fn tone_mapping(&self) -> ToneMapping

Defines the ToneMapping applied to the final rendered image.