2 * kmscon - Text Renderer
4 * Copyright (c) 2012 David Herrmann <dh.herrmann@googlemail.com>
6 * Permission is hereby granted, free of charge, to any person obtaining
7 * a copy of this software and associated documentation files
8 * (the "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sublicense, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 * The Text-Renderer subsystem provides a simple way to draw text into a
29 * framebuffer. The system is modular and several different backends are
30 * available that can be used.
31 * The system is split into:
32 * - Font renderer: The font renderer allows selecting fonts and rendering
33 * single glyphs into memory-buffers
34 * - Text renderer: The text renderer uses the font renderer to draw a whole
35 * console into a framebuffer.
49 struct kmscon_font_attr;
52 struct kmscon_font_ops;
54 #define KMSCON_FONT_MAX_NAME 128
55 #define KMSCON_FONT_DEFAULT_NAME "monospace"
56 #define KMSCON_FONT_DEFAULT_PPI 72
58 struct kmscon_font_attr {
59 char name[KMSCON_FONT_MAX_NAME];
68 void kmscon_font_attr_normalize(struct kmscon_font_attr *attr);
69 bool kmscon_font_attr_match(const struct kmscon_font_attr *a1,
70 const struct kmscon_font_attr *a2);
73 struct uterm_video_buffer buf;
79 const struct kmscon_font_ops *ops;
80 struct kmscon_font_attr attr;
81 unsigned int baseline;
85 struct kmscon_font_ops {
87 int (*init) (struct kmscon_font *out,
88 const struct kmscon_font_attr *attr);
89 void (*destroy) (struct kmscon_font *font);
90 int (*render) (struct kmscon_font *font, kmscon_symbol_t sym,
91 const struct kmscon_glyph **out);
92 int (*render_empty) (struct kmscon_font *font,
93 const struct kmscon_glyph **out);
94 int (*render_inval) (struct kmscon_font *font,
95 const struct kmscon_glyph **out);
98 int kmscon_font_register(const struct kmscon_font_ops *ops);
99 void kmscon_font_unregister(const char *name);
101 int kmscon_font_find(struct kmscon_font **out,
102 const struct kmscon_font_attr *attr,
103 const char *backend);
104 void kmscon_font_ref(struct kmscon_font *font);
105 void kmscon_font_unref(struct kmscon_font *font);
107 int kmscon_font_render(struct kmscon_font *font, kmscon_symbol_t sym,
108 const struct kmscon_glyph **out);
109 int kmscon_font_render_empty(struct kmscon_font *font,
110 const struct kmscon_glyph **out);
111 int kmscon_font_render_inval(struct kmscon_font *font,
112 const struct kmscon_glyph **out);
117 struct kmscon_text_ops;
121 const struct kmscon_text_ops *ops;
124 struct kmscon_font *font;
125 struct uterm_screen *screen;
131 struct kmscon_text_ops {
133 int (*init) (struct kmscon_text *txt);
134 void (*destroy) (struct kmscon_text *txt);
135 int (*set) (struct kmscon_text *txt);
136 void (*unset) (struct kmscon_text *txt);
137 int (*prepare) (struct kmscon_text *txt);
138 int (*draw) (struct kmscon_text *txt, kmscon_symbol_t ch,
139 unsigned int posx, unsigned int posy,
140 const struct kmscon_console_attr *attr);
141 int (*render) (struct kmscon_text *txt);
142 void (*abort) (struct kmscon_text *txt);
145 int kmscon_text_register(const struct kmscon_text_ops *ops);
146 void kmscon_text_unregister(const char *name);
148 int kmscon_text_new(struct kmscon_text **out, const char *backend);
149 void kmscon_text_ref(struct kmscon_text *txt);
150 void kmscon_text_unref(struct kmscon_text *txt);
152 int kmscon_text_set(struct kmscon_text *txt,
153 struct kmscon_font *font,
154 struct uterm_screen *screen);
155 void kmscon_text_unset(struct kmscon_text *txt);
156 unsigned int kmscon_text_get_cols(struct kmscon_text *txt);
157 unsigned int kmscon_text_get_rows(struct kmscon_text *txt);
159 int kmscon_text_prepare(struct kmscon_text *txt);
160 int kmscon_text_draw(struct kmscon_text *txt, kmscon_symbol_t ch,
161 unsigned int posx, unsigned int posy,
162 const struct kmscon_console_attr *attr);
163 int kmscon_text_render(struct kmscon_text *txt);
164 void kmscon_text_abort(struct kmscon_text *txt);
166 int kmscon_text_prepare_cb(struct kmscon_console *con, void *data);
167 int kmscon_text_draw_cb(struct kmscon_console *con, kmscon_symbol_t ch,
168 unsigned int posx, unsigned int posy,
169 const struct kmscon_console_attr *attr, void *data);
170 int kmscon_text_render_cb(struct kmscon_console *con, void *data);
172 /* modularized backends */
174 #ifdef KMSCON_HAVE_UNIFONT
176 int kmscon_font_unifont_load(void);
177 void kmscon_font_unifont_unload(void);
181 static inline int kmscon_font_unifont_load(void)
186 static inline void kmscon_font_unifont_unload(void)
193 #ifdef KMSCON_HAVE_8X16
195 int kmscon_font_8x16_load(void);
196 void kmscon_font_8x16_unload(void);
200 static inline int kmscon_font_8x16_load(void)
205 static inline void kmscon_font_8x16_unload(void)
211 #ifdef KMSCON_HAVE_FREETYPE2
213 int kmscon_font_freetype2_load(void);
214 void kmscon_font_freetype2_unload(void);
218 static inline int kmscon_font_freetype2_load(void)
223 static inline void kmscon_font_freetype2_unload(void)
229 #ifdef KMSCON_HAVE_PANGO
231 int kmscon_font_pango_load(void);
232 void kmscon_font_pango_unload(void);
236 static inline int kmscon_font_pango_load(void)
241 static inline void kmscon_font_pango_unload(void)
247 #ifdef KMSCON_HAVE_BBLIT
249 int kmscon_text_bblit_load(void);
250 void kmscon_text_bblit_unload(void);
254 static inline int kmscon_text_bblit_load(void)
259 static inline void kmscon_text_bblit_unload(void)
265 #ifdef KMSCON_HAVE_BBULK
267 int kmscon_text_bbulk_load(void);
268 void kmscon_text_bbulk_unload(void);
272 static inline int kmscon_text_bbulk_load(void)
277 static inline void kmscon_text_bbulk_unload(void)
283 #ifdef KMSCON_HAVE_GLES2
285 int kmscon_text_gltex_load(void);
286 void kmscon_text_gltex_unload(void);
290 static inline int kmscon_text_gltex_load(void)
295 static inline void kmscon_text_gltex_unload(void)
301 #endif /* KMSCON_TEXT_H */