Struct GridLayout 

pub struct GridLayout {
    pub titles: HeaderTitles,
    pub cols: u32,
    pub sections: Vec<(u32, &'static str)>,
    pub widgets: Vec<GridWidget>,
    pub cell_size: f32,
    pub width: u32,
    pub height: u32,
    /* private fields */
}

Grid-based layout for a plugin UI.

Fields

titles: HeaderTitles

Header band titles. Both slots default to None, in which case no header is drawn and the grid starts at y = 0 (plus padding).

cols: u32

Number of columns in the grid.

sections: Vec<(u32, &'static str)>

Section labels positioned above specific rows: (row_index, label).

widgets: Vec<GridWidget>

All widgets placed in the grid.

cell_size: f32

Cell size in logical points (width and height of one grid cell).

width: u32

Computed width in logical points.

height: u32

Computed height in logical points.

Implementations

impl GridLayout

pub fn build(entries: Vec<Section>) -> GridLayout

Build a grid layout from sections containing widgets. No header is drawn, cols defaults to the widest section’s widget count (extended to fit any explicitly-positioned widget), and cell_size defaults to GRID_DEFAULT_CELL_SIZE. Override any of those via Self::with_titles / Self::with_cols / Self::with_cell_size.

Each entry is either a Section (created with section("LABEL", vec![...])) or a bare GridWidget (auto-wrapped via From). Example:

GridLayout::build(vec![
    section("LOW", vec![
        GridWidget::knob(P::Freq, "Freq"),
        GridWidget::knob(P::Gain, "Gain"),
    ]),
    GridWidget::knob(P::Output, "Output").into(),
])

pub fn with_cols(self, cols: u32) -> GridLayout

Override the default column count (which is the widest section’s widget count, or whatever explicit positions require - whichever is larger). Use to force wrapping: .with_cols(2) on a 4-widget section produces a 2×2 grid. Recomputes auto-flow placement and window size.

pub fn with_cell_size(self, cell_size: f32) -> GridLayout

Override the default cell size (GRID_DEFAULT_CELL_SIZE). The cell is square - this is both the width and height of one grid cell in logical points.

pub fn with_grid(self, cols: u32, cell_size: f32) -> GridLayout

Like Self::with_cols but accepts the cell size in the same call - useful when both are non-default. Equivalent to .with_cell_size(s).with_cols(c).

pub fn with_titles(self, titles: HeaderTitles) -> GridLayout

Set both header slots at once. Replaces any previously configured titles. Recomputes the height to account for the extra band - width stays the same since the header spans the full grid width.

use truce_gui_types::layout::{GridLayout, HeaderTitles};
GridLayout::build(sections).with_titles(HeaderTitles::pair("EQ", "v0.1"))

pub fn with_title(self, title: &'static str) -> GridLayout

Set the title slot (left, larger / brighter), preserving any previously configured subtitle.

GridLayout::build(sections).with_title("EQ")

pub fn with_subtitle(self, subtitle: &'static str) -> GridLayout

Set the subtitle slot (right, smaller / dimmer), preserving any previously configured title.

GridLayout::build(sections).with_subtitle("v0.1")

pub fn compute_size(&self) -> (u32, u32)

Compute the window size from the grid.

Trait Implementations

impl Clone for GridLayout

fn clone(&self) -> GridLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GridLayout

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

Formats the value using the given formatter.

impl From<PluginLayout> for GridLayout

fn from(pl: PluginLayout) -> GridLayout

Converts to this type from the input type.

impl IntoLayoutEditor for GridLayout

Available on iOS or crate feature cpu or crate feature gpu only.

fn into_editor<P: Params + 'static>(self, params: &Arc<P>) -> Box<dyn Editor>

Wrap this layout in truce’s default editor, picking the renderer from the active truce-gui feature. See default_editor.