Struct RhythmGrid 

pub struct RhythmGrid { /* private fields */ }

Available on crate feature gpui only.

The vertical rhythm grid in gpui units.

Implementations

impl RhythmGrid

pub fn new(size: Pixels) -> Self

Create a grid with a finite, positive rhythm-unit size.

Panics

Panics when size is zero, negative, or non-finite.

pub fn size(&self) -> Pixels

Height of one rhythm unit.

pub const fn rhythm(&self) -> Rhythm

This grid as the dependency-free Rhythm — the entry to the math layer, mirroring RhythmFont::metrics for fonts. Use it to hand this grid to the f32 layer: FontRhythm geometry takes it per call, and RhythmLineMetrics takes it once at construction.

pub fn spacing(&self, n: i32) -> Pixels

Axis-neutral length of n rhythm units. Use this for horizontal indents, gaps, or padding measured with the same scale as the vertical rhythm.

pub fn height(&self, n: i32) -> Pixels

Total height of n rhythm units (rhythm-sass rhythm($n)). An exact alias for spacing, kept as the vertical name.

pub fn snap_up(&self, height: Pixels) -> Pixels

Round height up to whole rhythm rows — the pad strategy for content whose height is not rhythm-controlled; see Rhythm::snap_up. With a known width this is all a media block needs: div().w(w).h(grid.snap_up(w / ratio)); for fluid widths use rhythm_frame.

Panics

Panics when height is negative or non-finite.

pub fn snap_down(&self, height: Pixels) -> Pixels

Round height down to whole rhythm rows — the crop strategy; see Rhythm::snap_down.

Panics

Panics when height is negative or non-finite.

pub fn line_metrics( &self, ascent: Pixels, descent: Pixels, line_rhythms: u32, ) -> RhythmLineMetrics

Metrics for one shaped line on this grid — the Pixels-typed entry to RhythmLineMetrics. Feed a WrappedLine’s ascent() / descent() (the shaped maxima over the line’s explicit font runs) and the line height in whole rhythm units; see RhythmLineMetrics for the placement contract.

pub fn line_metrics_at_least( &self, ascent: Pixels, descent: Pixels, line_rhythms: u32, ) -> RhythmLineMetrics

line_metrics with line_rhythms as a floor: grow the line box when the reported ascent/descent envelope needs more rows.

pub fn line_metrics_covering( &self, metrics: &[RhythmLineMetrics], ) -> RhythmLineMetrics

The smallest line box on this grid containing every line in metrics.

Panics

Panics when metrics is empty or an entry was built on another grid.

pub fn font( &self, text_system: &TextSystem, font: Font, font_size: Pixels, line_rhythms: u32, ) -> RhythmFont

Resolve a font bound to this grid — RhythmFont::resolve with the grid slot filled in; see it for the fallback-resolution caveats.

pub fn overlay(&self, color: impl Into<Hsla>) -> RhythmOverlay

A debug overlay on this grid in a custom color — rhythm_overlay as a grid factory. Pass the result to RhythmStyled::rhythm_debug_overlay in place of the bare grid to customize the stripes without giving up the chainable toggle.

Trait Implementations

impl Clone for RhythmGrid

fn clone(&self) -> RhythmGrid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RhythmGrid

impl Debug for RhythmGrid

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

Formats the value using the given formatter.

impl From<RhythmGrid> for RhythmOverlay

A bare grid converts to its default debug appearance — the classic translucent red (0xff78783f), zero phase — which is what lets RhythmStyled::rhythm_debug_overlay accept the grid directly.

fn from(grid: RhythmGrid) -> Self

Converts to this type from the input type.

impl PartialEq for RhythmGrid

fn eq(&self, other: &RhythmGrid) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RhythmGrid