cotis-layout 0.1.0-alpha.1

Flexbox-style layout engine for Cotis
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! Shared types and helpers for cotis-layout examples (cotis 0.1.0-alpha + cotis-layout 0.1.0-alpha + cotis-pipes).

use cotis::cotis_app::{CotisApp, RenderApp, UiFn};
use cotis::utils::ElementIdConfig;
use cotis_defaults::element_configs::image_config::ImageConfig;
use cotis_defaults::element_configs::premade_configs::GenericElementConfig;
use cotis_defaults::element_configs::style::CotisStyle;
use cotis_defaults::render_commands::render_t_list::RenderTList;
use cotis_defaults::render_commands::{Border, ClipEnd, ClipStart, Image, Rectangle, Text};
use cotis_layout::layout_struct::RenderCommandOutput;
use cotis_layout::preamble::CotisLayoutManager;
use cotis_pipes::cotis_layout_pipes::CotisLayoutToRenderListPipeForGenerics;
use cotis_raylib::cotis_defaults_images::{JPEGImage, PNGImage, PathBasedImage, SVGImage};
use cotis_raylib::prelude::RaylibRender;
use cotis_utils::math::Dimensions;

/// Element config with path-based images from cotis-defaults.
pub type ExampleConfig = GenericElementConfig<'static, PathBasedImage, ()>;

/// Clip + rectangle + image + border + text pipeline decoded by [`CotisLayoutToRenderListPipeForGenerics`].
pub type StandardRenderCmds = RenderTList<
    ClipStart<'static, ()>,
    RenderTList<
        ClipEnd,
        RenderTList<
            Rectangle<'static, ()>,
            RenderTList<
                Image<'static, PathBasedImage, ()>,
                RenderTList<Border<'static, ()>, RenderTList<Text<'static, ()>, ()>>,
            >,
        >,
    >,
>;

/// Rectangle + image + border + text pipeline (no clip).
pub type SimpleRenderCmds = RenderTList<
    Rectangle<'static, ()>,
    RenderTList<
        Image<'static, PathBasedImage, ()>,
        RenderTList<Border<'static, ()>, RenderTList<Text<'static, ()>, ()>>,
    >,
>;

pub type ExampleCotisApp =
    CotisApp<RaylibRender, CotisLayoutManager, CotisLayoutToRenderListPipeForGenerics>;

pub fn new_cotis_app(renderer: RaylibRender, dimensions: Dimensions) -> ExampleCotisApp {
    let manager = CotisLayoutManager::new(dimensions);
    CotisApp::new(renderer, manager, CotisLayoutToRenderListPipeForGenerics)
}

/// Minimal element config for leaf nodes (text-only children).
pub fn empty_example_config() -> ExampleConfig {
    ExampleConfig {
        id_config: ElementIdConfig::new_empty(),
        style: CotisStyle::default(),
        image: None,
        custom: None,
        extra_data: None,
    }
}

pub fn image_config(image: PathBasedImage) -> ImageConfig<'static, PathBasedImage> {
    ImageConfig::new_owned(image)
}

/// Example assets shipped under `examples/`.
pub const APPLE_IMAGE_PATH: &str = "./examples/Apple.png";
pub const APPLE_JPEG_IMAGE_PATH: &str = "./examples/Apple.jpg";
pub const CALENDAR_PNG_PATH: &str = "./examples/calendar_icon_2.png";
/// Demonstrates [`SVGImage`]; uses the calendar PNG asset until an `.svg` is added.
pub const CALENDAR_SVG_PATH: &str = "./examples/calendar_icon_2.png";

/// Example images loaded from local asset paths.
pub mod example_images {
    use super::{
        APPLE_IMAGE_PATH, APPLE_JPEG_IMAGE_PATH, CALENDAR_PNG_PATH, CALENDAR_SVG_PATH, JPEGImage,
        PNGImage, PathBasedImage, SVGImage,
    };

    pub fn apple_png() -> PathBasedImage {
        PathBasedImage::Png(PNGImage::new_const(APPLE_IMAGE_PATH))
    }

    pub fn calendar_png() -> PathBasedImage {
        PathBasedImage::Png(PNGImage::new_const(CALENDAR_PNG_PATH))
    }

    pub fn apple_jpeg() -> PathBasedImage {
        PathBasedImage::Jpeg(JPEGImage::new_const(APPLE_JPEG_IMAGE_PATH))
    }

    pub fn calendar_svg() -> PathBasedImage {
        PathBasedImage::Svg(SVGImage::new_const(CALENDAR_SVG_PATH))
    }
}

pub fn compute_frame<'layout, Cmds, Ui>(app: &'layout mut ExampleCotisApp, ui: Ui)
where
    RaylibRender: cotis::renders::CotisRenderer<Cmds>,
    CotisLayoutToRenderListPipeForGenerics:
        cotis::pipes::LayoutRenderPipe<RenderCommandOutput<ExampleConfig>, Cmds>,
    Ui: for<'a> UiFn<
            'a,
            cotis_layout::preamble::CotisLayoutRun<'layout, ExampleConfig>,
            ExampleConfig,
        >,
{
    RenderApp::<
        ExampleConfig,
        RenderCommandOutput<ExampleConfig>,
        Cmds,
        RaylibRender,
        CotisLayoutManager,
    >::compute_frame(app, ui);
}