Mercurial > molko
annotate src/font.h @ 17:fc71221b7bee
core: minimal cleanups
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 08 Jan 2020 20:08:17 +0100 |
parents | c91c3272101b |
children | 63eaec5ceba9 |
rev | line source |
---|---|
10
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 /* |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 * font.h -- basic font management |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 * |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr> |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 * |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 * purpose with or without fee is hereby granted, provided that the above |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 * copyright notice and this permission notice appear in all copies. |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 * |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 */ |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 #ifndef MOLKO_FONT_H |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 #define MOLKO_FONT_H |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 /** |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 * \file font.h |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 * \brief Basic font management. |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 */ |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 #include <stddef.h> |
17
fc71221b7bee
core: minimal cleanups
David Demelier <markand@malikania.fr>
parents:
10
diff
changeset
|
28 #include <stdint.h> |
10
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 struct font; |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 struct texture; |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 /** |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 * Open font from path file. |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 * |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 * \pre path != NULL |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 * \param path the path to the font |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 * \param size the desired size |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 * \return the font or NULL on error |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 */ |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 struct font * |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 font_openf(const char *path, unsigned size); |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 /** |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 * Open font from memory buffer. |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 * |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 * \pre buffer != NULL |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 * \param buffer the memory buffer |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 * \param buflen the memory buffer length |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 * \param size the desired size |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 * \warning The buffer must remain valid until font is closed |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 * \return the font or NULL on error |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 */ |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 struct font * |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 font_openb(const void *buffer, size_t buflen, unsigned size); |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 /** |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 * Render a text. |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 * |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 * \pre font != NULL |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 * \pre text != NULL |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 * \param font the font handle |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 * \param text the text in UTF-8 |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 * \param color the color |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 */ |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 struct texture * |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 font_render(struct font *font, const char *text, uint32_t color); |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 /** |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 * Close the font. |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 * |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 * \pre font != NULL |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 * \param font the font handle |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 */ |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 void |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 font_close(struct font *font); |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 |
c91c3272101b
core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 #endif /* !MOLKO_FONT_H */ |