Struct SvgSurface 

pub struct SvgSurface {
    pub doc: Option<Handle<SvgDocument>>,
    pub view_box: Option<ViewBox>,
    pub last_size: UVec2,
    pub dirty: bool,
}

The element-owned raster surface of a node that displays an SVG.

Present on an <image> whose src names an .svg asset (svg mode) and on the JSX <svg> element: the node’s ImageNode texture is an element-owned pixel buffer — never a path loaded as a Bevy Image — and the svg raster system repaints it at the laid-out size whenever the layout, the document, or (JSX mode) the shape children change.

Fields

doc: Option<Handle<SvgDocument>>

The parsed document to rasterize. Some = an svg-mode <image> (file mode); None = a JSX <svg> element, whose document is built from its SvgShape children instead of an asset.

view_box: Option<ViewBox>

The JSX <svg> element’s coordinate system: the user-unit rect mapped onto the laid-out box. None = logical-pixel space — and always None in file mode (the document carries its own viewBox).

last_size: UVec2

Physical-px size of the last raster; UVec2::ZERO before the first.

dirty: bool

Repaint requested: set on mount and whenever the document handle (or the JSX viewBox) changes; the raster system clears it after painting. JSX shape and child-list changes intentionally do not set this; the rasterizer derives that dirt itself (Changed<SvgShape>/Changed<Children>, plus RemovedComponents<Children> for an emptied container).

Implementations

impl SvgSurface

pub fn new(doc: Handle<SvgDocument>) -> Self

A fresh file-mode surface awaiting its first raster of doc.

pub fn jsx(view_box: Option<ViewBox>) -> Self

A fresh JSX-mode surface (no document asset — the picture is the element’s SvgShape children) awaiting its first raster.

Trait Implementations

impl Component for SvgSurface

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]