1 /* RetroArch - A frontend for libretro. 2 * Copyright (C) 2010-2014 - Hans-Kristian Arntzen 3 * Copyright (C) 2011-2017 - Daniel De Matteis 4 * 5 * RetroArch is free software: you can redistribute it and/or modify it under the terms 6 * of the GNU General Public License as published by the Free Software Found- 7 * ation, either version 3 of the License, or (at your option) any later version. 8 * 9 * RetroArch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 11 * PURPOSE. See the GNU General Public License for more details. 12 * 13 * You should have received a copy of the GNU General Public License along with RetroArch. 14 * If not, see <http://www.gnu.org/licenses/>. 15 */ 16 17 #ifndef __FONT_DRIVER_H__ 18 #define __FONT_DRIVER_H__ 19 20 #include <stdint.h> 21 22 #include <boolean.h> 23 #include <retro_common_api.h> 24 25 #include "../retroarch.h" 26 27 #include "video_defines.h" 28 29 RETRO_BEGIN_DECLS 30 31 /* All coordinates and offsets are top-left oriented. 32 * 33 * This is a texture-atlas approach which allows text to 34 * be drawn in a single draw call. 35 * 36 * It is up to the code using this interface to actually 37 * generate proper vertex buffers and upload the atlas texture to GPU. */ 38 39 struct font_glyph 40 { 41 unsigned width; 42 unsigned height; 43 44 /* Texel coordinate offset for top-left pixel of this glyph. */ 45 unsigned atlas_offset_x; 46 unsigned atlas_offset_y; 47 48 /* When drawing this glyph, apply an offset to 49 * current X/Y draw coordinate. */ 50 int draw_offset_x; 51 int draw_offset_y; 52 53 /* Advance X/Y draw coordinates after drawing this glyph. */ 54 int advance_x; 55 int advance_y; 56 }; 57 58 struct font_atlas 59 { 60 uint8_t *buffer; /* Alpha channel. */ 61 unsigned width; 62 unsigned height; 63 bool dirty; 64 }; 65 66 struct font_params 67 { 68 /* Drop shadow offset. 69 * If both are 0, no drop shadow will be rendered. */ 70 int drop_x, drop_y; 71 72 /* ABGR. Use the macros. */ 73 uint32_t color; 74 75 float x; 76 float y; 77 float scale; 78 /* Drop shadow color multiplier. */ 79 float drop_mod; 80 /* Drop shadow alpha */ 81 float drop_alpha; 82 83 enum text_alignment text_align; 84 85 bool full_screen; 86 }; 87 88 struct font_line_metrics 89 { 90 float height; 91 float ascender; 92 float descender; 93 }; 94 95 typedef struct font_renderer 96 { 97 void *(*init)(void *data, const char *font_path, 98 float font_size, bool is_threaded); 99 void (*free)(void *data, bool is_threaded); 100 void (*render_msg)(void *userdata, 101 void *data, const char *msg, 102 const struct font_params *params); 103 const char *ident; 104 105 const struct font_glyph *(*get_glyph)(void *data, uint32_t code); 106 void (*bind_block)(void *data, void *block); 107 void (*flush)(unsigned width, unsigned height, void *data); 108 109 int (*get_message_width)(void *data, const char *msg, unsigned msg_len_full, float scale); 110 bool (*get_line_metrics)(void* data, struct font_line_metrics **metrics); 111 } font_renderer_t; 112 113 typedef struct font_renderer_driver 114 { 115 void *(*init)(const char *font_path, float font_size); 116 117 struct font_atlas *(*get_atlas)(void *data); 118 119 /* Returns NULL if no glyph for this code is found. */ 120 const struct font_glyph *(*get_glyph)(void *data, uint32_t code); 121 122 void (*free)(void *data); 123 124 const char *(*get_default_font)(void); 125 126 const char *ident; 127 128 bool (*get_line_metrics)(void* data, struct font_line_metrics **metrics); 129 } font_renderer_driver_t; 130 131 typedef struct 132 { 133 const font_renderer_t *renderer; 134 void *renderer_data; 135 float size; 136 } font_data_t; 137 138 /* font_path can be NULL for default font. */ 139 int font_renderer_create_default( 140 const font_renderer_driver_t **drv, 141 void **handle, 142 const char *font_path, unsigned font_size); 143 144 void font_driver_render_msg(void *data, 145 const char *msg, const void *params, void *font_data); 146 147 void font_driver_bind_block(void *font_data, void *block); 148 149 int font_driver_get_message_width(void *font_data, const char *msg, unsigned len, float scale); 150 151 void font_driver_flush(unsigned width, unsigned height, void *font_data); 152 153 void font_driver_free(void *font_data); 154 155 font_data_t *font_driver_init_first( 156 void *video_data, 157 const char *font_path, 158 float font_size, 159 bool threading_hint, 160 bool is_threaded, 161 enum font_driver_render_api api); 162 163 void font_driver_init_osd( 164 void *video_data, 165 const void *video_info_data, 166 bool threading_hint, 167 bool is_threaded, 168 enum font_driver_render_api api); 169 170 void font_driver_free_osd(void); 171 172 int font_driver_get_line_height(void *font_data, float scale); 173 int font_driver_get_line_ascender(void *font_data, float scale); 174 int font_driver_get_line_descender(void *font_data, float scale); 175 int font_driver_get_line_centre_offset(void *font_data, float scale); 176 177 extern font_renderer_t gl_raster_font; 178 extern font_renderer_t gl_core_raster_font; 179 extern font_renderer_t gl1_raster_font; 180 extern font_renderer_t d3d_xdk1_font; 181 extern font_renderer_t d3d_win32_font; 182 extern font_renderer_t ps2_font; 183 extern font_renderer_t vita2d_vita_font; 184 extern font_renderer_t ctr_font; 185 extern font_renderer_t wiiu_font; 186 extern font_renderer_t vulkan_raster_font; 187 extern font_renderer_t metal_raster_font; 188 extern font_renderer_t d3d10_font; 189 extern font_renderer_t d3d11_font; 190 extern font_renderer_t d3d12_font; 191 extern font_renderer_t caca_font; 192 extern font_renderer_t gdi_font; 193 extern font_renderer_t vga_font; 194 extern font_renderer_t sixel_font; 195 extern font_renderer_t switch_font; 196 197 extern font_renderer_driver_t stb_font_renderer; 198 extern font_renderer_driver_t stb_unicode_font_renderer; 199 extern font_renderer_driver_t freetype_font_renderer; 200 extern font_renderer_driver_t coretext_font_renderer; 201 extern font_renderer_driver_t bitmap_font_renderer; 202 203 RETRO_END_DECLS 204 205 #endif 206