Struct Clay

pub struct Clay<'a> { /* private fields */ }

Implementations

impl<'a> Clay<'a>

pub fn new(dimensions: Dimensions) -> Self

Examples found in repository

examples/basic_rectangle.rs (line 11)

fn main() {
    // Create the clay instance
    let clay = Clay::new((800., 600.).into());

    // Begin the layout
    clay.begin();

    // Adds a red rectangle with a corner radius of 5.
    // The Layout makes the rectangle have a width and height of 50.
    clay.with(
        [
            Id::new("red_rectangle"),
            Layout::new().width(fixed!(50.)).height(fixed!(50.)).end(),
            Rectangle::new()
                .color((0xFF, 0x00, 0x00).into())
                .corner_radius(CornerRadius::All(5.))
                .end(),
        ],
        |_| {},
    );

    // Return the list of render commands of your layout
    let render_commands = clay.end();

    for command in render_commands {
        println!("Id of the element: {}", command.id); // Note: Ids are in fact numbers generated by Clay
        println!("Bounding box: {:?}", command.bounding_box);
        println!("Type and config: {:?}", command.config);
    }
}

pub fn data<T>(&self, data: &T) -> DataRef<'a>

Get a reference to the data to pass to clay or the builders. This is to ensure that the data is not dropped before clay is done with it.

pub fn required_memory_size() -> usize

Wrapper for Clay_MinMemorySize, returns the minimum required memory by clay

pub fn measure_text_function(&self, func: MeasureTextFunction)

Sets the function used by clay to measure dimensions of strings of Text elements

pub fn max_element_count(&self, max_element_count: u32)

Sets the maximum number of element that clay supports Use only if you know what you are doing or your getting errors from clay

pub fn max_measure_text_cache_word_count(&self, count: u32)

Sets the capacity of the cache used for text in the measure text function Use only if you know what you are doing or your getting errors from clay

pub fn enable_debug_mode(&self, enable: bool)

Enables or disables the debug mode of clay

pub fn layout_dimensions(&self, dimensions: Dimensions)

Sets the dimensions of the global layout, use if, for example the window size you render to changed

pub fn pointer_state(&self, position: Vector2, is_down: bool)

Updates the state of the pointer for clay. Used to update scroll containers and for interactions functions

pub fn update_scroll_containers( &self, drag_scrolling_enabled: bool, scroll_delta: Vector2, delta_time: f32, )

pub fn hovered(&self) -> bool

Returns if the current element you are creating is hovered

pub fn pointer_over(&self, cfg: TypedConfig) -> bool

pub fn get_bounding_box(&self, id: TypedConfig) -> Option<BoundingBox>

pub fn begin(&self)

Examples found in repository

examples/basic_rectangle.rs (line 14)

fn main() {
    // Create the clay instance
    let clay = Clay::new((800., 600.).into());

    // Begin the layout
    clay.begin();

    // Adds a red rectangle with a corner radius of 5.
    // The Layout makes the rectangle have a width and height of 50.
    clay.with(
        [
            Id::new("red_rectangle"),
            Layout::new().width(fixed!(50.)).height(fixed!(50.)).end(),
            Rectangle::new()
                .color((0xFF, 0x00, 0x00).into())
                .corner_radius(CornerRadius::All(5.))
                .end(),
        ],
        |_| {},
    );

    // Return the list of render commands of your layout
    let render_commands = clay.end();

    for command in render_commands {
        println!("Id of the element: {}", command.id); // Note: Ids are in fact numbers generated by Clay
        println!("Bounding box: {:?}", command.bounding_box);
        println!("Type and config: {:?}", command.config);
    }
}

pub fn end(&self) -> impl Iterator<Item = RenderCommand<'_>>

Examples found in repository

examples/basic_rectangle.rs (line 31)

fn main() {
    // Create the clay instance
    let clay = Clay::new((800., 600.).into());

    // Begin the layout
    clay.begin();

    // Adds a red rectangle with a corner radius of 5.
    // The Layout makes the rectangle have a width and height of 50.
    clay.with(
        [
            Id::new("red_rectangle"),
            Layout::new().width(fixed!(50.)).height(fixed!(50.)).end(),
            Rectangle::new()
                .color((0xFF, 0x00, 0x00).into())
                .corner_radius(CornerRadius::All(5.))
                .end(),
        ],
        |_| {},
    );

    // Return the list of render commands of your layout
    let render_commands = clay.end();

    for command in render_commands {
        println!("Id of the element: {}", command.id); // Note: Ids are in fact numbers generated by Clay
        println!("Bounding box: {:?}", command.bounding_box);
        println!("Type and config: {:?}", command.config);
    }
}

pub fn with<F: FnOnce(&Clay<'_>), const N: usize>( &self, configs: [TypedConfig; N], f: F, )

Create an element, passing it’s config and a function to add childrens

// TODO: Add Example

Examples found in repository

examples/basic_rectangle.rs (lines 18-28)

fn main() {
    // Create the clay instance
    let clay = Clay::new((800., 600.).into());

    // Begin the layout
    clay.begin();

    // Adds a red rectangle with a corner radius of 5.
    // The Layout makes the rectangle have a width and height of 50.
    clay.with(
        [
            Id::new("red_rectangle"),
            Layout::new().width(fixed!(50.)).height(fixed!(50.)).end(),
            Rectangle::new()
                .color((0xFF, 0x00, 0x00).into())
                .corner_radius(CornerRadius::All(5.))
                .end(),
        ],
        |_| {},
    );

    // Return the list of render commands of your layout
    let render_commands = clay.end();

    for command in render_commands {
        println!("Id of the element: {}", command.id); // Note: Ids are in fact numbers generated by Clay
        println!("Bounding box: {:?}", command.bounding_box);
        println!("Type and config: {:?}", command.config);
    }
}

pub fn text(&self, text: &str, config: TextElementConfig)

Adds a text element to the current open element or to the root layout