1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
.TH "Writing on the braille display" 3 "15 Jan 2004" "BrlAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Writing on the braille display \- write text to the braille display
More...
.SS "Functions"
.in +1c
.ti -1c
.RI "int \fBbrlapi_writeBrl\fP (uint32_t cursor, const char *str)"
.br
.ti -1c
.RI "int \fBbrlapi_writeBrlDots\fP (const char *dots)"
.br
.in -1c
.SH "DETAILED DESCRIPTION"
.PP
Once \fBbrlapi_getTty()\fP was called, the application can call \fBbrlapi_writeBrl()\fP to write things on the braille display.
.PP
\fBNote: \fP
.in +1c
Be sure to call \fBbrlapi_getTty()\fP \fIbefore\fP calling brlapi_write*(), or else you'll get an error. This is particularly not always trivial when writing multithreaded applications.
.SH "FUNCTION DOCUMENTATION"
.PP
.SS "int brlapi_writeBrl (uint32_t cursor, const char * str)"
.PP
Write the given \\0-terminated string to the braille display
.PP
If the string is too long, it is cut. If it's too short, spaces are appended.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIcursor\fP\fP
gives the cursor position; if less than or equal to 0 or greater than the display width, no cursor is shown at all;
.TP
\fB\fIstr\fP\fP
points on the string to be displayed.
.PP
\fBReturns: \fP
.in +1c
0 on success, -1 on error.
.SS "int brlapi_writeBrlDots (const char * dots)"
.PP
Write the given dots array to the display
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIdots\fP\fP
points on an array of dot information, one per character. Its size must hence be the same as what \fBbrlapi_getDisplaySize()\fP returns.
.PP
\fBReturns: \fP
.in +1c
0 on success, -1 on error.
|
