File: al_get_system_config.3

package info (click to toggle)
allegro5 2%3A5.2.6.0-3%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 24,212 kB
  • sloc: ansic: 125,319; cpp: 15,781; objc: 4,579; python: 2,802; java: 2,254; javascript: 1,204; sh: 1,002; makefile: 51; perl: 37; xml: 25; pascal: 24
file content (52 lines) | stat: -rw-r--r-- 1,380 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
44
45
46
47
48
49
50
51
52
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_get_system_config" "3" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_get_system_config \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

ALLEGRO_CONFIG\ *al_get_system_config(void)
\f[]
.fi
.SH DESCRIPTION
.PP
Returns the system configuration structure.
The returned configuration should not be destroyed with
al_destroy_config(3).
This is mainly used for configuring Allegro and its addons.
You may populate this configuration before Allegro is installed to
control things like the logging levels and other features.
.PP
Allegro will try to populate this configuration by loading a
configuration file from a few different locations, in this order:
.IP \[bu] 2
\f[I]Unix only:\f[] /etc/allegro5rc
.IP \[bu] 2
\f[I]Unix only:\f[] $HOME/allegro5rc
.IP \[bu] 2
\f[I]Unix only:\f[] $HOME/.allegro5rc
.IP \[bu] 2
allegro5.cfg next to the executable
.PP
If multiple copies are found, then they are merged using
al_merge_config_into(3).
.PP
The contents of this file are documented inside a prototypical
\f[C]allegro5.cfg\f[] that you can find in the root directory of the
source distributions of Allegro.
They are also reproduced below.
.PP
Note that Allegro will not look into that file unless you make a copy of
it and place it next to your executable!
.IP
.nf
\f[C]
__ALLEGRO_5_CFG
\f[]
.fi