Struct bevy_retrograde_core::components::Camera

pub struct Camera {
    pub size: CameraSize,
    pub centered: bool,
    pub background_color: Color,
    pub letterbox_color: Color,
    pub pixel_aspect_ratio: f32,
    pub custom_shader: Option<String>,
}

The camera component

Fields

size: CameraSize

The size of the camera along the fixed axis, which is by default the vertical axis

centered: bool

Whether the camera should be centered about it’s position. Defaults to true. If set to false false, the top-left corner of the camera will be at its [Transform].

background_color: Color

The background color of the camera

This is the color that will be scene in the viewport when there are no sprites in the game area.

letterbox_color: Color

The color of the letter box

The letter box is only visible when the camera size is set to LetterBoxed.

pixel_aspect_ratio: f32

The aspect ratio of the pxiels when rendered through this camera

custom_shader: Option<String>

Additional shader code that will be added to the camera rendering that can be used for post-processing

This must be a OpenGL ES Shading Language 1.0 string.

// Spawn the camera
commands.spawn().insert_bundle(CameraBundle {
    camera: Camera {
        // Set our camera to have a fixed height and an auto-resized width
        size: CameraSize::FixedHeight(100),
        background_color: Color::new(0.2, 0.2, 0.2, 1.0),
        custom_shader: Some(
            CrtShader {
                // You can configure shader options here
                ..Default::default()
            }
            .get_shader(),
        ),
        ..Default::default()
    },
    ..Default::default()
});

Implementations

impl Camera

pub fn get_target_sizes(&self, window: &Window) -> CameraTargetSizes

Get the size in game pixels ( retro-sized, not screen pixels ) of the camera view

Trait Implementations

impl Clone for Camera

fn clone(&self) -> Camera

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Camera

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

Formats the value using the given formatter.

impl Default for Camera

fn default() -> Self

Returns the “default value” for a type.

impl GetTypeRegistration for Camera

fn get_type_registration() -> TypeRegistration

impl Reflect for Camera

fn type_name(&self) -> &str

fn any(&self) -> &dyn Any

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

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

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

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

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

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

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

Returns a serializable value, if serialization is supported. Otherwise None will be returned.

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

Returns a hash of the value (which includes the type) if hashing is supported. Otherwise None will be returned.

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

Returns a “partial equal” comparison result if comparison is supported. Otherwise None will be returned.

impl Struct for Camera

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

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

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

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

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

fn field_len(&self) -> usize

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

fn clone_dynamic(&self) -> DynamicStruct