Plushie.Canvas.Image (Plushie v0.7.1)

@type option() ::
  ((((({:source, String.t() | atom()} | {:x, number()}) | {:y, number()})
     | {:w, number()})
    | {:h, number()})
   | {:rotation, number() | {number(), :deg} | {number(), :rad}})
  | {:opacity, number()}

t()

@type t() :: %Plushie.Canvas.Image{
  h:
    number()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  id: String.t() | nil,
  opacity:
    number()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  rotation:
    float()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  source:
    (String.t() | atom())
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  w:
    number()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  x:
    number()
    | Plushie.Animation.Transition.t()
    | Plushie.Animation.Spring.t()
    | Plushie.Animation.Sequence.t()
    | nil,
  y:
    number()
    | 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.

h(widget, descriptor)

@spec h(widget :: t(), value :: number() | nil) :: t()

Height in pixels.

Accepts number().

new(source, x, y, w, h)

new(id, source, x, y, w, h)

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

new(id, source, x, y, w, h, opts)

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

opacity(widget, descriptor)

@spec opacity(widget :: t(), value :: number() | nil) :: t()

Opacity from 0.0 to 1.0.

Accepts number().

rotation(widget, descriptor)

@spec rotation(
  widget :: t(),
  value :: (number() | {number(), :deg} | {number(), :rad}) | nil
) :: t()

Rotation angle in degrees. Accepts {value, :rad} for radians.

Accepts float().

source(widget, descriptor)

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

Path to the image file.

Accepts String.t() | atom().

type_name()

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

Returns the element type string for the wire protocol.

w(widget, descriptor)

@spec w(widget :: t(), value :: number() | nil) :: t()

Width in pixels.

Accepts number().

with_options(widget, opts)

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

Applies keyword options to an existing widget struct.

x(widget, descriptor)

@spec x(widget :: t(), value :: number() | nil) :: t()

X position in pixels.

Accepts number().

y(widget, descriptor)

@spec y(widget :: t(), value :: number() | nil) :: t()

Y position in pixels.

Accepts number().