Pudu programming language
Menu
API reference

Std.Ui.Text.drawWithin

1 declaration

fn

drawWithin: &Std.Ui.Text.Face -> &Std.Ui.Canvas.Canvas -> Std.Ui.Canvas.Point -> Str -> Std.Ui.Canvas.Color -> Std.Ui.Canvas.Rect -> Result[Std.Ui.Canvas.Canvas, Std.Ui.Text.TextError]

This is a callable function.

What it does

Text drawn as draw draws it, with every glyph rectangle cut to a window.

Rectangles wholly outside the window add no command, so text scrolled out of

view costs nothing to render.

Read the signature

  • The text after the name is the type checked by Pudu.
  • Read arrows from left to right: inputs come first, and the final type is returned.
  • & borrows a value for this call instead of moving or copying it.
  • Names inside [ ] are type arguments, such as the item type held by a collection.
  • Result makes success and recoverable failure part of the function's type.

Back to Std.Ui.TextSearch related declarations