font: require compositor reference
[platform/upstream/kmscon.git] / src / font.h
1 /*
2  * kmscon - Font Management
3  *
4  * Copyright (c) 2011 David Herrmann <dh.herrmann@googlemail.com>
5  * Copyright (c) 2011 University of Tuebingen
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining
8  * a copy of this software and associated documentation files
9  * (the "Software"), to deal in the Software without restriction, including
10  * without limitation the rights to use, copy, modify, merge, publish,
11  * distribute, sublicense, and/or sell copies of the Software, and to
12  * permit persons to whom the Software is furnished to do so, subject to
13  * the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included
16  * in all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25  */
26
27 /*
28  * Font Management
29  * A font factory helps loading and initializing fonts. The font object is used
30  * to draw glyphs onto the screen.
31  * Efficient caching is used to allow fast drawing operations.
32  */
33
34 #ifndef KMSCON_FONT_H
35 #define KMSCON_FONT_H
36
37 #include <stdlib.h>
38 #include "output.h"
39 #include "unicode.h"
40
41 struct kmscon_font_factory;
42 struct kmscon_font;
43
44 int kmscon_font_factory_new(struct kmscon_font_factory **out,
45         struct kmscon_symbol_table *st, struct kmscon_compositor *comp);
46 void kmscon_font_factory_ref(struct kmscon_font_factory *ff);
47 void kmscon_font_factory_unref(struct kmscon_font_factory *ff);
48
49 int kmscon_font_factory_load(struct kmscon_font_factory *ff,
50         struct kmscon_font **out, unsigned int width, unsigned int height);
51
52 void kmscon_font_ref(struct kmscon_font *font);
53 void kmscon_font_unref(struct kmscon_font *font);
54
55 unsigned int kmscon_font_get_height(struct kmscon_font *font);
56 unsigned int kmscon_font_get_width(struct kmscon_font *font);
57 int kmscon_font_draw(struct kmscon_font *font, kmscon_symbol_t ch,
58                                         void *dcr, uint32_t x, uint32_t y);
59
60 #endif /* KMSCON_FONT_H */