Enum Projection

Source

pub enum Projection {
    Perspective(PerspectiveProjection),
    Orthographic(OrthographicProjection),
    Custom(CustomProjection),
}

Expand description

Component that defines how to compute a Camera’s projection matrix.

Common projections, like perspective and orthographic, are provided out of the box to handle the majority of use cases. Custom projections can be added using the CameraProjection trait and the Projection::custom constructor.

§What’s a projection?

A camera projection essentially describes how 3d points from the point of view of a camera are projected onto a 2d screen. This is where properties like a camera’s field of view are defined. More specifically, a projection is a 4x4 matrix that transforms points from view space (the point of view of the camera) into clip space. Clip space is almost, but not quite, equivalent to the rectangle that is rendered to your screen, with a depth axis. Any points that land outside the bounds of this cuboid are “clipped” and not rendered.

You can also think of the projection as the thing that describes the shape of a camera’s frustum: the volume in 3d space that is visible to a camera.

Variants§

§

Perspective(PerspectiveProjection)

§

Enum ProjectionCopy item path

§What’s a projection?

Variants§

Perspective(PerspectiveProjection)

Orthographic(OrthographicProjection)

Custom(CustomProjection)

Implementations§

impl Projection

pub fn custom<P>(projection: P) -> Selfwhere P: CameraProjection + Debug + Send + Sync + Clone + 'static,

Trait Implementations§

impl CameraProjection for Projection

fn get_clip_from_view(&self) -> Mat4

fn get_clip_from_view_for_sub(&self, sub_view: &SubCameraView) -> Mat4

fn update(&mut self, width: f32, height: f32)

fn far(&self) -> f32

fn get_frustum_corners(&self, z_near: f32, z_far: f32) -> [Vec3A; 8]

fn compute_frustum(&self, camera_transform: &GlobalTransform) -> Frustum

impl Clone for Projection

fn clone(&self) -> Projection

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

impl Component for Projectionwhere Self: Send + Sync + 'static,

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

type Mutability = Mutable

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

fn clone_behavior() -> ComponentCloneBehavior

fn map_entities<M: EntityMapper>(this: &mut Self, mapper: &mut M)

fn register_component_hooks(hooks: &mut ComponentHooks)

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

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

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

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

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

impl Debug for Projection

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

impl Default for Projection

fn default() -> Self

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

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

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

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

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

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

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

fn field_len(&self) -> usize

fn variant_name(&self) -> &str

fn variant_index(&self) -> usize

fn variant_type(&self) -> VariantType

fn to_dynamic_enum(&self) -> DynamicEnum

fn clone_dynamic(&self) -> DynamicEnum

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

fn variant_path(&self) -> String

fn get_represented_enum_info(&self) -> Option<&'static EnumInfo>

impl From<CustomProjection> for Projection

fn from(value: CustomProjection) -> Self

impl From<OrthographicProjection> for Projection

fn from(value: OrthographicProjection) -> Self

impl From<PerspectiveProjection> for Projection

fn from(value: PerspectiveProjection) -> Self

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

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

fn get_type_registration() -> TypeRegistration

fn register_type_dependencies(registry: &mut TypeRegistry)

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

fn try_apply( &mut self, __value_param: &dyn PartialReflect, ) -> Result<(), ApplyError>

fn reflect_kind(&self) -> ReflectKind

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

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

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

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

fn try_as_reflect(&self) -> Option<&dyn Reflect>

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

fn as_partial_reflect(&self) -> &dyn PartialReflect

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

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

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

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

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

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

Enum Projection

pub fn custom<P>(projection: P) -> Self
where P: CameraProjection + Debug + Send + Sync + Clone + 'static,

impl Component for Projection
where Self: Send + Sync + 'static,

impl TypePath for Projection
where Projection: Any + Send + Sync,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<C> Bundle for C
where C: Component,

impl<C> BundleFromComponents for C
where C: Component,

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

impl<T> CloneToUninit for T
where T: Clone,

impl<T> Downcast for T
where T: Any,

impl<T> DowncastSend for T
where T: Any + Send,

impl<C> DynamicBundle for C
where C: Component,

impl<T> DynamicTypePath for T
where T: TypePath,