Struct amethyst_utils::ortho_camera::CameraOrtho

pub struct CameraOrtho {
    pub mode: CameraNormalizeMode,
    pub world_coordinates: CameraOrthoWorldCoordinates,
    // some fields omitted
}

Component attached to the camera's entity that allows automatically adjusting the camera's matrix according to preferences in the "mode" and "world_coordinates" fields. It adjusts the camera so that the camera's world coordinates are always visible. You must add the CameraOrthoSystem to your dispatcher for this to take effect (no dependencies required).

Example

world
    .create_entity()
    .with(Transform::default())
    .with(Camera::standard_2d(1920.0, 1080.0))
    .with(CameraOrtho::normalized(CameraNormalizeMode::Contain))
    .build();

Fields

mode: CameraNormalizeMode

How the camera's matrix is changed when the window's aspect ratio changes. See CameraNormalizeMode for more info.

world_coordinates: CameraOrthoWorldCoordinates

The world coordinates that this camera will keep visible as the window size changes

Methods

impl CameraOrtho

pub fn new(
    mode: CameraNormalizeMode,
    world_coordinates: CameraOrthoWorldCoordinates
) -> Self

Constructs a new CameraOrtho.

impl CameraOrtho

pub fn normalized(mode: CameraNormalizeMode) -> CameraOrtho

Creates a Camera that maintains window coordinates of (0,0) in the bottom left, and (1,1) at the top right

pub fn camera_offsets(&self, window_aspect_ratio: f32) -> (f32, f32, f32, f32)

Get the camera matrix offsets according to the specified options.

Trait Implementations

impl Default for CameraOrtho

fn default() -> CameraOrtho

Returns the "default value" for a type.

impl Clone for CameraOrtho

fn clone(&self) -> CameraOrtho

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<CameraOrtho> for CameraOrtho

fn eq(&self, other: &CameraOrtho) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CameraOrtho) -> bool

This method tests for !=.

impl Debug for CameraOrtho

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

Formats the value using the given formatter.

impl Serialize for CameraOrtho

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for CameraOrtho

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'pfd> PrefabData<'pfd> for CameraOrtho

type SystemData = WriteStorage<'pfd, CameraOrtho>

SystemData needed to perform the load

type Result = ()

The result type returned by the load operation

fn add_to_entity(
    &self,
    entity: Entity,
    system_data: &mut Self::SystemData,
    _: &[Entity],
    _: &[Entity]
) -> Result<(), Error>

Add the data for this prefab onto the given Entity

fn load_sub_assets(
    &mut self,
    _progress: &mut ProgressCounter,
    _system_data: &mut Self::SystemData
) -> Result<bool, Error>

Trigger asset loading for any sub assets.

impl Component for CameraOrtho

type Storage = DenseVecStorage<Self>

Associated storage type for this component.