Struct EguiRenderToImage

pub struct EguiRenderToImage {
    pub handle: Handle<Image>,
    pub load_op: LoadOp<Color>,
}

Contexts with this component will render UI to a specified image.

You can create an entity just with this component, bevy_egui will initialize an EguiContext automatically.

Fields

handle: Handle<Image>

A handle of an image to render to.

load_op: LoadOp<Color>

Customizable LoadOp for the render node which will be created for this context.

You’ll likely want LoadOp::Clear, unless you need to draw the UI on top of existing pixels of the image.

Implementations

impl EguiRenderToImage

pub fn new(handle: Handle<Image>) -> Self

Creates a component from an image handle and sets EguiRenderToImage::load_op to `LoadOp::Clear.

Trait Implementations

impl Clone for EguiRenderToImage

fn clone(&self) -> EguiRenderToImage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for EguiRenderToImage

where Self: Send + Sync + 'static,

Required Components: EguiContext.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

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

impl Debug for EguiRenderToImage

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

Formats the value using the given formatter.

impl ExtractComponent for EguiRenderToImage

where Self: Clone,

type QueryData = &'static EguiRenderToImage

ECS ReadOnlyQueryData to fetch the components to extract.

type QueryFilter = ()

Filters the entities with additional constraints.

type Out = EguiRenderToImage

The output from extraction.

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

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