File: al_get_text_dimensions.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 (33 lines) | stat: -rw-r--r-- 874 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
.TH "al_get_text_dimensions" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_get_text_dimensions \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_font.h>

void\ al_get_text_dimensions(const\ ALLEGRO_FONT\ *f,
\ \ \ char\ const\ *text,
\ \ \ int\ *bbx,\ int\ *bby,\ int\ *bbw,\ int\ *bbh)
\f[]
.fi
.SH DESCRIPTION
.PP
Sometimes, the al_get_text_width(3) and al_get_font_line_height(3)
functions are not enough for exact text placement, so this function
returns some additional information.
.PP
Returned variables (all in pixels):
.IP \[bu] 2
x, y \- Offset to upper left corner of bounding box.
.IP \[bu] 2
w, h \- Dimensions of bounding box.
.PP
Note that glyphs may go to the left and upwards of the X, in which case
x and y will have negative values.
.SH SEE ALSO
.PP
al_get_text_width(3), al_get_font_line_height(3),
al_get_ustr_dimensions(3)