mirror of
https://github.com/pinnacle-comp/pinnacle.git
synced 2024-12-30 22:23:45 +01:00
39 lines
1.1 KiB
Lua
39 lines
1.1 KiB
Lua
-- This Source Code Form is subject to the terms of the Mozilla Public
|
|
-- License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
-- file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
--
|
|
-- SPDX-License-Identifier: MPL-2.0
|
|
|
|
---The configuration entry point.
|
|
---@module PinnacleModule
|
|
local pinnacle = {
|
|
---Input and keybinds
|
|
---@tparam InputModule input
|
|
---@see InputModule
|
|
input = nil,
|
|
---Window management
|
|
---@tparam WindowModule window
|
|
---@see WindowModule
|
|
window = nil,
|
|
---Process management
|
|
---@tparam ProcessModule process
|
|
---@see ProcessModule
|
|
process = nil,
|
|
---Tag management
|
|
---@tparam TagModule tag
|
|
---@see TagModule
|
|
tag = nil,
|
|
---Output management
|
|
---@tparam OutputModule output
|
|
---@see OutputModule
|
|
output = nil,
|
|
}
|
|
|
|
---Quit Pinnacle.
|
|
function pinnacle.quit() end
|
|
|
|
---Configure Pinnacle.
|
|
---
|
|
---You should put mostly eveything into the config_func to avoid invalid state.
|
|
---@tparam function config_func A function that takes in the `Pinnacle` table.
|
|
function pinnacle.setup(config_func) end
|