1 /* 2 * Copyright 2009 Red Hat, Inc. 3 * 4 * This is part of HarfBuzz, a text shaping library. 5 * 6 * Permission is hereby granted, without written agreement and without 7 * license or royalty fees, to use, copy, modify, and distribute this 8 * software and its documentation for any purpose, provided that the 9 * above copyright notice and the following two paragraphs appear in 10 * all copies of this software. 11 * 12 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR 13 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES 14 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN 15 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 16 * DAMAGE. 17 * 18 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, 19 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 20 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS 21 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO 22 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. 23 * 24 * Red Hat Author(s): Behdad Esfahbod 25 */ 26 27 #ifndef HB_FT_H 28 #define HB_FT_H 29 30 #include "hb.h" 31 32 #include <ft2build.h> 33 #include FT_FREETYPE_H 34 35 HB_BEGIN_DECLS 36 37 /* 38 * Note: FreeType is not thread-safe. 39 * Hence, these functions are not either. 40 */ 41 42 /* 43 * hb-face from ft-face. 44 */ 45 46 /* This one creates a new hb-face for given ft-face. 47 * When the returned hb-face is destroyed, the destroy 48 * callback is called (if not NULL), with the ft-face passed 49 * to it. 50 * 51 * The client is responsible to make sure that ft-face is 52 * destroyed after hb-face is destroyed. 53 * 54 * Most often you don't want this function. You should use either 55 * hb_ft_face_create_cached(), or hb_ft_face_create_referenced(). 56 * In particular, if you are going to pass NULL as destroy, you 57 * probably should use (the more recent) hb_ft_face_create_referenced() 58 * instead. 59 */ 60 hb_face_t * 61 hb_ft_face_create (FT_Face ft_face, 62 hb_destroy_func_t destroy); 63 64 /* This version is like hb_ft_face_create(), except that it caches 65 * the hb-face using the generic pointer of the ft-face. This means 66 * that subsequent calls to this function with the same ft-face will 67 * return the same hb-face (correctly referenced). 68 * 69 * Client is still responsible for making sure that ft-face is destroyed 70 * after hb-face is. 71 */ 72 hb_face_t * 73 hb_ft_face_create_cached (FT_Face ft_face); 74 75 /* This version is like hb_ft_face_create(), except that it calls 76 * FT_Reference_Face() on ft-face, as such keeping ft-face alive 77 * as long as the hb-face is. 78 * 79 * This is the most convenient version to use. Use it unless you have 80 * very good reasons not to. 81 */ 82 hb_face_t * 83 hb_ft_face_create_referenced (FT_Face ft_face); 84 85 86 /* 87 * hb-font from ft-face. 88 */ 89 90 /* 91 * Note: 92 * 93 * Set face size on ft-face before creating hb-font from it. 94 * Otherwise hb-ft would NOT pick up the font size correctly. 95 */ 96 97 /* See notes on hb_ft_face_create(). Same issues re lifecycle-management 98 * apply here. Use hb_ft_font_create_referenced() if you can. */ 99 hb_font_t * 100 hb_ft_font_create (FT_Face ft_face, 101 hb_destroy_func_t destroy); 102 103 /* See notes on hb_ft_face_create_referenced() re lifecycle-management 104 * issues. */ 105 hb_font_t * 106 hb_ft_font_create_referenced (FT_Face ft_face); 107 108 109 /* Makes an hb_font_t use FreeType internally to implement font functions. */ 110 void 111 hb_ft_font_set_funcs (hb_font_t *font); 112 113 FT_Face 114 hb_ft_font_get_face (hb_font_t *font); 115 116 117 HB_END_DECLS 118 119 #endif /* HB_FT_H */ 120
