Struct TuiFrame 

pub struct TuiFrame {
    pub screen: Rect,
    pub areas: Vec<(Entity, Rect)>,
    pub overlays: Vec<Rect>,
}

Where the last frame drew each part of the screen: for a plugin that writes to the terminal itself after the frame (TerminalWrite), such as an image over the rows its content renderer left blank, which finds those rows in a pane’s DrawnTranscript (see TuiFrame::screen_row) and leaves out what an overlay covers. The view writes it after each frame it draws, in TuiSystems::Render; read it after that. All empty in a run without the terminal.

Fields

screen: Rect

The whole screen.

areas: Vec<(Entity, Rect)>

Each panel drawn, the default screen’s transcript, input and status line among them, with its area, in the order drawn.

overlays: Vec<Rect>

What was drawn over the rest: the panels placed over the screen, the picker or question, the completion list, a question’s text above the input.

Implementations

impl TuiFrame

pub fn screen_row(&self, drawn: &DrawnTranscript, row: usize) -> Option<u16>

The screen row the row of drawn (a pane’s transcript this frame drew) is on, when it is on screen.

pub fn area(&self, entity: Entity) -> Option<Rect>

Where the panel entity was drawn, if it was.

pub fn covered(&self, area: Rect) -> bool

Whether an overlay covers any of area.

Trait Implementations

impl Clone for TuiFrame

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for TuiFrame

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]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Debug for TuiFrame

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

Formats the value using the given formatter.

impl Default for TuiFrame

fn default() -> Self

Returns the “default value” for a type.

impl Eq for TuiFrame

impl PartialEq for TuiFrame

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Resource for TuiFrame

where Self: Send + Sync + 'static,

impl StructuralPartialEq for TuiFrame