Enum RenderCommandOutput 

pub enum RenderCommandOutput<Custom> {
    Element(RenderCommandOutputElement<Custom>),
    ClipStart(RenderCommandClipStart),
    ClipEnd(RenderCommandClipEnd),
}

One step in the layout-to-renderer command stream.

Emitted in depth-first tree order with z-index sorting applied per subtree root. Pipes translate each variant into renderer draw calls.

Examples

use cotis::utils::ElementIdConfig;
use cotis_layout::layout_struct::{
    RenderCommandClipEnd, RenderCommandClipStart, RenderCommandOutput,
    RenderCommandOutputElement,
};
use cotis_utils::math::BoundingBox;

let id = ElementIdConfig::new_empty().get_handle();
let bounds = BoundingBox { x: 0.0, y: 0.0, width: 100.0, height: 50.0 };

let element: RenderCommandOutput<&str> = RenderCommandOutput::Element(RenderCommandOutputElement {
    bounds,
    z_index: 0,
    text: None,
    custom: "my-payload",
});

let clip_start: RenderCommandOutput<()> = RenderCommandOutput::ClipStart(RenderCommandClipStart {
    bounds,
    id: id.clone(),
    z_index: 1,
});

let clip_end: RenderCommandOutput<()> = RenderCommandOutput::ClipEnd(RenderCommandClipEnd {
    bounds,
    id,
    z_index: 1,
});

assert!(matches!(element, RenderCommandOutput::Element(_)));
assert!(matches!(clip_start, RenderCommandOutput::ClipStart(_)));
assert!(matches!(clip_end, RenderCommandOutput::ClipEnd(_)));

Variants

Element(RenderCommandOutputElement<Custom>)

A sized and positioned element ready for rendering.

ClipStart(RenderCommandClipStart)

Begin clip scissor for a scroll/clip container.

ClipEnd(RenderCommandClipEnd)

End clip scissor for a scroll/clip container.

Trait Implementations

impl<Custom: Clone> Clone for RenderCommandOutput<Custom>

fn clone(&self) -> RenderCommandOutput<Custom>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Custom: Debug> Debug for RenderCommandOutput<Custom>

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

Formats the value using the given formatter.

impl<'frame, T> LayoutFrameManager<'frame, T, RenderCommandOutput<T>, CotisLayoutRun<'_, T>> for CotisLayoutRun<'_, T>

where T: CotisLayoutCompatible<'frame> + 'frame,

fn begin(&mut self) -> ConfiguredParentElement<'_, Self, T>

Begins configuration at the root of the UI tree for this frame.

fn end(self) -> impl Iterator<Item = RenderCommandOutput<T>>

Completes frame construction and returns the frame output iterator.

impl<'frame, T> LayoutManager<'frame, T, RenderCommandOutput<T>> for CotisLayoutManager

where T: CotisLayoutCompatible<'frame> + 'frame,

type ElementConfigurer<'layout> = CotisLayoutRun<'layout, T> where Self: 'layout

The configurator type used while constructing one frame.

fn begin_frame<'layout>( &'layout mut self, ) -> impl LayoutFrameManager<'frame, T, RenderCommandOutput<T>, Self::ElementConfigurer<'layout>>

where T: 'frame, RenderCommandOutput<T>: 'frame, Self: 'layout,

Starts a new frame and returns a frame manager used to build UI.