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.
43 #include "tsm_screen.h"
48 struct kmscon_font_attr;
51 struct kmscon_font_ops;
53 #define KMSCON_FONT_MAX_NAME 128
54 #define KMSCON_FONT_DEFAULT_NAME "monospace"
55 #define KMSCON_FONT_DEFAULT_PPI 72
57 struct kmscon_font_attr {
58 char name[KMSCON_FONT_MAX_NAME];
67 void kmscon_font_attr_normalize(struct kmscon_font_attr *attr);
68 bool kmscon_font_attr_match(const struct kmscon_font_attr *a1,
69 const struct kmscon_font_attr *a2);
72 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,
91 uint32_t id, const uint32_t *ch, size_t len,
92 const struct kmscon_glyph **out);
93 int (*render_empty) (struct kmscon_font *font,
94 const struct kmscon_glyph **out);
95 int (*render_inval) (struct kmscon_font *font,
96 const struct kmscon_glyph **out);
99 int kmscon_font_register(const struct kmscon_font_ops *ops);
100 void kmscon_font_unregister(const char *name);
102 int kmscon_font_find(struct kmscon_font **out,
103 const struct kmscon_font_attr *attr,
104 const char *backend);
105 void kmscon_font_ref(struct kmscon_font *font);
106 void kmscon_font_unref(struct kmscon_font *font);
108 int kmscon_font_render(struct kmscon_font *font,
109 uint32_t id, const uint32_t *ch, size_t len,
110 const struct kmscon_glyph **out);
111 int kmscon_font_render_empty(struct kmscon_font *font,
112 const struct kmscon_glyph **out);
113 int kmscon_font_render_inval(struct kmscon_font *font,
114 const struct kmscon_glyph **out);
119 struct kmscon_text_ops;
123 const struct kmscon_text_ops *ops;
126 struct kmscon_font *font;
127 struct kmscon_font *bold_font;
128 struct uterm_display *disp;
134 struct kmscon_text_ops {
136 int (*init) (struct kmscon_text *txt);
137 void (*destroy) (struct kmscon_text *txt);
138 int (*set) (struct kmscon_text *txt);
139 void (*unset) (struct kmscon_text *txt);
140 int (*prepare) (struct kmscon_text *txt);
141 int (*draw) (struct kmscon_text *txt,
142 uint32_t id, const uint32_t *ch, size_t len,
144 unsigned int posx, unsigned int posy,
145 const struct tsm_screen_attr *attr);
146 int (*render) (struct kmscon_text *txt);
147 void (*abort) (struct kmscon_text *txt);
150 int kmscon_text_register(const struct kmscon_text_ops *ops);
151 void kmscon_text_unregister(const char *name);
153 int kmscon_text_new(struct kmscon_text **out, const char *backend);
154 void kmscon_text_ref(struct kmscon_text *txt);
155 void kmscon_text_unref(struct kmscon_text *txt);
157 int kmscon_text_set(struct kmscon_text *txt,
158 struct kmscon_font *font,
159 struct kmscon_font *bold_font,
160 struct uterm_display *disp);
161 void kmscon_text_unset(struct kmscon_text *txt);
162 unsigned int kmscon_text_get_cols(struct kmscon_text *txt);
163 unsigned int kmscon_text_get_rows(struct kmscon_text *txt);
165 int kmscon_text_prepare(struct kmscon_text *txt);
166 int kmscon_text_draw(struct kmscon_text *txt,
167 uint32_t id, const uint32_t *ch, size_t len,
169 unsigned int posx, unsigned int posy,
170 const struct tsm_screen_attr *attr);
171 int kmscon_text_render(struct kmscon_text *txt);
172 void kmscon_text_abort(struct kmscon_text *txt);
174 int kmscon_text_prepare_cb(struct tsm_screen *con, void *data);
175 int kmscon_text_draw_cb(struct tsm_screen *con,
176 uint32_t id, const uint32_t *ch, size_t len,
178 unsigned int posx, unsigned int posy,
179 const struct tsm_screen_attr *attr, void *data);
180 int kmscon_text_render_cb(struct tsm_screen *con, void *data);
182 /* modularized backends */
184 #ifdef BUILD_ENABLE_FONT_8X16
186 int kmscon_font_8x16_load(void);
187 void kmscon_font_8x16_unload(void);
191 static inline int kmscon_font_8x16_load(void)
196 static inline void kmscon_font_8x16_unload(void)
202 #ifdef BUILD_ENABLE_FONT_UNIFONT
204 int kmscon_font_unifont_load(void);
205 void kmscon_font_unifont_unload(void);
209 static inline int kmscon_font_unifont_load(void)
214 static inline void kmscon_font_unifont_unload(void)
220 #ifdef BUILD_ENABLE_FONT_FREETYPE2
222 int kmscon_font_freetype2_load(void);
223 void kmscon_font_freetype2_unload(void);
227 static inline int kmscon_font_freetype2_load(void)
232 static inline void kmscon_font_freetype2_unload(void)
238 #ifdef BUILD_ENABLE_FONT_PANGO
240 int kmscon_font_pango_load(void);
241 void kmscon_font_pango_unload(void);
245 static inline int kmscon_font_pango_load(void)
250 static inline void kmscon_font_pango_unload(void)
256 #ifdef BUILD_ENABLE_RENDERER_BBLIT
258 int kmscon_text_bblit_load(void);
259 void kmscon_text_bblit_unload(void);
263 static inline int kmscon_text_bblit_load(void)
268 static inline void kmscon_text_bblit_unload(void)
274 #ifdef BUILD_ENABLE_RENDERER_BBULK
276 int kmscon_text_bbulk_load(void);
277 void kmscon_text_bbulk_unload(void);
281 static inline int kmscon_text_bbulk_load(void)
286 static inline void kmscon_text_bbulk_unload(void)
292 #ifdef BUILD_ENABLE_RENDERER_GLTEX
294 int kmscon_text_gltex_load(void);
295 void kmscon_text_gltex_unload(void);
299 static inline int kmscon_text_gltex_load(void)
304 static inline void kmscon_text_gltex_unload(void)
310 static inline void kmscon_font_load_all(void)
312 kmscon_font_8x16_load();
313 kmscon_font_unifont_load();
314 kmscon_font_pango_load();
315 kmscon_font_freetype2_load();
318 static inline void kmscon_font_unload_all(void)
320 kmscon_font_freetype2_unload();
321 kmscon_font_pango_unload();
322 kmscon_font_unifont_unload();
323 kmscon_font_8x16_unload();
326 static inline void kmscon_text_load_all(void)
328 kmscon_text_bbulk_load();
329 kmscon_text_bblit_load();
330 kmscon_text_gltex_load();
333 static inline void kmscon_text_unload_all(void)
335 kmscon_text_gltex_unload();
336 kmscon_text_bblit_unload();
337 kmscon_text_bbulk_unload();
340 #endif /* KMSCON_TEXT_H */