Enum bevy_render::camera::ScalingMode

pub enum ScalingMode {
    Fixed {
        width: f32,
        height: f32,
    },
    WindowSize(f32),
    AutoMin {
        min_width: f32,
        min_height: f32,
    },
    AutoMax {
        max_width: f32,
        max_height: f32,
    },
    FixedVertical(f32),
    FixedHorizontal(f32),
}

Scaling mode for OrthographicProjection.

Examples

Configure the orthographic projection to two world units per window height:

let projection = Projection::Orthographic(OrthographicProjection {
   scaling_mode: ScalingMode::FixedVertical(2.0),
   ..OrthographicProjection::default()
});

Variants

Fixed

Fields

width: f32

height: f32

Manually specify the projection’s size, ignoring window resizing. The image will stretch. Arguments are in world units.

WindowSize(f32)

Match the viewport size. The argument is the number of pixels that equals one world unit.

AutoMin

Fields

min_width: f32

min_height: f32

Keeping the aspect ratio while the axes can’t be smaller than given minimum. Arguments are in world units.

AutoMax

Fields

max_width: f32

max_height: f32

Keeping the aspect ratio while the axes can’t be bigger than given maximum. Arguments are in world units.

FixedVertical(f32)

Keep the projection’s height constant; width will be adjusted to match aspect ratio. The argument is the desired height of the projection in world units.

FixedHorizontal(f32)

Keep the projection’s width constant; height will be adjusted to match aspect ratio. The argument is the desired width of the projection in world units.

Trait Implementations

impl Clone for ScalingMode

fn clone(&self) -> ScalingMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScalingMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScalingMode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<f32> for ScalingMode

fn div(self, rhs: f32) -> ScalingMode

Scale the ScalingMode. For example, dividing by 2 makes the viewport half as large.

type Output = ScalingMode

The resulting type after applying the / operator.

impl DivAssign<f32> for ScalingMode

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl Enum for ScalingMode

where Self: Any + Send + Sync, f32: FromReflect + TypePath,

fn field(&self, __name_param: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut(&mut self, __index_param: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl FromReflect for ScalingMode

where Self: Any + Send + Sync, f32: FromReflect + TypePath,

fn from_reflect(__param0: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for ScalingMode

where Self: Any + Send + Sync, f32: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Mul<f32> for ScalingMode

fn mul(self, rhs: f32) -> ScalingMode

Scale the ScalingMode. For example, multiplying by 2 makes the viewport twice as large.

type Output = ScalingMode

The resulting type after applying the * operator.

impl MulAssign<f32> for ScalingMode

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Reflect for ScalingMode

where Self: Any + Send + Sync, f32: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set( &mut self, __value_param: Box<dyn Reflect> ) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, __value_param: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for ScalingMode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypePath for ScalingMode

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ScalingMode

where Self: Any + Send + Sync, f32: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for ScalingMode