summaryrefslogtreecommitdiff
path: root/luals-stubs/controls.lua
blob: 0a8f4baa283b8066bfa2f13558ff42e0021ceee1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
-- SPDX-FileCopyrightText: 2023 jacqueline <me@jacqueline.id.au>
--
-- SPDX-License-Identifier: GPL-3.0-only

--- @meta

--- The `controls` module contains Properties relating to the device's physical
--- controls. These controls include the touchwheel, the lock switch, and the
--- side buttons.
--- @class controls
--- @field wheel_scheme Property The currently configured control scheme for the touchwheel
--- @field button_scheme Property The currently configured control scheme for the side buttons
--- @field locked_scheme Property The currently configured control scheme for the side buttons when locked
--- @field scroll_sensitivity Property How much rotational motion is required on the touchwheel per scroll tick.
--- @field lock_switch Property  The current state of the device's lock switch.
--- @field hooks funtion Returns a table containing the inputs and actions associated with the current control scheme.
local controls = {}

return controls