File: al_set_keyboard_leds.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (23 lines) | stat: -rw-r--r-- 640 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.TH "al_set_keyboard_leds" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_set_keyboard_leds \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_set_keyboard_leds(int\ leds)
\f[]
.fi
.SH DESCRIPTION
.PP
Overrides the state of the keyboard LED indicators.
Set \f[C]leds\f[] to a combination of the keyboard modifier flags to
enable the corresponding LED indicators
(\f[C]ALLEGRO_KEYMOD_NUMLOCK\f[], \f[C]ALLEGRO_KEYMOD_CAPSLOCK\f[] and
\f[C]ALLEGRO_KEYMOD_SCROLLLOCK\f[] are supported) or to \-1 to return to
default behavior.
False is returned if the current keyboard driver cannot set LED
indicators.