Plushie.Canvas.Layer (Plushie v0.7.0)

Canvas layer: a named container that groups shapes for independent caching on the renderer side.

Each layer maps to an iced Cache on the Rust side; only changed layers are re-tessellated. The name prop identifies the layer for cache invalidation.

On the wire this encodes as type: "__layer__" to match what the renderer expects.

Example

Layer.new("bg")
|> Layer.push(rect(0, 0, 800, 600, fill: "#f0f0f0"))
|> Layer.push(rect(10, 10, 50, 200, fill: "#3498db"))

Summary

Types

option()

t()

Functions

build(widget)

Converts this widget struct to a ui_node() map.

extend(widget, children)

Appends multiple children to the widget.

name(widget, descriptor)

Layer name for renderer cache keying.

new(id)

Creates a new element without an explicit ID (auto-assigned by parent container).

new(id, opts)

Creates a new element with the given ID and keyword options.

push(widget, child)

Appends a child to the widget.

type_name()

Returns the element type string for the wire protocol.

with_options(widget, opts)

Applies keyword options to an existing widget struct.

Types

option()

@type option() :: {:name, String.t() | atom()}

t()

@type t() :: %Plushie.Canvas.Layer{
  children: [Plushie.Widget.ui_node()],
  id: String.t() | nil,
  name:
    (String.t() | atom())
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil
}

Functions

build(widget)

@spec build(widget :: t()) :: Plushie.Widget.ui_node()

Converts this widget struct to a ui_node() map.

extend(widget, children)

@spec extend(widget :: t(), children :: [Plushie.Widget.child()]) :: t()

Appends multiple children to the widget.

name(widget, descriptor)

@spec name(widget :: t(), value :: (String.t() | atom()) | nil) :: t()

Layer name for renderer cache keying.

Accepts String.t() | atom().

new(id)

@spec new(opts :: [option()]) :: t()

Creates a new element without an explicit ID (auto-assigned by parent container).

new(id, opts)

@spec new(id :: String.t(), opts :: [option()]) :: t()

Creates a new element with the given ID and keyword options.

push(widget, child)

@spec push(widget :: t(), child :: Plushie.Widget.child()) :: t()

Appends a child to the widget.

type_name()

@spec type_name() :: String.t()

Returns the element type string for the wire protocol.

with_options(widget, opts)

@spec with_options(widget :: t(), opts :: [option()]) :: t()

Applies keyword options to an existing widget struct.