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,
}
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.
Warning: we are still working on this feature. If MSAA is enabled, there will be artifacts in
some cases. When rendering with WebGL, this will crash if MSAA is enabled.
See https://github.com/bevyengine/bevy/pull/3425 for details.
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.
Implementations§
§impl Camera
impl Camera
pub 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.
pub fn physical_viewport_rect(&self) -> Option<(UVec2, UVec2)>
pub fn physical_viewport_rect(&self) -> Option<(UVec2, UVec2)>
The rendered physical bounds (minimum, maximum) 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
.
pub fn logical_viewport_rect(&self) -> Option<(Vec2, Vec2)>
pub fn logical_viewport_rect(&self) -> Option<(Vec2, Vec2)>
The rendered logical bounds (minimum, maximum) 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
.
pub 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
.
pub fn physical_viewport_size(&self) -> Option<UVec2>
pub fn physical_viewport_size(&self) -> Option<UVec2>
The physical 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 physical size of
the current RenderTarget
.
For logic that requires the full physical size of the RenderTarget
, prefer Camera::physical_target_size
.
pub 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
.
pub fn physical_target_size(&self) -> Option<UVec2>
pub fn physical_target_size(&self) -> Option<UVec2>
The full physical 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::physical_viewport_size
.
pub fn projection_matrix(&self) -> Mat4
pub fn projection_matrix(&self) -> Mat4
The projection matrix computed using this camera’s CameraProjection
.
pub 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
.
pub fn viewport_to_world(
&self,
camera_transform: &GlobalTransform,
viewport_position: Vec2
) -> Option<Ray>
pub fn viewport_to_world( &self, camera_transform: &GlobalTransform, viewport_position: Vec2 ) -> Option<Ray>
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
.
pub 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
.
pub 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
.
pub 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
.
Trait Implementations§
§impl FromReflect for Camerawhere
Option<Viewport>: FromReflect,
isize: FromReflect,
bool: FromReflect,
impl FromReflect for Camerawhere Option<Viewport>: FromReflect, isize: FromReflect, bool: FromReflect,
§fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Camera>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Camera>
Self
from a reflected value.§impl GetTypeRegistration for Camerawhere
Option<Viewport>: Reflect,
isize: Reflect,
bool: Reflect,
ComputedCameraValues: Any + Send + Sync,
RenderTarget: Any + Send + Sync,
CameraOutputMode: Any + Send + Sync,
impl GetTypeRegistration for Camerawhere Option<Viewport>: Reflect, isize: Reflect, bool: Reflect, ComputedCameraValues: Any + Send + Sync, RenderTarget: Any + Send + Sync, CameraOutputMode: Any + Send + Sync,
§impl Reflect for Camerawhere
Option<Viewport>: Reflect,
isize: Reflect,
bool: Reflect,
ComputedCameraValues: Any + Send + Sync,
RenderTarget: Any + Send + Sync,
CameraOutputMode: Any + Send + Sync,
impl Reflect for Camerawhere Option<Viewport>: Reflect, isize: Reflect, bool: Reflect, ComputedCameraValues: Any + Send + Sync, RenderTarget: Any + Send + Sync, CameraOutputMode: Any + Send + Sync,
§fn get_type_info(&self) -> &'static TypeInfo
fn get_type_info(&self) -> &'static TypeInfo
§fn into_any(self: Box<Camera, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<Camera, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Any>
.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut dyn Any
.§fn into_reflect(self: Box<Camera, Global>) -> Box<dyn Reflect + 'static, Global>
fn into_reflect(self: Box<Camera, Global>) -> Box<dyn Reflect + 'static, Global>
§fn as_reflect(&self) -> &(dyn Reflect + 'static)
fn as_reflect(&self) -> &(dyn Reflect + 'static)
§fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
§fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
Reflect
trait object. Read more§fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
fn set( &mut self, value: Box<dyn Reflect + 'static, Global> ) -> Result<(), Box<dyn Reflect + 'static, Global>>
§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
§fn reflect_owned(self: Box<Camera, Global>) -> ReflectOwned
fn reflect_owned(self: Box<Camera, Global>) -> ReflectOwned
§fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
§impl Struct for Camerawhere
Option<Viewport>: Reflect,
isize: Reflect,
bool: Reflect,
ComputedCameraValues: Any + Send + Sync,
RenderTarget: Any + Send + Sync,
CameraOutputMode: Any + Send + Sync,
impl Struct for Camerawhere Option<Viewport>: Reflect, isize: Reflect, bool: Reflect, ComputedCameraValues: Any + Send + Sync, RenderTarget: Any + Send + Sync, CameraOutputMode: Any + Send + Sync,
§fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
name
as a &dyn Reflect
.§fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>
fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>
name
as a
&mut dyn Reflect
.§fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>
fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>
index
as a
&dyn Reflect
.§fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
index
as a &mut dyn Reflect
.§fn iter_fields(&self) -> FieldIter<'_> ⓘ
fn iter_fields(&self) -> FieldIter<'_> ⓘ
§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.Auto Trait Implementations§
impl RefUnwindSafe for Camera
impl Send for Camera
impl Sync for Camera
impl Unpin for Camera
impl UnwindSafe for Camera
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.§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) -> Cwhere F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a, Aligned>,
fn get_components( self, func: &mut impl FnMut(StorageType, OwningPtr<'_, Aligned>) )
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§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.§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.§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere T: Default,
§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World§impl<T> GetPath for Twhere
T: Reflect,
impl<T> GetPath for Twhere T: Reflect,
§fn reflect_path<'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'r, 'p>( &'r self, path: &'p str ) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read more§fn reflect_path_mut<'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'r, 'p>( &'r mut self, path: &'p str ) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read more