Struct ExtractedView

pub struct ExtractedView {
    pub retained_view_entity: RetainedViewEntity,
    pub clip_from_view: Mat4,
    pub world_from_view: GlobalTransform,
    pub clip_from_world: Option<Mat4>,
    pub hdr: bool,
    pub viewport: UVec4,
    pub color_grading: ColorGrading,
}

Describes a camera in the render world.

Each entity in the main world can potentially extract to multiple subviews, each of which has a RetainedViewEntity::subview_index. For instance, 3D cameras extract to both a 3D camera subview with index 0 and a special UI subview with index 1. Likewise, point lights with shadows extract to 6 subviews, one for each side of the shadow cubemap.

Fields

retained_view_entity: RetainedViewEntity

The entity in the main world corresponding to this render world view.

clip_from_view: Mat4

Typically a column-major right-handed projection matrix, one of either:

Perspective (infinite reverse z)

f = 1 / tan(fov_y_radians / 2)

⎡ f / aspect  0   0     0 ⎤
⎢          0  f   0     0 ⎥
⎢          0  0   0  near ⎥
⎣          0  0  -1     0 ⎦

Orthographic

w = right - left
h = top - bottom
d = far - near
cw = -right - left
ch = -top - bottom

⎡ 2 / w      0      0   cw / w ⎤
⎢     0  2 / h      0   ch / h ⎥
⎢     0      0  1 / d  far / d ⎥
⎣     0      0      0        1 ⎦

clip_from_view[3][3] == 1.0 is the standard way to check if a projection is orthographic

Glam matrices are column major, so for example getting the near plane of a perspective projection is clip_from_view[3][2]

Custom projections are also possible however.

world_from_view: GlobalTransform

clip_from_world: Option<Mat4>

hdr: bool

viewport: UVec4

color_grading: ColorGrading

Implementations

impl ExtractedView

pub fn rangefinder3d(&self) -> ViewRangefinder3d

Creates a 3D rangefinder for a view

Trait Implementations

impl Component for ExtractedView

where ExtractedView: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn on_add() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]