Enum amethyst_utils::ortho_camera::CameraNormalizeMode

pub enum CameraNormalizeMode {
    Lossy {
        stretch_direction: Axis2,
    },
    Contain,
}

Settings that decide how to scale the camera's matrix when the aspect ratio changes.

Variants

Lossy

Using the aspect ratio from the world coordinates for this camera, tries to adjust the matrix values of the camera so that the orthogonal direction to the stretch_direction always have a world size of 1.

This means that the direction opposite to stretch_direction will always be between 0.0 to 1.0 in world coordinates. Scene space can be lost (or gained) on the specified stretch_direction however.

Example (using a normalized ortho camera): If you use Lossy with the stretch_direction of Axis::X, this means that a mesh or image going from the world coordinates (0, 0) to (1, 1) would take the whole screen size if the window dimension width is equal to its height.

If the window gets stretched on the x axis, the mesh or image will stay centered and the background clear color (or things that were previously outside of the window) will now be shown on the left and right sides of the mesh or image.

If you shrink the window on the x axis instead, the left and right parts of the images will go off screen and will NOT be shown.

If you want the whole world space between (0, 0) and (1, 1) to be shown at ALL times, consider using CameraNormalizeMode::Contain instead.

Fields of Lossy

stretch_direction: Axis2

The direction along which the camera will stretch and possibly have a length not equal to one.

Contain

Scales the render dynamically to ensure the CameraOrthoWorldCoordinates are always visible. There may still be additional space in addition to the specific coordinates, but it will never hide anything.

If you have a non-default Transform on your camera, it will just translate those coordinates by the translation of the Transform.

Trait Implementations

impl Copy for CameraNormalizeMode

impl Default for CameraNormalizeMode

fn default() -> Self

Returns the "default value" for a type.

impl Clone for CameraNormalizeMode

fn clone(&self) -> CameraNormalizeMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<CameraNormalizeMode> for CameraNormalizeMode

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

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

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

This method tests for !=.

impl Debug for CameraNormalizeMode

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

Formats the value using the given formatter.

impl Serialize for CameraNormalizeMode

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 CameraNormalizeMode

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

Deserialize this value from the given Serde deserializer.