coffee 0.4.1

An opinionated 2D game engine focused on simplicity, explicitness, and type-safety
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

use crate::graphics::{Color, Frame};
use crate::load::Task;
use crate::ui::core::Layout;

/// The renderer of a user interface.
///
/// The implementor of this trait will also need to implement the `Renderer`
/// trait of the [widgets] you want to use.
///
/// [widgets]: ../widget/index.html
pub trait Renderer {
    /// The configuration of the renderer.
    ///
    /// It has to implement the `Default` trait.
    ///
    /// This type allows you to provide a way for your users to customize the
    /// renderer. For example, you could make the default text color and size of
    /// your configurable, support different fonts, etc.
    type Configuration: Default;

    /// Loads the renderer with the given configuration.
    fn load(config: Self::Configuration) -> Task<Self>
    where
        Self: Sized;

    /// Explains the [`Layout`] of an [`Element`] for debugging purposes.
    ///
    /// This will be called when [`Element::explain`] has been used. It should
    /// _explain_ the [`Layout`] graphically.
    ///
    /// [`Layout`]: struct.Layout.html
    /// [`Element`]: struct.Element.html
    /// [`Element::explain`]: struct.Element.html#method.explain
    fn explain(&mut self, layout: &Layout<'_>, color: Color);

    /// Flushes the renderer to draw on the given [`Frame`].
    ///
    /// This method will be called by the runtime after calling [`Widget::draw`]
    /// for all the widgets of the user interface.
    ///
    /// The recommended strategy to implement a [`Renderer`] is to use [`Batch`]
    /// and call [`Batch::draw`] here.
    ///
    /// [`Frame`]: ../../graphics/struct.Frame.html
    /// [`Widget::draw`]: trait.Widget.html#tymethod.draw
    /// [`Renderer`]: trait.Renderer.html
    /// [`Batch`]: ../../graphics/struct.Batch.html
    /// [`Batch::draw`]: ../../graphics/struct.Batch.html#method.draw
    fn flush(&mut self, frame: &mut Frame<'_>);
}