Struct CanvasSurface 

pub struct CanvasSurface { /* private fields */ }

The drawing state of a canvas element: a retained premultiplied pixel buffer, the persistent raster state, and the queue of commands recorded since the last paint. Paint accumulates — a batch draws on top of what is already there — except when replace is set (the declarative draw prop: clear + replay) or the laid-out size changes (clear-on-resize).

Implementations

impl CanvasSurface

pub fn new(cmds: Vec<DrawCmd>) -> Self

A fresh surface whose first paint clears and replays cmds (the element’s initial declarative draw prop; empty for imperative-only canvases).

pub fn enqueue(&mut self, cmds: Vec<DrawCmd>)

Append imperative commands (an Op::Draw from a canvas handle). Paint accumulates on the retained pixels.

pub fn set_display_list(&mut self, cmds: Vec<DrawCmd>)

Replace the picture with cmds (a changed declarative draw prop): the next paint clears the surface, resets raster state, and replays. Anything still pending is dropped — it would be erased anyway.

Trait Implementations

impl Component for CanvasSurface

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