annotate libmlk-core/mlk/core/font.h @ 451:90a097b1aa0f

core: font -> mlk_font
author David Demelier <markand@malikania.fr>
date Sat, 18 Feb 2023 20:40:01 +0100
parents 773a082f0b91
children 5729efd23286
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
10
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
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 339
diff changeset
19 #ifndef MLK_CORE_FONT_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 339
diff changeset
20 #define MLK_CORE_FONT_H
10
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 #include <stddef.h>
c91c3272101b core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
24 #include "core.h"
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
25
10
c91c3272101b core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 struct texture;
c91c3272101b core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
451
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
28 enum mlk_font_style {
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
29 MLK_FONT_STYLE_ANTIALIASED,
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
30 MLK_FONT_STYLE_NONE,
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
31 MLK_FONT_STYLE_LAST
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 79
diff changeset
32 };
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 79
diff changeset
33
451
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
34 struct mlk_font {
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
35 enum mlk_font_style style;
253
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
36 void *handle;
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
37 };
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
38
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
39 CORE_BEGIN_DECLS
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
40
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
41 int
451
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
42 mlk_font_open(struct mlk_font *, const char *, unsigned int);
10
c91c3272101b core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
44 int
451
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
45 mlk_font_openmem(struct mlk_font *, const void *, size_t, unsigned int);
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
46
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
47 int
451
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
48 mlk_font_ok(const struct mlk_font *);
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 79
diff changeset
49
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
50 int
451
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
51 mlk_font_render(struct mlk_font *, struct texture *, const char *, unsigned long);
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
52
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
53 unsigned int
451
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
54 mlk_font_height(const struct mlk_font *);
10
c91c3272101b core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
56 int
451
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
57 mlk_font_query(const struct mlk_font *, const char *, unsigned int *, unsigned int *);
144
28d9bb62fcb1 core: add font_box function, closes #2495
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
58
10
c91c3272101b core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 void
451
90a097b1aa0f core: font -> mlk_font
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
60 mlk_font_finish(struct mlk_font *);
10
c91c3272101b core: implement fonts, closes #2444
David Demelier <markand@malikania.fr>
parents:
diff changeset
61
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
62 CORE_END_DECLS
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
63
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 339
diff changeset
64 #endif /* !MLK_CORE_FONT_H */