Skip to content

Commit 654c472

Browse files
author
pinnacle-comp
committed
1 parent cfe50d5 commit 654c472

22 files changed

Lines changed: 261 additions & 137 deletions

main/classes/pinnacle.debug.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ red rectangles drawn where the damage is.
2727

2828
#### Parameters
2929

30-
`set`: <code>boolean</code>
30+
`set`
31+
| <code>boolean</code>
3132

3233

3334

@@ -61,7 +62,8 @@ drawn.
6162

6263
#### Parameters
6364

64-
`set`: <code>boolean</code>
65+
`set`
66+
| <code>boolean</code>
6567

6668

6769

@@ -92,7 +94,8 @@ Sets cursor plane scanout.
9294

9395
#### Parameters
9496

95-
`set`: <code>boolean</code>
97+
`set`
98+
| <code>boolean</code>
9699

97100

98101

@@ -119,7 +122,8 @@ Enables or disables process spawning setting up pipes to give fds to the config.
119122

120123
#### Parameters
121124

122-
`set`: <code>boolean</code>
125+
`set`
126+
| <code>boolean</code>
123127

124128

125129

main/classes/pinnacle.input.libinput.DeviceHandle.md

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,8 @@ This only affects devices with touch capability.
122122

123123
#### Parameters
124124

125-
`output`: <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code> - The output to map the device's input to
125+
`output` - The output to map the device's input to
126+
| <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code>
126127

127128

128129

@@ -149,7 +150,8 @@ This only affects devices with touch capability.
149150

150151
#### Parameters
151152

152-
`region`: <code>{ x: integer, y: integer, width: integer, height: integer }</code> - The region in the global space to map input to
153+
`region` - The region in the global space to map input to
154+
| <code>{ x: integer, y: integer, width: integer, height: integer }</code>
153155

154156

155157

@@ -167,7 +169,8 @@ Sets this device's acceleration profile.
167169

168170
#### Parameters
169171

170-
`accel_profile`: <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.AccelProfile">pinnacle.input.libinput.AccelProfile</a></code>
172+
`accel_profile`
173+
| <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.AccelProfile">pinnacle.input.libinput.AccelProfile</a></code>
171174

172175

173176

@@ -183,7 +186,8 @@ Sets this device's acceleration speed.
183186

184187
#### Parameters
185188

186-
`accel_speed`: <code>number</code>
189+
`accel_speed`
190+
| <code>number</code>
187191

188192

189193

@@ -199,7 +203,8 @@ Sets this device's calibration matrix.
199203

200204
#### Parameters
201205

202-
`calibration_matrix`: <code>number[]</code> - The calibration matrix as an array of 6 floats.
206+
`calibration_matrix` - The calibration matrix as an array of 6 floats.
207+
| <code>number[]</code>
203208

204209

205210

@@ -215,7 +220,8 @@ Sets this device's click method.
215220

216221
#### Parameters
217222

218-
`click_method`: <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.ClickMethod">pinnacle.input.libinput.ClickMethod</a></code>
223+
`click_method`
224+
| <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.ClickMethod">pinnacle.input.libinput.ClickMethod</a></code>
219225

220226

221227

@@ -231,7 +237,8 @@ Sets whether or not this device is disabled while typing.
231237

232238
#### Parameters
233239

234-
`disable_while_typing`: <code>boolean</code>
240+
`disable_while_typing`
241+
| <code>boolean</code>
235242

236243

237244

@@ -247,7 +254,8 @@ Sets this device to left-handed or not.
247254

248255
#### Parameters
249256

250-
`left_handed`: <code>boolean</code>
257+
`left_handed`
258+
| <code>boolean</code>
251259

252260

253261

@@ -263,7 +271,8 @@ Sets whether or not middle emulation is enabled.
263271

264272
#### Parameters
265273

266-
`middle_emulation`: <code>boolean</code>
274+
`middle_emulation`
275+
| <code>boolean</code>
267276

268277

269278

@@ -279,7 +288,8 @@ Sets this device's rotation angle.
279288

280289
#### Parameters
281290

282-
`rotation_angle`: <code>integer</code>
291+
`rotation_angle`
292+
| <code>integer</code>
283293

284294

285295

@@ -295,7 +305,8 @@ Sets this device's scroll button.
295305

296306
#### Parameters
297307

298-
`scroll_button`: <code>integer</code>
308+
`scroll_button`
309+
| <code>integer</code>
299310

300311

301312

@@ -311,7 +322,8 @@ Sets whether or not the scroll button locks on this device.
311322

312323
#### Parameters
313324

314-
`scroll_button_lock`: <code>boolean</code>
325+
`scroll_button_lock`
326+
| <code>boolean</code>
315327

316328

317329

@@ -327,7 +339,8 @@ Sets this device's scroll method.
327339

328340
#### Parameters
329341

