Skip to content

Commit f23f814

Browse files
author
pinnacle-comp
committed
1 parent 8b29034 commit f23f814

File tree

79 files changed

+20828
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+20828
-0
lines changed

‎0.2.1/aliases/pinnacle.input.libinput.DeviceType.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
outline: [2, 3]
3+
---
4+
5+
# Alias `pinnacle.input.libinput.DeviceType`
6+
7+
<code>"unknown"</code> | <code>"touchpad"</code> | <code>"trackball"</code> | <code>"trackpoint"</code> | <code>"mouse"</code> | <code>"tablet"</code> | <code>"keyboard"</code> | <code>"switch"</code>
8+
9+
A device's type.
10+
11+
Note: this uses heuristics to determine device type.
12+
*This may be incorrect*. For example, a device with both pointer
13+
and keyboard capabilities will be labeled as a `"mouse"` when it might actually be
14+
a keyboard.
15+
16+
## Aliased types
17+
18+
### <code>"unknown"</code>
19+
20+
The device type is unknown.
21+
22+
### <code>"touchpad"</code>
23+
24+
This device is a touchpad.
25+
26+
### <code>"trackball"</code>
27+
28+
This device is a trackball.
29+
30+
### <code>"trackpoint"</code>
31+
32+
This device is a trackpoint.
33+
34+
### <code>"mouse"</code>
35+
36+
This device is a mouse.
37+
38+
### <code>"tablet"</code>
39+
40+
This device is a tablet.
41+
42+
### <code>"keyboard"</code>
43+
44+
This device is a keyboard.
45+
46+
### <code>"switch"</code>
47+
48+
This device is a switch.

‎0.2.1/aliases/pinnacle.layout.Gaps.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
outline: [2, 3]
3+
---
4+
5+
# Alias `pinnacle.layout.Gaps`
6+
7+
<code>{ left: number, right: number, top: number, bottom: number }</code> | <code>number</code>
8+
9+
10+
11+
## Aliased types
12+
13+
### <code>{ left: number, right: number, top: number, bottom: number }</code>
14+
15+
A separate number of gaps per side.
16+
17+
### <code>number</code>
18+
19+
Gaps for all sides.

‎0.2.1/aliases/pinnacle.layout.LayoutDir.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
outline: [2, 3]
3+
---
4+
5+
# Alias `pinnacle.layout.LayoutDir`
6+
7+
<code>"row"</code> | <code>"column"</code>
8+
9+
10+
11+
## Aliased types
12+
13+
### <code>"row"</code>
14+
15+
Lays out windows in a row horizontally.
16+
17+
### <code>"column"</code>
18+
19+
Lays out windows in a column vertically.

‎0.2.1/aliases/pinnacle.output.Alignment.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
outline: [2, 3]
3+
---
4+
5+
# Alias `pinnacle.output.Alignment`
6+
7+
<code>"top_align_left"</code> | <code>"top_align_center"</code> | <code>"top_align_right"</code> | <code>"bottom_align_left"</code> | <code>"bottom_align_center"</code> | <code>"bottom_align_right"</code> | <code>"left_align_top"</code> | <code>"left_align_center"</code> | <code>"left_align_bottom"</code> | <code>"right_align_top"</code> | <code>"right_align_center"</code> | <code>"right_align_bottom"</code>
8+
9+
An alignment relative to another output.
10+
11+
## Aliased types
12+
13+
### <code>"top_align_left"</code>
14+
15+
Set above, align left borders
16+
17+
### <code>"top_align_center"</code>
18+
19+
Set above, align centers
20+
21+
### <code>"top_align_right"</code>
22+
23+
Set above, align right borders
24+
25+
### <code>"bottom_align_left"</code>
26+
27+
Set below, align left borders
28+
29+
### <code>"bottom_align_center"</code>
30+
31+
Set below, align centers
32+
33+
### <code>"bottom_align_right"</code>
34+
35+
Set below, align right border
36+
37+
### <code>"left_align_top"</code>
38+
39+
Set to left, align top borders
40+
41+
### <code>"left_align_center"</code>
42+
43+
Set to left, align centers
44+
45+
### <code>"left_align_bottom"</code>
46+
47+
Set to left, align bottom borders
48+
49+
### <code>"right_align_top"</code>
50+
51+
Set to right, align top borders
52+
53+
### <code>"right_align_center"</code>
54+
55+
Set to right, align centers
56+
57+
### <code>"right_align_bottom"</code>
58+
59+
Set to right, align bottom borders

‎0.2.1/aliases/pinnacle.window.LayoutMode.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
outline: [2, 3]
3+
---
4+
5+
# Alias `pinnacle.window.LayoutMode`
6+
7+
<code>"tiled"</code> | <code>"floating"</code> | <code>"fullscreen"</code> | <code>"maximized"</code>
8+
9+
A window's current layout mode.
10+
11+
## Aliased types
12+
13+
### <code>"tiled"</code>
14+
15+
The window is tiled.
16+
17+
### <code>"floating"</code>
18+
19+
The window is floating.
20+
21+
### <code>"fullscreen"</code>
22+
23+
The window is fullscreen.
24+
25+
### <code>"maximized"</code>
26+
27+
The window is maximized.

