savoiardi/camera

Perspective and orthographic cameras.

Savoiardi exposes typed camera variants together with safe downcasts and common projection and lens controls.

Types

Camera

A camera viewed through the shared camera API.

pub type Camera

Orthographic

</>

An orthographic camera.

pub type Orthographic

Perspective

</>

A perspective camera.

pub type Perspective

Values

clear_view_offset

</>

pub fn clear_view_offset(camera: Camera) -> Camera

Clears any configured view offset.

far

</>

pub fn far(camera: Camera) -> Float

Reads the far clipping plane of a camera.

from_orthographic

</>

pub fn from_orthographic(camera: Orthographic) -> Camera

Widens an orthographic camera into the shared camera type.

from_perspective

</>

pub fn from_perspective(camera: Perspective) -> Camera

Widens a perspective camera into the shared camera type.

is_orthographic_camera

</>

pub fn is_orthographic_camera(object: object.Object3D) -> Bool

Returns whether an object is an orthographic camera.

is_perspective_camera

</>

pub fn is_perspective_camera(object: object.Object3D) -> Bool

Returns whether an object is a perspective camera.

near

</>

pub fn near(camera: Camera) -> Float

Reads the near clipping plane of a camera.

orthographic

</>

pub fn orthographic(
  left left: Float,
  right right: Float,
  top top: Float,
  bottom bottom: Float,
  near near: Float,
  far far: Float,
) -> Orthographic

Creates an orthographic camera.

orthographic_bottom

</>

pub fn orthographic_bottom(camera: Orthographic) -> Float

Reads the bottom bound of an orthographic camera.

orthographic_from_object3d

</>

pub fn orthographic_from_object3d(
  object: object.Object3D,
) -> Result(Orthographic, Nil)

Safely downcasts an object to an orthographic camera.

orthographic_left

</>

pub fn orthographic_left(camera: Orthographic) -> Float

Reads the left bound of an orthographic camera.

orthographic_right

</>

pub fn orthographic_right(camera: Orthographic) -> Float

Reads the right bound of an orthographic camera.

orthographic_top

</>

pub fn orthographic_top(camera: Orthographic) -> Float

Reads the top bound of an orthographic camera.

perspective

</>

pub fn perspective(
  fov fov: Float,
  aspect aspect: Float,
  near near: Float,
  far far: Float,
) -> Perspective

Creates a perspective camera.

perspective_aspect

</>

pub fn perspective_aspect(camera: Perspective) -> Float

Reads the aspect ratio of a perspective camera.

perspective_effective_fov

</>

pub fn perspective_effective_fov(camera: Perspective) -> Float

Reads the effective field of view of a perspective camera.

perspective_film_height

</>

pub fn perspective_film_height(camera: Perspective) -> Float

Reads the film height of a perspective camera.

perspective_film_width

</>

pub fn perspective_film_width(camera: Perspective) -> Float

Reads the film width of a perspective camera.

perspective_focal_length

</>

pub fn perspective_focal_length(camera: Perspective) -> Float

Reads the focal length of a perspective camera.

perspective_fov

</>

pub fn perspective_fov(camera: Perspective) -> Float

Reads the field of view of a perspective camera.

perspective_from_object3d

</>

pub fn perspective_from_object3d(
  object: object.Object3D,
) -> Result(Perspective, Nil)

Safely downcasts an object to a perspective camera.

set_far

</>

pub fn set_far(camera: Camera, far: Float) -> Camera

Sets the far clipping plane of a camera.

set_near

</>

pub fn set_near(camera: Camera, near: Float) -> Camera

Sets the near clipping plane of a camera.

set_orthographic_bottom

</>

pub fn set_orthographic_bottom(
  camera: Orthographic,
  bottom: Float,
) -> Orthographic

Sets the bottom bound of an orthographic camera.

set_orthographic_left

</>

pub fn set_orthographic_left(
  camera: Orthographic,
  left: Float,
) -> Orthographic

Sets the left bound of an orthographic camera.

set_orthographic_right

</>

pub fn set_orthographic_right(
  camera: Orthographic,
  right: Float,
) -> Orthographic

Sets the right bound of an orthographic camera.

set_orthographic_top

</>

pub fn set_orthographic_top(
  camera: Orthographic,
  top: Float,
) -> Orthographic

Sets the top bound of an orthographic camera.

set_perspective_aspect

</>

pub fn set_perspective_aspect(
  camera: Perspective,
  aspect: Float,
) -> Perspective

Sets the aspect ratio of a perspective camera.

set_perspective_film_gauge

</>

pub fn set_perspective_film_gauge(
  camera: Perspective,
  film_gauge: Float,
) -> Perspective

Sets the film gauge of a perspective camera.

set_perspective_film_offset

</>

pub fn set_perspective_film_offset(
  camera: Perspective,
  film_offset: Float,
) -> Perspective

Sets the film offset of a perspective camera.

set_perspective_focal_length

</>

pub fn set_perspective_focal_length(
  camera: Perspective,
  focal_length: Float,
) -> Perspective

Sets the focal length of a perspective camera.

set_perspective_fov

</>

pub fn set_perspective_fov(
  camera: Perspective,
  fov: Float,
) -> Perspective

Sets the field of view of a perspective camera.

set_view_offset

</>

pub fn set_view_offset(
  camera: Camera,
  full_width full_width: Int,
  full_height full_height: Int,
  x x: Int,
  y y: Int,
  width width: Int,
  height height: Int,
) -> Camera

Sets a view offset for tiled or multi-window rendering.

set_zoom

</>

pub fn set_zoom(camera: Camera, zoom: Float) -> Camera

Sets the zoom factor of a camera.

to_object3d

</>

pub fn to_object3d(camera: Camera) -> object.Object3D

Views a camera as an object.

update_orthographic

</>

pub fn update_orthographic(
  camera: Orthographic,
  left left: Float,
  right right: Float,
  top top: Float,
  bottom bottom: Float,
  near near: Float,
  far far: Float,
) -> Orthographic

Updates the core projection values of an orthographic camera.

update_perspective

</>

pub fn update_perspective(
  camera: Perspective,
  fov fov: Float,
  aspect aspect: Float,
  near near: Float,
  far far: Float,
) -> Perspective

Updates the core projection values of a perspective camera.

update_projection_matrix

</>

pub fn update_projection_matrix(camera: Camera) -> Camera

Recomputes the projection matrix after camera changes.

zoom

</>

pub fn zoom(camera: Camera) -> Float

Reads the zoom factor of a camera.