Struct bevy_render::camera::Camera
source · pub struct Camera {
pub viewport: Option<Viewport>,
pub order: isize,
pub is_active: bool,
pub computed: ComputedCameraValues,
pub target: RenderTarget,
pub hdr: bool,
pub output_mode: CameraOutputMode,
pub msaa_writeback: bool,
pub clear_color: ClearColorConfig,
}
Expand description
The defining Component
for camera entities,
storing information about how and what to render through this camera.
The Camera
component is added to an entity to define the properties of the viewpoint from
which rendering occurs. It defines the position of the view to render, the projection method
to transform the 3D objects into a 2D image, as well as the render target into which that image
is produced.
Adding a camera is typically done by adding a bundle, either the Camera2dBundle
or the
Camera3dBundle
.
Fields§
§viewport: Option<Viewport>
If set, this camera will render to the given Viewport
rectangle within the configured RenderTarget
.
order: isize
Cameras with a higher order are rendered later, and thus on top of lower order cameras.
is_active: bool
If this is set to true
, this camera will be rendered to its specified RenderTarget
. If false
, this
camera will not be rendered.
computed: ComputedCameraValues
Computed values for this camera, such as the projection matrix and the render target size.
target: RenderTarget
The “target” that this camera will render to.
hdr: bool
If this is set to true
, the camera will use an intermediate “high dynamic range” render texture.
This allows rendering with a wider range of lighting values.
output_mode: CameraOutputMode
The CameraOutputMode
for this camera.
msaa_writeback: bool
If this is enabled, a previous camera exists that shares this camera’s render target, and this camera has MSAA enabled, then the previous camera’s outputs will be written to the intermediate multi-sampled render target textures for this camera. This enables cameras with MSAA enabled to “write their results on top” of previous camera results, and include them as a part of their render results. This is enabled by default to ensure cameras with MSAA enabled layer their results in the same way as cameras without MSAA enabled by default.
clear_color: ClearColorConfig
The clear color operation to perform on the render target.
Implementations§
source§impl Camera
impl Camera
sourcepub fn to_logical(&self, physical_size: UVec2) -> Option<Vec2>
pub fn to_logical(&self, physical_size: UVec2) -> Option<Vec2>
Converts a physical size in this Camera
to a logical size.
sourcepub fn physical_viewport_rect(&self) -> Option<URect>
pub fn physical_viewport_rect(&self) -> Option<URect>
The rendered physical bounds URect
of the camera. If the viewport
field is
set to Some
, this will be the rect of that custom viewport. Otherwise it will default to
the full physical rect of the current RenderTarget
.
sourcepub fn logical_viewport_rect(&self) -> Option<Rect>
pub fn logical_viewport_rect(&self) -> Option<Rect>
The rendered logical bounds Rect
of the camera. If the viewport
field is set to
Some
, this will be the rect of that custom viewport. Otherwise it will default to the
full logical rect of the current RenderTarget
.
sourcepub fn logical_viewport_size(&self) -> Option<Vec2>
pub fn logical_viewport_size(&self) -> Option<Vec2>
The logical size of this camera’s viewport. If the viewport
field is set to Some
, this
will be the size of that custom viewport. Otherwise it will default to the full logical size
of the current RenderTarget
.
For logic that requires the full logical size of the
RenderTarget
, prefer Camera::logical_target_size
.
Returns None
if either:
- the function is called just after the
Camera
is created, beforecamera_system
is executed, - the
RenderTarget
isn’t correctly set:- it references the
PrimaryWindow
when there is none, - it references a
Window
entity that doesn’t exist or doesn’t actually have aWindow
component, - it references an
Image
that doesn’t exist (invalid handle), - it references a
TextureView
that doesn’t exist (invalid handle).
- it references the
sourcepub fn physical_viewport_size(&self) -> Option<UVec2>
pub fn physical_viewport_size(&self) -> Option<UVec2>
The physical size of this camera’s viewport (in physical pixels).
If the viewport
field is set to Some
, this
will be the size of that custom viewport. Otherwise it will default to the full physical size of
the current RenderTarget
.
For logic that requires the full physical size of the RenderTarget
, prefer Camera::physical_target_size
.
sourcepub fn logical_target_size(&self) -> Option<Vec2>
pub fn logical_target_size(&self) -> Option<Vec2>
The full logical size of this camera’s RenderTarget
, ignoring custom viewport
configuration.
Note that if the viewport
field is Some
, this will not represent the size of the rendered area.
For logic that requires the size of the actually rendered area, prefer Camera::logical_viewport_size
.
sourcepub fn physical_target_size(&self) -> Option<UVec2>
pub fn physical_target_size(&self) -> Option<UVec2>
The full physical size of this camera’s RenderTarget
(in physical pixels),
ignoring custom viewport
configuration.
Note that if the viewport
field is Some
, this will not represent the size of the rendered area.
For logic that requires the size of the actually rendered area, prefer Camera::physical_viewport_size
.
pub fn target_scaling_factor(&self) -> Option<f32>
sourcepub fn clip_from_view(&self) -> Mat4
pub fn clip_from_view(&self) -> Mat4
The projection matrix computed using this camera’s CameraProjection
.
sourcepub fn world_to_viewport(
&self,
camera_transform: &GlobalTransform,
world_position: Vec3
) -> Option<Vec2>
pub fn world_to_viewport( &self, camera_transform: &GlobalTransform, world_position: Vec3 ) -> Option<Vec2>
Given a position in world space, use the camera to compute the viewport-space coordinates.
To get the coordinates in Normalized Device Coordinates, you should use
world_to_ndc
.
Returns None
if any of these conditions occur:
- The computed coordinates are beyond the near or far plane
- The logical viewport size cannot be computed. See
logical_viewport_size
- The world coordinates cannot be mapped to the Normalized Device Coordinates. See
world_to_ndc
May also panic ifglam_assert
is enabled. Seeworld_to_ndc
.
sourcepub fn viewport_to_world(
&self,
camera_transform: &GlobalTransform,
viewport_position: Vec2
) -> Option<Ray3d>
pub fn viewport_to_world( &self, camera_transform: &GlobalTransform, viewport_position: Vec2 ) -> Option<Ray3d>
Returns a ray originating from the camera, that passes through everything beyond viewport_position
.
The resulting ray starts on the near plane of the camera.
If the camera’s projection is orthographic the direction of the ray is always equal to camera_transform.forward()
.
To get the world space coordinates with Normalized Device Coordinates, you should use
ndc_to_world
.
Returns None
if any of these conditions occur:
- The logical viewport size cannot be computed. See
logical_viewport_size
- The near or far plane cannot be computed. This can happen if the
camera_transform
, theworld_position
, or the projection matrix defined byCameraProjection
containNAN
. Panics if the projection matrix is null andglam_assert
is enabled.
sourcepub fn viewport_to_world_2d(
&self,
camera_transform: &GlobalTransform,
viewport_position: Vec2
) -> Option<Vec2>
pub fn viewport_to_world_2d( &self, camera_transform: &GlobalTransform, viewport_position: Vec2 ) -> Option<Vec2>
Returns a 2D world position computed from a position on this Camera
’s viewport.
Useful for 2D cameras and other cameras with an orthographic projection pointing along the Z axis.
To get the world space coordinates with Normalized Device Coordinates, you should use
ndc_to_world
.
Returns None
if any of these conditions occur:
- The logical viewport size cannot be computed. See
logical_viewport_size
- The viewport position cannot be mapped to the world. See
ndc_to_world
May panic. Seendc_to_world
.
sourcepub fn world_to_ndc(
&self,
camera_transform: &GlobalTransform,
world_position: Vec3
) -> Option<Vec3>
pub fn world_to_ndc( &self, camera_transform: &GlobalTransform, world_position: Vec3 ) -> Option<Vec3>
Given a position in world space, use the camera’s viewport to compute the Normalized Device Coordinates.
When the position is within the viewport the values returned will be between -1.0 and 1.0 on the X and Y axes,
and between 0.0 and 1.0 on the Z axis.
To get the coordinates in the render target’s viewport dimensions, you should use
world_to_viewport
.
Returns None
if the camera_transform
, the world_position
, or the projection matrix defined by CameraProjection
contain NAN
.
Panics if the camera_transform
contains NAN
and the glam_assert
feature is enabled.
sourcepub fn ndc_to_world(
&self,
camera_transform: &GlobalTransform,
ndc: Vec3
) -> Option<Vec3>
pub fn ndc_to_world( &self, camera_transform: &GlobalTransform, ndc: Vec3 ) -> Option<Vec3>
Given a position in Normalized Device Coordinates, use the camera’s viewport to compute the world space position.
When the position is within the viewport the values returned will be between -1.0 and 1.0 on the X and Y axes,
and between 0.0 and 1.0 on the Z axis.
To get the world space coordinates with the viewport position, you should use
world_to_viewport
.
Returns None
if the camera_transform
, the world_position
, or the projection matrix defined by CameraProjection
contain NAN
.
Panics if the projection matrix is null and glam_assert
is enabled.
Trait Implementations§
source§impl Component for Camera
impl Component for Camera
source§const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table
const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table
source§fn register_component_hooks(_hooks: &mut ComponentHooks)
fn register_component_hooks(_hooks: &mut ComponentHooks)
ComponentHooks
.source§impl FromReflect for Camerawhere
Self: Any + Send + Sync,
Option<Viewport>: FromReflect + TypePath + RegisterForReflection,
isize: FromReflect + TypePath + RegisterForReflection,
bool: FromReflect + TypePath + RegisterForReflection,
ClearColorConfig: FromReflect + TypePath + RegisterForReflection,
impl FromReflect for Camerawhere
Self: Any + Send + Sync,
Option<Viewport>: FromReflect + TypePath + RegisterForReflection,
isize: FromReflect + TypePath + RegisterForReflection,
bool: FromReflect + TypePath + RegisterForReflection,
ClearColorConfig: FromReflect + TypePath + RegisterForReflection,
source§fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
Self
from a reflected value.source§fn take_from_reflect(
reflect: Box<dyn Reflect>
) -> Result<Self, Box<dyn Reflect>>
fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>
Self
using,
constructing the value using from_reflect
if that fails. Read moresource§impl GetTypeRegistration for Camerawhere
Self: Any + Send + Sync,
Option<Viewport>: FromReflect + TypePath + RegisterForReflection,
isize: FromReflect + TypePath + RegisterForReflection,
bool: FromReflect + TypePath + RegisterForReflection,
ClearColorConfig: FromReflect + TypePath + RegisterForReflection,
impl GetTypeRegistration for Camerawhere
Self: Any + Send + Sync,
Option<Viewport>: FromReflect + TypePath + RegisterForReflection,
isize: FromReflect + TypePath + RegisterForReflection,
bool: FromReflect + TypePath + RegisterForReflection,
ClearColorConfig: FromReflect + TypePath + RegisterForReflection,
source§fn get_type_registration() -> TypeRegistration
fn get_type_registration() -> TypeRegistration
TypeRegistration
for this type.source§fn register_type_dependencies(registry: &mut TypeRegistry)
fn register_type_dependencies(registry: &mut TypeRegistry)
source§impl Reflect for Camerawhere
Self: Any + Send + Sync,
Option<Viewport>: FromReflect + TypePath + RegisterForReflection,
isize: FromReflect + TypePath + RegisterForReflection,
bool: FromReflect + TypePath + RegisterForReflection,
ClearColorConfig: FromReflect + TypePath + RegisterForReflection,
impl Reflect for Camerawhere
Self: Any + Send + Sync,
Option<Viewport>: FromReflect + TypePath + RegisterForReflection,
isize: FromReflect + TypePath + RegisterForReflection,
bool: FromReflect + TypePath + RegisterForReflection,
ClearColorConfig: FromReflect + TypePath + RegisterForReflection,
source§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
&mut dyn Any
.source§fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
source§fn as_reflect(&self) -> &dyn Reflect
fn as_reflect(&self) -> &dyn Reflect
source§fn as_reflect_mut(&mut self) -> &mut dyn Reflect
fn as_reflect_mut(&mut self) -> &mut dyn Reflect
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Reflect
trait object. Read moresource§fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
source§fn reflect_kind(&self) -> ReflectKind
fn reflect_kind(&self) -> ReflectKind
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
source§fn reflect_owned(self: Box<Self>) -> ReflectOwned
fn reflect_owned(self: Box<Self>) -> ReflectOwned
source§fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
source§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
source§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
source§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
source§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
source§impl Struct for Camerawhere
Self: Any + Send + Sync,
Option<Viewport>: FromReflect + TypePath + RegisterForReflection,
isize: FromReflect + TypePath + RegisterForReflection,
bool: FromReflect + TypePath + RegisterForReflection,
ClearColorConfig: FromReflect + TypePath + RegisterForReflection,
impl Struct for Camerawhere
Self: Any + Send + Sync,
Option<Viewport>: FromReflect + TypePath + RegisterForReflection,
isize: FromReflect + TypePath + RegisterForReflection,
bool: FromReflect + TypePath + RegisterForReflection,
ClearColorConfig: FromReflect + TypePath + RegisterForReflection,
source§fn field(&self, name: &str) -> Option<&dyn Reflect>
fn field(&self, name: &str) -> Option<&dyn Reflect>
name
as a &dyn Reflect
.source§fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
name
as a
&mut dyn Reflect
.source§fn field_at(&self, index: usize) -> Option<&dyn Reflect>
fn field_at(&self, index: usize) -> Option<&dyn Reflect>
index
as a
&dyn Reflect
.source§fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
index
as a &mut dyn Reflect
.source§fn name_at(&self, index: usize) -> Option<&str>
fn name_at(&self, index: usize) -> Option<&str>
index
.source§fn iter_fields(&self) -> FieldIter<'_>
fn iter_fields(&self) -> FieldIter<'_>
source§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.source§impl TypePath for Camera
impl TypePath for Camera
source§fn type_path() -> &'static str
fn type_path() -> &'static str
source§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
source§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
source§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
source§impl Typed for Camerawhere
Self: Any + Send + Sync,
Option<Viewport>: FromReflect + TypePath + RegisterForReflection,
isize: FromReflect + TypePath + RegisterForReflection,
bool: FromReflect + TypePath + RegisterForReflection,
ClearColorConfig: FromReflect + TypePath + RegisterForReflection,
impl Typed for Camerawhere
Self: Any + Send + Sync,
Option<Viewport>: FromReflect + TypePath + RegisterForReflection,
isize: FromReflect + TypePath + RegisterForReflection,
bool: FromReflect + TypePath + RegisterForReflection,
ClearColorConfig: FromReflect + TypePath + RegisterForReflection,
Auto Trait Implementations§
impl Freeze for Camera
impl !RefUnwindSafe for Camera
impl Send for Camera
impl Sync for Camera
impl Unpin for Camera
impl !UnwindSafe for Camera
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<C> Bundle for Cwhere
C: Component,
impl<C> Bundle for Cwhere
C: Component,
fn component_ids( components: &mut Components, storages: &mut Storages, ids: &mut impl FnMut(ComponentId) )
unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
source§fn get_component_ids(
components: &Components,
ids: &mut impl FnMut(Option<ComponentId>)
)
fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>) )
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<C> DynamicBundle for Cwhere
C: Component,
impl<C> DynamicBundle for Cwhere
C: Component,
fn get_components(self, func: &mut impl FnMut(StorageType, OwningPtr<'_>))
source§impl<T> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere
T: TypePath,
source§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
TypePath::type_path
.source§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
source§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
TypePath::type_ident
.source§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
TypePath::crate_name
.source§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.source§impl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere
S: Struct,
source§impl<T> GetPath for T
impl<T> GetPath for T
source§fn reflect_path<'p>(
&self,
path: impl ReflectPath<'p>
) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'p>( &self, path: impl ReflectPath<'p> ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn reflect_path_mut<'p>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
path
. Read moresource§fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read more