File: al_draw_text.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 (43 lines) | stat: -rw-r--r-- 1,236 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
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.TH "al_draw_text" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_draw_text \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_font.h>

void\ al_draw_text(const\ ALLEGRO_FONT\ *font,
\ \ \ ALLEGRO_COLOR\ color,\ float\ x,\ float\ y,\ int\ flags,
\ \ \ char\ const\ *text)\ 
\f[]
.fi
.SH DESCRIPTION
.PP
Writes the NUL\-terminated string \f[C]text\f[] onto the target bitmap
at position \f[C]x\f[], \f[C]y\f[], using the specified \f[C]font\f[].
.PP
The \f[C]flags\f[] parameter can be 0 or one of the following flags:
.IP \[bu] 2
ALLEGRO_ALIGN_LEFT \- Draw the text left\-aligned (same as 0).
.IP \[bu] 2
ALLEGRO_ALIGN_CENTRE \- Draw the text centered around the given
position.
.IP \[bu] 2
ALLEGRO_ALIGN_RIGHT \- Draw the text right\-aligned to the given
position.
.PP
It can also be combined with this flag:
.IP \[bu] 2
ALLEGRO_ALIGN_INTEGER \- Always draw text aligned to an integer pixel
position.
This was formerly the default behaviour.
Since: 5.0.8, 5.1.4
.PP
This function does not support newline characters (\f[C]\\n\f[]), but
you can use al_draw_multiline_text(3) for multi line text output.
.SH SEE ALSO
.PP
al_draw_ustr(3), al_draw_textf(3), al_draw_justified_text(3),
al_draw_multiline_text(3).