Pudu programming language
Menu
API reference

Std.Ui.Canvas.pixelAt

1 declaration

fn

pixelAt: &Std.Ui.Canvas.Surface -> Std.Ui.Canvas.Point -> Result[Option[Std.Ui.Canvas.Color], Std.Ui.Canvas.CanvasError]

This is a callable function.

What it does

The color of one pixel, or nothing outside the surface.

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.
  • Option holds Some(value) or None when no value is available.
  • Result makes success and recoverable failure part of the function's type.

Back to Std.Ui.CanvasSearch related declarations