Miroirs/pinnacle
1
0
Fork 0
mirror of https://github.com/pinnacle-comp/pinnacle.git synced 2024-11-16 07:48:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add some docs

Browse source
This commit is contained in:
Ottatop 2024-04-18 11:48:18 -05:00
parent d2445afe10
commit d2cb38daf5
2 changed files with 5 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
api/lua/pinnacle/output.lua
View file

@ -181,11 +181,11 @@ local function output_id_matches(id_str, op)
end
---@class OutputSetup
---@field filter (fun(output: OutputHandle): boolean)?
---@field mode Mode?
---@field scale number?
---@field tags string[]?
---@field transform Transform?
---@field filter (fun(output: OutputHandle): boolean)? -- A filter for wildcard matches that should return true if this setup should apply to the passed in output.
---@field mode Mode? -- Makes this setup apply the given mode to outputs.
---@field scale number? -- Makes this setup apply the given scale to outputs.
---@field tags string[]? -- Makes this setup add tags with the given name to outputs.
---@field transform Transform? -- Makes this setup applt the given transform to outputs.
---Declaratively setup outputs.
---

18
api/lua/test.lua
View file

@ -1,18 +0,0 @@
require("pinnacle").setup(function(Pinnacle)
local Input = Pinnacle.input
local Process = Pinnacle.process
local Output = Pinnacle.output
local Tag = Pinnacle.tag
local Window = Pinnacle.window
Input:keybind({ "shift" }, "f", function()
local focused = Window:get_focused()
if focused then
print(focused:fullscreen_or_maximized())
-- assert(focused:fullscreen_or_maximized() == "neither")
focused:set_fullscreen(true)
print(focused:fullscreen_or_maximized())
-- assert(focused:fullscreen_or_maximized() == "fullscreen")
end
end)
end)