Mercurial > molko
annotate doxygen/page-howto-initialization.c @ 175:ce789473567e
rpg: disable inventory for now and add item.c
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 22 Oct 2020 15:27:57 +0200 |
parents | b386d25832c8 |
children |
rev | line source |
---|---|
77
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 /** |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 * \page howto-init Howto: initialization |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 * \tableofcontents |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 * |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 * Howto initialize the core. |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 * |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 * \section synopsis Synopsis |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 * |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 * Before using the core, you need to initialize the subsystems and internal |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 * backend API. |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 * |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 * \warning Even non-rendering modules requires initialization and some of them |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 * even require a window to be open. |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 * |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 * \section usage Usage |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 * |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 * The following table summarize the functions to be used at the beginning and |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 * the end of your game. |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 * |
97
58133933ea17
window: expose some data to avoid functions
David Demelier <markand@malikania.fr>
parents:
95
diff
changeset
|
20 * | System | Init function | Close function | Remarks | |
58133933ea17
window: expose some data to avoid functions
David Demelier <markand@malikania.fr>
parents:
95
diff
changeset
|
21 * |---------|------------------|--------------------|------------------------| |
147
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
22 * | General | sys_init | sys_finish | Required for most API | |
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
23 * | Window | window_init | window_finish | Required by some parts | |
77
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 * |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 * All init functions set an error code if any and you're encouraged to test the |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 * result and check the error if any. |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 * |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 * \section example Example |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 * |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 * Init the core and create a window of Full HD resolution. The function \ref |
95
e82eca4f8606
core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents:
77
diff
changeset
|
31 * panic will all the panic handler. |
77
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 * |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 * \code |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 * if (!sys_init()) |
95
e82eca4f8606
core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents:
77
diff
changeset
|
35 * panic(); |
77
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 * if (!window_init("My Awesome Game", 1920, 1080)) |
95
e82eca4f8606
core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents:
77
diff
changeset
|
37 * panic(); |
77
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 * \endcode |
837ef1d387b4
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 */ |