Skip to content

Commit f9e6861

Browse files
author
pinnacle-comp
committed
1 parent 4c13dff commit f9e6861

5 files changed

Lines changed: 17 additions & 0 deletions

File tree

main/classes/pinnacle.input.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,13 @@ end)
7575

7676
`mods` - The modifiers that need to be held down for the bind to trigger
7777
- <code><a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code><br>
78+
7879
`key` - The key used to trigger the bind
7980
- <code><a href="/lua-reference/main/enums/pinnacle.input.Key">pinnacle.input.Key</a> | string</code><br>
81+
8082
`on_press` - The function to run when the bind is triggered
8183
- <code>fun()</code><br>
84+
8285
`bind_info` - An optional group and description that is displayed in the bind overlay.
8386
- <code>{ group?: string, description?: string }</code>
8487

@@ -128,10 +131,13 @@ end)
128131

129132
`mods` - The modifiers that need to be held down for the bind to trigger
130133
- <code><a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code><br>
134+
131135
`button` - The mouse button used to trigger the bind
132136
- <code><a href="/lua-reference/main/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a></code><br>
137+
133138
`on_press` - The function to run when the bind is triggered
134139
- <code>fun()</code><br>
140+
135141
`bind_info` - An optional group and description that will be displayed in the bind overlay.
136142
- <code>{ group?: string, description?: string }</code>
137143

@@ -217,6 +223,7 @@ Input.set_repeat_rate(100, 1000) -- Key must be held down for 1 second, then rep
217223

218224
`rate` - The time between repeats in milliseconds
219225
- <code>integer</code><br>
226+
220227
`delay` - The duration a key needs to be held down before repeating starts in milliseconds
221228
- <code>integer</code>
222229

main/classes/pinnacle.output.OutputHandle.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ Output.get_by_name("HDMI-1"):set_loc(1920, -360)
6363

6464
`x` - The x-coordinate.
6565
- <code>integer</code><br>
66+
6667
`y` - The y-coordinate.
6768
- <code>integer</code>
6869

@@ -110,6 +111,7 @@ Output.get_by_name("DP-1"):set_loc_adj_to(Output.get_by_name("HDMI-1"), "bottom_
110111

111112
`other` - The output to move this output relative to.
112113
- <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code><br>
114+
113115
`alignment` - How to align this output with the other output.
114116
- <code><a href="/lua-reference/main/aliases/pinnacle.output.Alignment">pinnacle.output.Alignment</a></code>
115117

@@ -142,8 +144,10 @@ Output.get_focused():set_mode(2560, 1440, 144000)
142144

143145
`width` - The mode's width.
144146
- <code>integer</code><br>
147+
145148
`height` - The mode's height.
146149
- <code>integer</code><br>
150+
147151
`refresh_rate_mhz` - The mode's refresh rate in millihertz, or `nil` to auto-select.
148152
- <code>integer</code>
149153

@@ -173,8 +177,10 @@ Output.get_focused():set_custom_mode(2560, 1440, 75000)
173177

174178
`width` - A custom width.
175179
- <code>integer</code><br>
180+
176181
`height` - A custom height.
177182
- <code>integer</code><br>
183+
178184
`refresh_rate_mhz` - A custom refresh rate in millihertz, or `nil` to default to 60Hz.
179185
- <code>integer</code>
180186

main/classes/pinnacle.process.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ Adds an environment variable that all newly spawned processes will inherit.
144144

145145
`key` - The environment variable's key.
146146
- <code>string</code><br>
147+
147148
`value` - The environment variable's value.
148149
- <code>string</code>
149150

main/classes/pinnacle.tag.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ local tag_on_hdmi1 = Tag.get("Tag", Output.get_by_name("HDMI-1"))
7575

7676
`name` - The name of the tag
7777
- <code>string</code><br>
78+
7879
`output` - The output to get the tag on, or `nil` for the focused output.
7980
- <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code>
8081

@@ -112,6 +113,7 @@ local tags = Tag.add(Output.get_by_name("HDMI-1"), tag_names)
112113

113114
`output` - The output to add tags to.
114115
- <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code><br>
116+
115117
`...` - The names of the new tags.
116118
- <code>string</code>
117119

main/classes/pinnacle.window.WindowHandle.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,7 @@ Adds or removes the given tag to or from this window.
298298

299299
`tag` - The tag to set or unset
300300
- <code><a href="/lua-reference/main/classes/pinnacle.tag.TagHandle">pinnacle.tag.TagHandle</a></code><br>
301+
301302
`set`
302303
- <code>boolean</code>
303304

0 commit comments

Comments
 (0)