README
T
BorderWidths
- ::has_anyBorderWidths::has_any
- ::uniformBorderWidths::uniform
- ::zeroBorderWidths::zero
T
ScissorRect
- ::from_screenScissorRect::from_screen
- ::intersectScissorRect::intersect
- ::newScissorRect::new
- ::to_dst_regionScissorRect::to_dst_region
T
ScissorStack
- ::currentScissorStack::current
- ::depthScissorStack::depth
- ::is_visibleScissorStack::is_visible
- ::newScissorStack::new
- ::popScissorStack::pop
- ::pushScissorStack::push
V
border_vertices
V
filled_rect_vertices
V
filled_rounded_rect_vertices
V
measure_text
V
render_text

widget2d

UI primitive builders (rounded rects, scissor stack, text layout) on top of mizchi/gfx, mizchi/text, mizchi/font (extracted from kagura)

moon add mizchi/widget2d@0.2.0

Download zip

Author

mizchi

Version

0.2.0

License

Apache-2.0

Repository

github.com/mizchi/kagura

Last updated

2 months ago

Downloads

Dependencies

README

#
BorderWidths

source

pub(all) struct BorderWidths {
  top : Double
  right : Double
  bottom : Double
  left : Double
}

Border widths for 4 sides independently.

#
BorderWidths::has_any

source

fn BorderWidths::has_any(self : BorderWidths) -> Bool

#
BorderWidths::uniform

source

fn BorderWidths::uniform(w : Double) -> BorderWidths

#
BorderWidths::zero

source

fn BorderWidths::zero() -> BorderWidths

#
ScissorRect

source

pub(all) struct ScissorRect {
  x : Int
  y : Int
  width : Int
  height : Int
}

Scissor rectangle for clipping (pixel coordinates).

#
ScissorRect::from_screen

source

fn ScissorRect::from_screen(screen_w : Int, screen_h : Int) -> ScissorRect

#
ScissorRect::intersect

source

fn ScissorRect::intersect(self : ScissorRect, other : ScissorRect) -> ScissorRect?

Intersect two scissor rects. Returns None if they don't overlap.

#
ScissorRect::new

source

fn ScissorRect::new(x : Int, y : Int, width : Int, height : Int) -> ScissorRect

#
ScissorRect::to_dst_region

source

fn ScissorRect::to_dst_region(self : ScissorRect, index_count : Int) -> @mizchi/gfx.DstRegion
DstRegion

Convert to a DstRegion with the given index count.

#
ScissorStack

source

pub struct ScissorStack {
  stack : Array[ScissorRect]
}

Stack of scissor rects for nested overflow:hidden. Push narrows the clip region, pop restores.

#
ScissorStack::current

source

fn ScissorStack::current(self : ScissorStack) -> ScissorRect

Current active scissor rect.

#
ScissorStack::depth

source

fn ScissorStack::depth(self : ScissorStack) -> Int

Depth of the scissor stack (1 = root screen, >1 = nested clips).

#
ScissorStack::is_visible

source

fn ScissorStack::is_visible(self : ScissorStack) -> Bool

Whether the current scissor rect has any area.

#
ScissorStack::new

source

fn ScissorStack::new(screen_w : Int, screen_h : Int) -> ScissorStack

#
ScissorStack::pop

source

fn ScissorStack::pop(self : ScissorStack) -> Unit

Pop the last pushed scissor rect.

#
ScissorStack::push

source

fn ScissorStack::push(self : ScissorStack, rect : ScissorRect) -> Bool

Push a child scissor rect. The effective clip is the intersection of the current clip and the new rect. Returns false if fully clipped.

#
border_vertices

source

fn border_vertices(x : Double, y : Double, w : Double, h : Double, border : BorderWidths, screen_w : Double, screen_h : Double) -> (Array[Double], Array[Int])

Generate vertices and indices for a 4-side independent border. Pixel coords in, NDC vertices out (for builtin shader).

#
filled_rect_vertices

source

fn filled_rect_vertices(x : Double, y : Double, w : Double, h : Double, screen_w : Double, screen_h : Double) -> (Array[Double], Array[Int])

Generate NDC vertices for a filled rectangle from pixel coords.

#
filled_rounded_rect_vertices

source

fn filled_rounded_rect_vertices(x : Double, y : Double, w : Double, h : Double, tl : Double, tr : Double, br : Double, bl : Double, screen_w : Double, screen_h : Double) -> (Array[Double], Array[Int])

Generate NDC vertices for a filled rounded rectangle. Each corner is approximated with segments triangle-fan triangles.

#
measure_text

source

fn measure_text(text_renderer : @mizchi/text.TextRenderer
TextRenderer, text : String, size_px : Double) -> @mizchi/font.TextMetrics
TextMetrics

Measure text dimensions without rendering.

#
render_text

source

fn render_text(text_renderer : @mizchi/text.TextRenderer
TextRenderer, text : String, size_px : Double, x : Double, y : Double, dst : @mizchi/gfx.ImageHandle
ImageHandle, shader : @mizchi/gfx.ShaderHandle
ShaderHandle, color_hex : Int, screen_w : Double, screen_h : Double) -> Array[@mizchi/gfx.DrawTrianglesCommand
DrawTrianglesCommand]

Render text at pixel coordinates using a TextRenderer. Converts pixel-space vertices to NDC for the builtin shader.

Source Files

Site source Report issue Packages Build queue Skills Statistics

widget2d

#BorderWidths

#BorderWidths::has_any

#BorderWidths::uniform

#BorderWidths::zero

#ScissorRect

#ScissorRect::from_screen

#ScissorRect::intersect

#ScissorRect::new

#ScissorRect::to_dst_region

#ScissorStack

#ScissorStack::current

#ScissorStack::depth

#ScissorStack::is_visible

#ScissorStack::new

#ScissorStack::pop

#ScissorStack::push

#border_vertices

#filled_rect_vertices

#filled_rounded_rect_vertices

#measure_text

#render_text

Source Files

#
BorderWidths

#
BorderWidths::has_any

#
BorderWidths::uniform

#
BorderWidths::zero

#
ScissorRect

#
ScissorRect::from_screen

#
ScissorRect::intersect

#
ScissorRect::new

#
ScissorRect::to_dst_region

#
ScissorStack

#
ScissorStack::current

#
ScissorStack::depth

#
ScissorStack::is_visible

#
ScissorStack::new

#
ScissorStack::pop

#
ScissorStack::push

#
border_vertices

#
filled_rect_vertices

#
filled_rounded_rect_vertices

#
measure_text

#
render_text