Struct Surfaces 

pub struct Surfaces { /* private fields */ }

The registry of named UI surfaces. Insert it (the plugin does) and have app systems create surfaces, then use the returned handle as a material texture.

Implementations

impl Surfaces

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

Allocate an offscreen texture and register it under name, returning the Handle<Image> to use as a material texture. React’s <surface name={name}> renders its subtree into it. Re-creating an existing name replaces the texture (the old camera is dropped on the next bind).

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 surface for one more render (a RenderMode::Snapshot re-captures; a RenderMode::Live surface renders every frame anyway).

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

Switch a surface’s render model at runtime.

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

Drop a surface. Its UI camera is despawned on the next bind_surfaces; React <surface> roots bound to the name hide until it is re-registered.

Trait Implementations

impl Component for Surfaces

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 Surfaces

fn default() -> Surfaces

Returns the “default value” for a type.

impl Resource for Surfaces

where Self: Send + Sync + 'static,