space_ex

v0.8.0

space_ex v0.8.0 SpaceEx.UI.Canvas

A canvas for user interface elements.

See SpaceEx.UI.stock_canvas/1 and SpaceEx.UI.add_canvas/1.

Link to this section Summary

Functions

add_button(this, content, opts \\ [])

Add a button to the canvas

add_input_field(this, opts \\ [])

Add an input field to the canvas

add_panel(this, opts \\ [])

Create a new container for user interface elements

add_text(this, content, opts \\ [])

Add text to the canvas

rect_transform(this)

The rect transform for the canvas

remove(this)

Remove the UI object

set_visible(this, value)

Whether the UI object is visible

visible(this)

Whether the UI object is visible

Link to this section Functions

Link to this function add_button(this, content, opts \\ [])

Add a button to the canvas.

  • content — The label for the button.

  • visible — Whether the button is visible.

Returns: a reference to a SpaceEx.UI.Button object

Link to this function add_input_field(this, opts \\ [])

Add an input field to the canvas.

  • visible — Whether the input field is visible.

Returns: a reference to a SpaceEx.UI.InputField object

Link to this function add_panel(this, opts \\ [])

Create a new container for user interface elements.

  • visible — Whether the panel is visible.

Returns: a reference to a SpaceEx.UI.Panel object

Link to this function add_text(this, content, opts \\ [])

Add text to the canvas.

  • content — The text.

  • visible — Whether the text is visible.

Returns: a reference to a SpaceEx.UI.Text object

Link to this function rect_transform(this)

The rect transform for the canvas.

Returns: a reference to a SpaceEx.UI.RectTransform object

Link to this function remove(this)

Remove the UI object.

Returns: :ok

Link to this function set_visible(this, value)

Whether the UI object is visible.

Returns: :ok

Link to this function visible(this)

Whether the UI object is visible.

Returns: true or false