Struct Camera 

pub struct Camera {

    pub fov: f32,
    pub near: f32,
    pub far: f32,
    pub primary: bool,
    pub orthographic: bool,
    pub ortho_size: f32,
    pub focal_length: f32,
    pub dof: bool,
    pub aperture: f32,
    pub focus_distance: f32,
    pub autofocus: bool,
    pub focus_speed: f32,
    pub exposure_comp: f32,
    pub letterbox: f32,
    pub effects: Vec<PostEffect>,
}

Perspective or orthographic scene camera. The first primary camera is selected for gameplay.

Fields

fov: f32

Vertical perspective field of view in degrees. Ignored for orthographic cameras.

near: f32

Near clipping distance in metres; must be positive for perspective projection.

far: f32

Far clipping distance in metres; must exceed near.

primary: bool

The first primary camera is used to render the game.

orthographic: bool

Orthographic projection (2D games). ortho_size is the visible height in world units.

ortho_size: f32

Full vertical orthographic view height in metres.

focal_length: f32

Lens focal length in millimetres on a 24 mm tall sensor; above 0 it replaces fov (24 mm is a wide shot, 50 mm natural, 135 mm a telephoto).

dof: bool

Depth of field: blur what is not at the focus distance.

aperture: f32

Aperture as an f-number: 1.4 gives strong blur, 8 a deep focus, 22 almost none.

focus_distance: f32

Distance in metres that is in focus (set live by autofocus).

autofocus: bool

Focus on whatever is in the middle of the screen (needs colliders to hit).

focus_speed: f32

How fast autofocus racks to a new target.

exposure_comp: f32

Exposure compensation in stops (+1 doubles the light).

letterbox: f32

Cinematic bars: target picture ratio such as 2.39 or 1.85 (0 = full screen).

effects: Vec<PostEffect>

Camera shaders of this camera only, applied after the scene’s own effects while it is the active camera (security cam static, a character’s blurred view…).

Implementations

impl Camera

pub fn vertical_fov(&self) -> f32

Vertical field of view in degrees: from the focal length when one is set, else fov.

Trait Implementations

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

fn fields(&mut self) -> Vec<Field<'_>>

Mutable field descriptors used by the Inspector and script property serialization.

const REMOVABLE: bool = true

Whether the user may remove it in the inspector.

impl Component for Camera

const NAME: &'static str = "Camera"

Stable, globally unique name; keep it identical in the host and script library.

const KEY: u64 = _

Storage key derived from [Self::NAME]. Normally should not be overridden.

impl Default for Camera

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Camera

where Camera: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.