Struct bevy::render::camera::OrthographicCameraBundle

pub struct OrthographicCameraBundle<M> where
    M: Component,  {
    pub camera: Camera,
    pub orthographic_projection: OrthographicProjection,
    pub visible_entities: VisibleEntities,
    pub frustum: Frustum,
    pub transform: Transform,
    pub global_transform: GlobalTransform,
    pub marker: M,
}

Component bundle for camera entities with orthographic projection

Use this for 2D games, isometric games, CAD-like 3D views.

Fields

camera: Camera

orthographic_projection: OrthographicProjection

visible_entities: VisibleEntities

frustum: Frustum

transform: Transform

global_transform: GlobalTransform

marker: M

Implementations

impl OrthographicCameraBundle<Camera3d>

pub fn new_3d() -> OrthographicCameraBundle<Camera3d>

impl OrthographicCameraBundle<Camera2d>

pub fn new_2d() -> OrthographicCameraBundle<Camera2d>

Create an orthographic projection camera to render 2D content.

The projection creates a camera space where X points to the right of the screen, Y points to the top of the screen, and Z points out of the screen (backward), forming a right-handed coordinate system. The center of the screen is at X=0 and Y=0.

The default scaling mode is ScalingMode::WindowSize, resulting in a resolution where 1 unit in X and Y in camera space corresponds to 1 logical pixel on the screen. That is, for a screen of 1920 pixels in width, the X coordinates visible on screen go from X=-960 to X=+960 in world space, left to right. This can be changed by changing the OrthographicProjection::scaling_mode field.

The camera is placed at Z=+1000-0.1, looking toward the world origin (0,0,0). Its orthographic projection extends from 0.0 to -1000.0 in camera view space, corresponding to Z=+999.9 (closest to camera) to Z=-0.1 (furthest away from camera) in world space.

Trait Implementations

impl<M> Bundle for OrthographicCameraBundle<M> where
    M: Component, 

SAFE: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order

fn component_ids(
    components: &mut Components,
    storages: &mut Storages
) -> Vec<ComponentId, Global>

Gets this Bundle’s component ids, in the order of this bundle’s Components

unsafe fn from_components(
    func: impl FnMut() -> *mut u8
) -> OrthographicCameraBundle<M>

Calls func, which should return data for each component in the bundle, in the order of this bundle’s Components

fn get_components(self, func: impl FnMut(*mut u8))

Calls func on each value, in the order of this bundle’s Components. This will std::mem::forget the bundle fields, so callers are responsible for dropping the fields if that is desirable.