‎0.2.1/classes/pinnacle.Log.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
outline: [2, 3]
3+
---
4+
5+
# Class `pinnacle.Log`
6+
7+
8+
Logging utilities.
9+
10+
11+
12+
## Functions
13+
14+
### <Badge type="function" text="function" /> info
15+
16+
<div class="language-lua"><pre><code>function pinnacle.Log.info()</code></pre></div>
17+
18+
Prints an INFO message.
19+
20+
21+
22+
23+
24+
25+
### <Badge type="function" text="function" /> debug
26+
27+
<div class="language-lua"><pre><code>function pinnacle.Log.debug()</code></pre></div>
28+
29+
Prints a DEBUG message.
30+
31+
32+
33+
34+
35+
36+
### <Badge type="function" text="function" /> warn
37+
38+
<div class="language-lua"><pre><code>function pinnacle.Log.warn()</code></pre></div>
39+
40+
Prints a WARN message.
41+
42+
43+
44+
45+
46+
47+
### <Badge type="function" text="function" /> error
48+
49+
<div class="language-lua"><pre><code>function pinnacle.Log.error()</code></pre></div>
50+
51+
Prints an ERROR message along with file, line, and column information.
52+
53+
54+
55+
56+

‎0.2.1/classes/pinnacle.debug.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
outline: [2, 3]
3+
---
4+
5+
# Class `pinnacle.debug`
6+
7+
8+
Debugging utilities.
9+
10+
> [!WARNING]
11+
> This module is not governed by the API stability guarantees.
12+
13+
14+
15+
16+
## Functions
17+
18+
### <Badge type="function" text="function" /> set_damage_visualization
19+
20+
<div class="language-lua"><pre><code>function pinnacle.debug.set_damage_visualization(set: boolean)</code></pre></div>
21+
22+
Sets damage visualization.
23+
24+
When on, parts of the screen that are damaged after rendering will have
25+
red rectangles drawn where the damage is.
26+
27+
28+
#### Parameters
29+
30+
`set`<br>
31+
&emsp; ┃ <code>boolean</code><br>
32+
33+
34+
35+
36+
37+
38+
### <Badge type="function" text="function" /> toggle_damage_visualization
39+
40+
<div class="language-lua"><pre><code>function pinnacle.debug.toggle_damage_visualization()</code></pre></div>
41+
42+
Toggles damage visualization.
43+
44+
When on, parts of the screen that are damaged after rendering will have
45+
red rectangles drawn where the damage is.
46+
47+
48+
49+
50+
51+
52+
### <Badge type="function" text="function" /> set_opaque_region_visualization
53+
54+
<div class="language-lua"><pre><code>function pinnacle.debug.set_opaque_region_visualization(set: boolean)</code></pre></div>
55+
56+
Sets opaque region visualization.
57+
58+
When on, parts of the screen that are opaque will have a transparent blue rectangle
59+
drawn over it, while parts that are not opaque will have a transparent red rectangle
60+
drawn.
61+
62+
63+
#### Parameters
64+
65+
`set`<br>
66+
&emsp; ┃ <code>boolean</code><br>
67+
68+
69+
70+
71+
72+
73+
### <Badge type="function" text="function" /> toggle_opaque_region_visualization
74+
75+
<div class="language-lua"><pre><code>function pinnacle.debug.toggle_opaque_region_visualization()</code></pre></div>
76+
77+
Toggles opaque region visualization.
78+
79+
When on, parts of the screen that are opaque will have a transparent blue rectangle
80+
drawn over it, while parts that are not opaque will have a transparent red rectangle
81+
drawn.
82+
83+
84+
85+
86+
87+
88+
### <Badge type="function" text="function" /> set_cursor_plane_scanout
89+
90+
<div class="language-lua"><pre><code>function pinnacle.debug.set_cursor_plane_scanout(set: boolean)</code></pre></div>
91+
92+
Sets cursor plane scanout.
93+
94+
95+
#### Parameters
96+
97+
`set`<br>
98+
&emsp; ┃ <code>boolean</code><br>
99+
100+
101+
102+
103+
104+
105+
### <Badge type="function" text="function" /> toggle_cursor_plane_scanout
106+
107+
<div class="language-lua"><pre><code>function pinnacle.debug.toggle_cursor_plane_scanout()</code></pre></div>
108+
109+
Toggles cursor plane scanout.
110+
111+
112+
113+
114+
115+
116+
### <Badge type="function" text="function" /> set_process_piping
117+
118+
<div class="language-lua"><pre><code>function pinnacle.debug.set_process_piping(set: boolean)</code></pre></div>
119+
120+
Enables or disables process spawning setting up pipes to give fds to the config.
121+
122+
123+
#### Parameters
124+
125+
`set`<br>
126+
&emsp; ┃ <code>boolean</code><br>
127+
128+
129+
130+
131+
132+
133+
### <Badge type="function" text="function" /> toggle_process_piping
134+
135+
<div class="language-lua"><pre><code>function pinnacle.debug.toggle_process_piping()</code></pre></div>
136+
137+
Toggles process spawning setting up pipes to give fds to the config.
138+
139+
140+
141+
142+

‎0.2.1/classes/pinnacle.experimental.InputGrab.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
outline: [2, 3]
3+
---
4+
5+
# Class `pinnacle.experimental.InputGrab` : <code>snowcap.widget.Program</code>
6+
7+
8+
9+
10+
11+

0 commit comments

Comments
 (0)