Struct ViewTarget

pub struct ViewTarget { /* private fields */ }

Implementations

impl ViewTarget

pub const TEXTURE_FORMAT_HDR: TextureFormat = TextureFormat::Rgba16Float

pub fn get_color_attachment(&self) -> RenderPassColorAttachment<'_>

Retrieve this target’s main texture’s color attachment.

pub fn get_unsampled_color_attachment(&self) -> RenderPassColorAttachment<'_>

Retrieve this target’s “unsampled” main texture’s color attachment.

pub fn main_texture(&self) -> &Texture

The “main” unsampled texture.

pub fn main_texture_other(&self) -> &Texture

The other “main” unsampled texture. In most cases you should use Self::main_texture instead and never this. The textures will naturally be swapped when Self::post_process_write is called.

A use case for this is to be able to prepare a bind group for all main textures ahead of time.

pub fn main_texture_view(&self) -> &TextureView

The “main” unsampled texture.

pub fn main_texture_other_view(&self) -> &TextureView

The other “main” unsampled texture view. In most cases you should use Self::main_texture_view instead and never this. The textures will naturally be swapped when Self::post_process_write is called.

A use case for this is to be able to prepare a bind group for all main textures ahead of time.

pub fn sampled_main_texture(&self) -> Option<&Texture>

The “main” sampled texture.

pub fn sampled_main_texture_view(&self) -> Option<&TextureView>

The “main” sampled texture view.

pub fn main_texture_format(&self) -> TextureFormat

pub fn is_hdr(&self) -> bool

Returns true if and only if the main texture is Self::TEXTURE_FORMAT_HDR

pub fn out_texture(&self) -> &TextureView

The final texture this view will render to.

pub fn out_texture_color_attachment( &self, clear_color: Option<LinearRgba>, ) -> RenderPassColorAttachment<'_>

pub fn out_texture_format(&self) -> TextureFormat

The format of the final texture this view will render to

pub fn post_process_write(&self) -> PostProcessWrite<'_>

This will start a new “post process write”, which assumes that the caller will write the PostProcessWrite’s source to the destination.

source is the “current” main texture. This will internally flip this ViewTarget’s main texture to the destination texture, so the caller must ensure source is copied to destination, with or without modifications. Failing to do so will cause the current main texture information to be lost.

Trait Implementations

impl Component for ViewTarget

where Self: 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, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

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 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]