Struct EguiRenderOutput

pub struct EguiRenderOutput {
    pub paint_jobs: Arc<Vec<ClippedPrimitive>>,
    pub textures_delta: Arc<TexturesDelta>,
}

Is used for storing Egui shapes and textures delta.

Fields

paint_jobs: Arc<Vec<ClippedPrimitive>>

Pairs of rectangles and paint commands.

The field gets populated during the EguiPostUpdateSet::ProcessOutput system (belonging to bevy’s PostUpdate) and processed during egui_node::EguiNode’s update.

Value is wrapped in Arc to improve ExtractComponent performance.

textures_delta: Arc<TexturesDelta>

The change in egui textures since last frame.

Value is wrapped in Arc to improve ExtractComponent performance.

Implementations

impl EguiRenderOutput

pub fn is_empty(&self) -> bool

Returns true if the output has no Egui shapes and no textures delta.

Trait Implementations

impl Clone for EguiRenderOutput

fn clone(&self) -> EguiRenderOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for EguiRenderOutput

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, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

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 register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

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]

impl Debug for EguiRenderOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EguiRenderOutput

fn default() -> EguiRenderOutput

Returns the “default value” for a type.

impl ExtractComponent for EguiRenderOutput

where Self: Clone,

type QueryData = &'static EguiRenderOutput

ECS ReadOnlyQueryData to fetch the components to extract.

type QueryFilter = ()

Filters the entities with additional constraints.

type Out = EguiRenderOutput

The output from extraction.

fn extract_component(item: QueryItem<'_, Self::QueryData>) -> Option<Self::Out>

Defines how the component is transferred into the “render world”.