Struct Deferred 

pub struct Deferred { /* private fields */ }

An element that draws its child after the rest of the tree, in priority order.

The child is laid out in place, so it is part of the element tree. Its prepaint and paint run later, in a separate pass. Each deferred child is drawn after the elements around it, and deferred children are drawn in ascending priority, so a higher priority draws on top. Create one with deferred.

A deferred child may create more deferred children. GPUI processes these in rounds, and the frame panics if they nest more than ten rounds deep. Keep such nesting shallow.

Implementations

impl Deferred

pub fn priority(self, value: impl Into<DeferredPriority>) -> Self

Sets the draw priority. Deferred elements draw in ascending priority, so a higher value draws on top of the ones below it. Accepts a number, or a DeferredPriority.

pub fn content_mask(self, value: ContentMask<Pixels>) -> Self

Clips the deferred element to mask while it is prepainted and painted, so the clipped area also doesn’t receive mouse input.

Without a mask, no extra clipping is applied.

impl Deferred

pub fn priority_auto(self) -> Self

Sets the priority to one more than the enclosing deferred element’s, or to 1 when no deferred element encloses this one.

A deferred element is enclosing when it is being prepainted and creates this one, directly or through other elements. Use it for nested popups, so that each level draws above the last.

Trait Implementations

impl Element for Deferred

type RequestLayoutState = ()

The state that Element::request_layout returns for the later phases.

type PrepaintState = ()

The state that Element::prepaint returns for Element::paint.

fn id(&self) -> Option<ElementId>

Returns the element’s identity, or None if it has none.

fn source_location(&self) -> Option<&'static Location<'static>>

Returns where this element was created, for the inspector and debug output.

fn request_layout( &mut self, _id: Option<&GlobalElementId>, _inspector_id: Option<&InspectorElementId>, window: &mut Window, cx: &mut App, ) -> (LayoutId, ())

Requests a layout node from Taffy, and returns it with the state the later phases need.

fn prepaint( &mut self, _id: Option<&GlobalElementId>, _inspector_id: Option<&InspectorElementId>, _bounds: Bounds<Pixels>, _request_layout: &mut Self::RequestLayoutState, window: &mut Window, _cx: &mut App, )

Runs once the element’s bounds are known, and returns the state that paint needs.

fn paint( &mut self, _id: Option<&GlobalElementId>, _inspector_id: Option<&InspectorElementId>, _bounds: Bounds<Pixels>, _request_layout: &mut Self::RequestLayoutState, _prepaint: &mut Self::PrepaintState, _window: &mut Window, _cx: &mut App, )

Draws the element. Runs after prepaint, once per frame.

fn a11y_role(&self) -> Option<Role>

Returns the accessible role for this element, if any. Elements that return None have no accessibility node unless Element::is_a11y_hidden returns true.

fn is_a11y_hidden(&self) -> bool

Whether assistive technology should ignore this element and its descendants.

fn write_a11y_info(&self, _node: &mut Node)

Write accessibility properties to the given node. GPUI calls this only when Element::a11y_role returns Some or Element::is_a11y_hidden returns true.

fn a11y_synthetic_children( &mut self, _prepaint: &mut Self::PrepaintState, _builder: &mut A11ySubtreeBuilder<'_>, )

Add synthetic child nodes to an Element. The element must have an .id(). It must also have a .role() or return true from Element::is_a11y_hidden.

fn into_any(self) -> AnyElement

Convert this element into a dynamically-typed AnyElement.

impl IntoElement for Deferred

type Element = Deferred

The element type that this type converts into.

fn into_element(self) -> Self::Element

Converts self into an Element.

fn into_any_element(self) -> AnyElement

Converts self into an AnyElement, with its concrete type erased.