Scenic.Driver.Local (scenic_driver_local v0.11.0-beta.0) View Source

Documentation for Scenic.Driver.Local.

Supported config options:

  • :name

  • :limit_ms - The default value is 29.

  • :layer - The default value is 0.

  • :opacity - The default value is 255.

  • :debug - The default value is false.

  • :antialias - The default value is true.

  • :calibration - The default value is [].

  • :position - The default value is [].

    • :scaled - The default value is false.
    • :centered - The default value is false.
    • :orientation - The default value is :normal.
  • :window - The default value is [].

    • :title - The default value is "Scenic Window".
    • :resizeable - The default value is false.
  • :cursor - The default value is false.

  • :key_map - The default value is Scenic.KeyMap.USEnglish.

  • :on_close - The default value is :restart.

Link to this section Summary

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Specs

hide_cursor(driver :: pid() | Scenic.Driver.t()) :: :ok

Specs

position(driver :: pid() | Scenic.Driver.t(), otps :: Keyword.t()) ::
  :ok | NimbleOptions.ValidationError.t()

Specs

set_cursor(
  driver :: pid() | Scenic.Driver.t(),
  cursor :: Scenic.Driver.Local.Cursor.t()
) :: :ok

Specs

show_cursor(driver :: pid() | Scenic.Driver.t()) :: :ok
Link to this function

validate_calibration(calibrations)

View Source