File tree Expand file tree Collapse file tree 3 files changed +54
-0
lines changed
Expand file tree Collapse file tree 3 files changed +54
-0
lines changed Original file line number Diff line number Diff line change 1+ ---
2+ outline : [2, 3]
3+ ---
4+
5+ # Class ` pinnacle.layout.builtin.Floating ` : <code ><a href =" /lua-reference/main/classes/pinnacle.layout.LayoutGenerator " >pinnacle.layout.LayoutGenerator</a ></code >
6+
7+
8+ A layout generator that floats windows.
9+
10+ This works by simply returning an empty layout tree.
11+ Note: the windows are not truly floating, see ` WindowHandle::spilled ` for
12+ details.
13+
14+
15+
Original file line number Diff line number Diff line change @@ -145,6 +145,23 @@ Creates a layout generator that lays windows out keeping their sizes roughly the
145145
146146
147147
148+ ### <Badge type =" function " text =" function " /> floating
149+
150+ <div class =" language-lua " ><pre ><code >function pinnacle.layout.builtin.floating()
151+ -> <a href="/lua-reference/main/classes/pinnacle.layout.builtin.Floating">pinnacle.layout.builtin.Floating</a></code></pre></div>
152+
153+ Creates a layout generator that floats windows.
154+
155+
156+
157+
158+ #### Returns
159+
160+ 1 . <code ><a href =" /lua-reference/main/classes/pinnacle.layout.builtin.Floating " >pinnacle.layout.builtin.Floating</a ></code >
161+
162+
163+
164+
148165### <Badge type =" function " text =" function " /> cycle
149166
150167<div class =" language-lua " ><pre ><code >function pinnacle.layout.builtin.cycle(layouts: <a href =" /lua-reference/main/classes/pinnacle.layout.LayoutGenerator " >pinnacle.layout.LayoutGenerator</a >[])
Original file line number Diff line number Diff line change @@ -485,6 +485,28 @@ Gets whether this window is tiled.
485485
486486
487487
488+ ### <Badge type =" method " text =" method " /> spilled
489+
490+ <div class =" language-lua " ><pre ><code >function pinnacle.window.WindowHandle:spilled()
491+ -> boolean</code></pre></div>
492+
493+ Gets whether this window is spilled from the layout.
494+
495+ A window is spilled when the current layout doesn't contains enough nodes
496+ and the compositor cannot assign a geometry to it. In that state, the window
497+ behaves as a floating window except that it gets tiled again if the number
498+ of nodes become big enough.
499+
500+
501+
502+
503+ #### Returns
504+
505+ 1 . <code >boolean</code >
506+
507+
508+
509+
488510### <Badge type =" method " text =" method " /> fullscreen
489511
490512<div class =" language-lua " ><pre ><code >function pinnacle.window.WindowHandle:fullscreen()
You can’t perform that action at this time.
0 commit comments