View Source Scenic.Driver.Local (scenic_driver_local v0.12.0-rc.0)

Documentation for Scenic.Driver.Local.

Supported config options:

  • :name

  • :limit_ms (non_neg_integer/0) - The default value is 29.

  • :layer (integer/0) - The default value is 0.

  • :opacity (integer/0) - The default value is 255.

  • :debug (boolean/0) - The default value is false.

  • :debugger (String.t/0) - The default value is "".

  • :debug_fps (integer/0) - The default value is 0.

  • :antialias (boolean/0) - The default value is true.

  • :calibration - The default value is [].

  • :position (keyword/0) - The default value is [].

    • :scaled (boolean/0) - The default value is false.

    • :centered (boolean/0) - The default value is false.

    • :orientation - The default value is :normal.

  • :window (keyword/0) - The default value is [].

    • :title (String.t/0) - The default value is "Scenic Window".

    • :resizeable (boolean/0) - The default value is false.

  • :cursor (boolean/0) - The default value is false.

  • :key_map (atom/0) - The default value is Scenic.KeyMap.USEnglish.

  • :on_close - The default value is :restart.

  • :input_blacklist (list of String.t/0) - The default value is [].

Summary

Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

@spec hide_cursor(driver :: pid() | Scenic.Driver.t()) :: :ok
@spec position(driver :: pid() | Scenic.Driver.t(), otps :: Keyword.t()) ::
  :ok | NimbleOptions.ValidationError.t()
@spec set_cursor(
  driver :: pid() | Scenic.Driver.t(),
  cursor :: Scenic.Driver.Local.Cursor.t()
) :: :ok
@spec show_cursor(driver :: pid() | Scenic.Driver.t()) :: :ok
Link to this function

validate_calibration(calibrations)

View Source