330-
`scroll_method`: <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.ScrollMethod">pinnacle.input.libinput.ScrollMethod</a></code>
342+
`scroll_method`
343+
| <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.ScrollMethod">pinnacle.input.libinput.ScrollMethod</a></code>
331344

332345

333346

@@ -343,7 +356,8 @@ Enables or disables natural scroll on this device.
343356

344357
#### Parameters
345358

346-
`natural_scroll`: <code>boolean</code>
359+
`natural_scroll`
360+
| <code>boolean</code>
347361

348362

349363

@@ -359,7 +373,8 @@ Sets this device's tap button map.
359373

360374
#### Parameters
361375

362-
`tap_button_map`: <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.TapButtonMap">pinnacle.input.libinput.TapButtonMap</a></code>
376+
`tap_button_map`
377+
| <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.TapButtonMap">pinnacle.input.libinput.TapButtonMap</a></code>
363378

364379

365380

@@ -375,7 +390,8 @@ Enables or disables tap dragging on this device.
375390

376391
#### Parameters
377392

378-
`tap_drag`: <code>boolean</code>
393+
`tap_drag`
394+
| <code>boolean</code>
379395

380396

381397

@@ -391,7 +407,8 @@ Sets whether or not tap dragging locks on this device.
391407

392408
#### Parameters
393409

394-
`tap_drag_lock`: <code>boolean</code>
410+
`tap_drag_lock`
411+
| <code>boolean</code>
395412

396413

397414

@@ -407,7 +424,8 @@ Enables or disables tap-to-click on this device.
407424

408425
#### Parameters
409426

410-
`tap`: <code>boolean</code>
427+
`tap`
428+
| <code>boolean</code>
411429

412430

413431

@@ -423,7 +441,8 @@ Sets this device's send events mode.
423441

424442
#### Parameters
425443

426-
`send_events_mode`: <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.SendEventsMode">pinnacle.input.libinput.SendEventsMode</a></code>
444+
`send_events_mode`
445+
| <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.SendEventsMode">pinnacle.input.libinput.SendEventsMode</a></code>
427446

428447

429448

main/classes/pinnacle.input.libinput.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ all devices that will be connected in the future.
3838

3939
#### Parameters
4040

41-
`for_each`: <code>fun(device: <a href="/lua-reference/main/classes/pinnacle.input.libinput.DeviceHandle">pinnacle.input.libinput.DeviceHandle</a>)</code>
41+
`for_each`
42+
| <code>fun(device: <a href="/lua-reference/main/classes/pinnacle.input.libinput.DeviceHandle">pinnacle.input.libinput.DeviceHandle</a>)</code>
4243

4344

4445

main/classes/pinnacle.input.md

Lines changed: 37 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Keycodes for every key.
2828

2929
### <Badge type="function" text="function" /> keybind
3030

31-
<div class="language-lua"><pre><code>function pinnacle.input.keybind(mods: <a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[], key: <a href="/lua-reference/main/enums/pinnacle.input.Key">pinnacle.input.Key</a> | string, on_press: fun(), bind_info?: { group?: string, description?: string })</code></pre></div>
31+
<div class="language-lua"><pre><code>function pinnacle.input.keybind(mods: <a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[], key: <a href="/lua-reference/main/enums/pinnacle.input.Key">pinnacle.input.Key</a> | string, on_press: fun(), bind_info: { group?: string, description?: string })</code></pre></div>
3232

3333
Sets a keybind.
3434

@@ -73,10 +73,14 @@ end)
7373

7474
#### Parameters
7575

76-
`mods`: <code><a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code> - The modifiers that need to be held down for the bind to trigger<br>
77-
`key`: <code><a href="/lua-reference/main/enums/pinnacle.input.Key">pinnacle.input.Key</a> | string</code> - The key used to trigger the bind<br>
78-
`on_press`: <code>fun()</code> - The function to run when the bind is triggered<br>
79-
`bind_info?`: <code>{ group?: string, description?: string }</code> - An optional group and description that is displayed in the bind overlay.
76+
`mods` - The modifiers that need to be held down for the bind to trigger
77+
| <code><a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code><br>
78+
`key` - The key used to trigger the bind
79+
| <code><a href="/lua-reference/main/enums/pinnacle.input.Key">pinnacle.input.Key</a> | string</code><br>
80+
`on_press` - The function to run when the bind is triggered
81+
| <code>fun()</code><br>
82+
`bind_info` - An optional group and description that is displayed in the bind overlay.
83+
| <code>{ group?: string, description?: string }</code>
8084

8185

8286

@@ -85,7 +89,7 @@ end)
8589

8690
### <Badge type="function" text="function" /> mousebind
8791

