Struct RenderTargets 

pub struct RenderTargets { /* private fields */ }

The registry of named offscreen render targets. Insert it (the plugin does) and have app systems create targets as game state demands.

Implementations

impl RenderTargets

pub fn create( &mut self, images: &mut Assets<Image>, name: impl Into<String>, spec: RenderTargetSpec, ) -> RenderTarget

Allocate a render-target texture and register it under name, returning a RenderTarget whose camera_target a camera should point at. Re-creating an existing name replaces it.

pub fn register(&mut self, name: impl Into<String>, handle: Handle<Image>)

Register an app-owned texture under name — a procedurally generated, pre-rendered, or loaded Image the app already holds — so a <portal target> or a backgroundImage { texture } source can display it. Static content: nothing renders into, resizes, or invalidates it (the entry is inert to drive_render_targets); for live/continuously-updating content use create with a camera — and prefer a <portal> on the UI side. Re-registering an existing name replaces it.

pub fn get(&self, name: &str) -> Option<Handle<Image>>

The backing texture handle for name, if registered.

pub fn invalidate(&mut self, name: &str)

Mark a target for one more render (a RenderMode::Snapshot re-captures; a RenderMode::Live target is unaffected — it renders every frame anyway).

pub fn set_mode(&mut self, name: &str, mode: RenderMode)

Switch a target’s render model at runtime. Snapshot → Live reactivates the camera; Live → Snapshot renders one last frame, then freezes.

pub fn remove(&mut self, name: &str)

Drop a target. The app is responsible for despawning the camera/scene it spawned for it; portals bound to the name revert to a blank placeholder.

Trait Implementations

impl Component for RenderTargets

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = ::bevy::ecs::component::StorageType::SparseSet

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 relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

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_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard 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]

impl Default for RenderTargets

fn default() -> RenderTargets

Returns the “default value” for a type.

impl Resource for RenderTargets

where Self: Send + Sync + 'static,