Interface PlotExample

examples_utils/src/lib.rs:4–30

Trait for examples that can be displayed in the demo gallery.

/// Trait for examples that can be displayed in the demo gallery.
pub trait PlotExample {
    /// The name of the example. Should match directory name.
    fn name(&self) -> &'static str;

    /// The title of the example.
    fn title(&self) -> &'static str;

    /// The description of the example.
    fn description(&self) -> &'static str;

    /// The tags of the example.
    fn tags(&self) -> &'static [&'static str];

    /// The thumbnail image of the example.
    /// Should be 192x192 pixels. It is automatically generated from the
    /// screenshot of the example.
    fn thumbnail_bytes(&self) -> &'static [u8];

    /// The code of the example.
    fn code_bytes(&self) -> &'static [u8];

    /// The UI of the example.
    fn show_ui(&mut self, ui: &mut egui::Ui) -> egui::Response;

    /// The controls for the example.
    fn show_controls(&mut self, ui: &mut egui::Ui) -> egui::Response;
}

#[doc(hidden)]
#[cfg(not(target_arch = "wasm32"))]