88-
<div class="language-lua"><pre><code>function pinnacle.input.mousebind(mods: <a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[], button: <a href="/lua-reference/main/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a>, on_press: fun(), bind_info?: { group?: string, description?: string })</code></pre></div>
92+
<div class="language-lua"><pre><code>function pinnacle.input.mousebind(mods: <a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[], button: <a href="/lua-reference/main/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a>, on_press: fun(), bind_info: { group?: string, description?: string })</code></pre></div>
8993

9094
Sets a mousebind.
9195

@@ -122,10 +126,14 @@ end)
122126

123127
#### Parameters
124128

125-
`mods`: <code><a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code> - The modifiers that need to be held down for the bind to trigger<br>
126-
`button`: <code><a href="/lua-reference/main/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a></code> - The mouse button used to trigger the bind<br>
127-
`on_press`: <code>fun()</code> - The function to run when the bind is triggered<br>
128-
`bind_info?`: <code>{ group?: string, description?: string }</code> - An optional group and description that will be displayed in the bind overlay.
129+
`mods` - The modifiers that need to be held down for the bind to trigger
130+
| <code><a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code><br>
131+
`button` - The mouse button used to trigger the bind
132+
| <code><a href="/lua-reference/main/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a></code><br>
133+
`on_press` - The function to run when the bind is triggered
134+
| <code>fun()</code><br>
135+
`bind_info` - An optional group and description that will be displayed in the bind overlay.
136+
| <code>{ group?: string, description?: string }</code>
129137

130138

131139

@@ -134,14 +142,15 @@ end)
134142

135143
### <Badge type="function" text="function" /> enter_bind_layer
136144

137-
<div class="language-lua"><pre><code>function pinnacle.input.enter_bind_layer(layer?: string)</code></pre></div>
145+
<div class="language-lua"><pre><code>function pinnacle.input.enter_bind_layer(layer: string)</code></pre></div>
138146

139147
Enters the bind layer `layer`, or the default layer if `layer` is nil.
140148

141149

142150
#### Parameters
143151

144-
`layer?`: <code>string</code> - The bind layer.
152+
`layer` - The bind layer.
153+
| <code>string</code>
145154

146155

147156

@@ -184,7 +193,8 @@ Input.set_xkb_config({
184193

185194
#### Parameters
186195

187-
`xkb_config`: <code><a href="/lua-reference/main/classes/pinnacle.input.XkbConfig">pinnacle.input.XkbConfig</a></code> - The new xkbconfig
196+
`xkb_config` - The new xkbconfig
197+
| <code><a href="/lua-reference/main/classes/pinnacle.input.XkbConfig">pinnacle.input.XkbConfig</a></code>
188198

189199

190200

@@ -205,8 +215,10 @@ Input.set_repeat_rate(100, 1000) -- Key must be held down for 1 second, then rep
205215

206216
#### Parameters
207217

208-
`rate`: <code>integer</code> - The time between repeats in milliseconds<br>
209-
`delay`: <code>integer</code> - The duration a key needs to be held down before repeating starts in milliseconds
218+
`rate` - The time between repeats in milliseconds
219+
| <code>integer</code><br>
220+
`delay` - The duration a key needs to be held down before repeating starts in milliseconds
221+
| <code>integer</code>
210222

211223

212224

@@ -230,7 +242,8 @@ Input.set_xkb_keymap(io.open("/path/to/keymap.xkb"):read("*a"))
230242

231243
#### Parameters
232244

233-
`keymap`: <code>string</code> - The keymap to set.
245+
`keymap` - The keymap to set.
246+
| <code>string</code>
234247

235248

236249

@@ -270,7 +283,8 @@ Fails if the index is out of bounds.
270283

271284
#### Parameters
272285

273-
`index`: <code>integer</code> - The index of the layout to switch to.
286+
`index` - The index of the layout to switch to.
287+
| <code>integer</code>
274288

275289

276290

@@ -289,7 +303,8 @@ This allows you to set it at runtime.
289303

290304
#### Parameters
291305

292-
`theme`: <code>string</code> - The name of the xcursor theme.
306+
`theme` - The name of the xcursor theme.
307+
| <code>string</code>
293308

294309

295310

@@ -308,7 +323,8 @@ This allows you to set it at runtime.
308323

309324
#### Parameters
310325

311-
`size`: <code>integer</code> - The new size of the cursor.
326+
`size` - The new size of the cursor.
327+
| <code>integer</code>
312328

313329

314330

@@ -341,7 +357,8 @@ Input.connect_signal({
341357

342358
#### Parameters
343359

344-
`signals`: <code><a href="/lua-reference/main/classes/pinnacle.input.InputSignal">pinnacle.input.InputSignal</a></code> - The signal you want to connect to
360+
`signals` - The signal you want to connect to
361+
| <code><a href="/lua-reference/main/classes/pinnacle.input.InputSignal">pinnacle.input.InputSignal</a></code>
345362

346363

347364

0 commit comments

Comments
 (0)