Enum bevy::render::camera::RenderTarget

pub enum RenderTarget {
    Window(WindowRef),
    Image(Handle<Image>),
    TextureView(ManualTextureViewHandle),
}

The “target” that a Camera will render to. For example, this could be a Window swapchain or an Image.

Variants

Window(WindowRef)

Window to which the camera’s view is rendered.

Image(Handle<Image>)

Image to which the camera’s view is rendered.

TextureView(ManualTextureViewHandle)

Texture View to which the camera’s view is rendered. Useful when the texture view needs to be created outside of Bevy, for example OpenXR.

Implementations

impl RenderTarget

pub fn normalize( &self, primary_window: Option<Entity> ) -> Option<NormalizedRenderTarget>

Normalize the render target down to a more concrete value, mostly used for equality comparisons.

pub fn as_image(&self) -> Option<&Handle<Image>>

Get a handle to the render target’s image, or None if the render target is another variant.

Trait Implementations

impl Clone for RenderTarget

fn clone(&self) -> RenderTarget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RenderTarget

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

Formats the value using the given formatter.

impl Default for RenderTarget

fn default() -> RenderTarget

Returns the “default value” for a type.

impl Enum for RenderTarget

where RenderTarget: Any + Send + Sync, WindowRef: FromReflect + TypePath, Handle<Image>: FromReflect + TypePath, ManualTextureViewHandle: FromReflect + TypePath,

fn field(&self, __name_param: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut( &mut self, __name_param: &str ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut( &mut self, __index_param: usize ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

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

Returns the index of the field (in the current variant) with the given name.

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

Returns the name of the field (in the current variant) with the given index.

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

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

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

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl From<Handle<Image>> for RenderTarget

fn from(handle: Handle<Image>) -> RenderTarget

Converts to this type from the input type.

impl FromReflect for RenderTarget

where RenderTarget: Any + Send + Sync, WindowRef: FromReflect + TypePath, Handle<Image>: FromReflect + TypePath, ManualTextureViewHandle: FromReflect + TypePath,

fn from_reflect(__param0: &(dyn Reflect + 'static)) -> Option<RenderTarget>

Constructs a concrete instance of Self from a reflected value.

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

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for RenderTarget

where RenderTarget: Any + Send + Sync, WindowRef: FromReflect + TypePath, Handle<Image>: FromReflect + TypePath, ManualTextureViewHandle: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for RenderTarget

where RenderTarget: Any + Send + Sync, WindowRef: FromReflect + TypePath, Handle<Image>: FromReflect + TypePath, ManualTextureViewHandle: FromReflect + TypePath,

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

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<RenderTarget>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<RenderTarget>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

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

Clones the value as a Reflect trait object.

fn set( &mut self, __value_param: Box<dyn Reflect> ) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, __value_param: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

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

Returns an immutable enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

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

Returns an owned enumeration of “kinds” of type.

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

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl TypePath for RenderTarget

where RenderTarget: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for RenderTarget

where RenderTarget: Any + Send + Sync, WindowRef: FromReflect + TypePath, Handle<Image>: FromReflect + TypePath, ManualTextureViewHandle: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.