vrshoot

annotate libs/ft2static/freetype/ftsizes.h @ 0:b2f14e535253

find changesets by author, revision, files, or words in the commit message
initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
rev   line source
nuclear@0 1 /***************************************************************************/
nuclear@0 2 /* */
nuclear@0 3 /* ftsizes.h */
nuclear@0 4 /* */
nuclear@0 5 /* FreeType size objects management (specification). */
nuclear@0 6 /* */
nuclear@0 7 /* Copyright 1996-2001, 2003, 2004, 2006, 2009 by */
nuclear@0 8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
nuclear@0 9 /* */
nuclear@0 10 /* This file is part of the FreeType project, and may only be used, */
nuclear@0 11 /* modified, and distributed under the terms of the FreeType project */
nuclear@0 12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
nuclear@0 13 /* this file you indicate that you have read the license and */
nuclear@0 14 /* understand and accept it fully. */
nuclear@0 15 /* */
nuclear@0 16 /***************************************************************************/
nuclear@0 17
nuclear@0 18
nuclear@0 19 /*************************************************************************/
nuclear@0 20 /* */
nuclear@0 21 /* Typical application would normally not need to use these functions. */
nuclear@0 22 /* However, they have been placed in a public API for the rare cases */
nuclear@0 23 /* where they are needed. */
nuclear@0 24 /* */
nuclear@0 25 /*************************************************************************/
nuclear@0 26
nuclear@0 27
nuclear@0 28 #ifndef __FTSIZES_H__
nuclear@0 29 #define __FTSIZES_H__
nuclear@0 30
nuclear@0 31
nuclear@0 32 #include <ft2build.h>
nuclear@0 33 #include FT_FREETYPE_H
nuclear@0 34
nuclear@0 35 #ifdef FREETYPE_H
nuclear@0 36 #error "freetype.h of FreeType 1 has been loaded!"
nuclear@0 37 #error "Please fix the directory search order for header files"
nuclear@0 38 #error "so that freetype.h of FreeType 2 is found first."
nuclear@0 39 #endif
nuclear@0 40
nuclear@0 41
nuclear@0 42 FT_BEGIN_HEADER
nuclear@0 43
nuclear@0 44
nuclear@0 45 /*************************************************************************/
nuclear@0 46 /* */
nuclear@0 47 /* <Section> */
nuclear@0 48 /* sizes_management */
nuclear@0 49 /* */
nuclear@0 50 /* <Title> */
nuclear@0 51 /* Size Management */
nuclear@0 52 /* */
nuclear@0 53 /* <Abstract> */
nuclear@0 54 /* Managing multiple sizes per face. */
nuclear@0 55 /* */
nuclear@0 56 /* <Description> */
nuclear@0 57 /* When creating a new face object (e.g., with @FT_New_Face), an */
nuclear@0 58 /* @FT_Size object is automatically created and used to store all */
nuclear@0 59 /* pixel-size dependent information, available in the `face->size' */
nuclear@0 60 /* field. */
nuclear@0 61 /* */
nuclear@0 62 /* It is however possible to create more sizes for a given face, */
nuclear@0 63 /* mostly in order to manage several character pixel sizes of the */
nuclear@0 64 /* same font family and style. See @FT_New_Size and @FT_Done_Size. */
nuclear@0 65 /* */
nuclear@0 66 /* Note that @FT_Set_Pixel_Sizes and @FT_Set_Char_Size only */
nuclear@0 67 /* modify the contents of the current `active' size; you thus need */
nuclear@0 68 /* to use @FT_Activate_Size to change it. */
nuclear@0 69 /* */
nuclear@0 70 /* 99% of applications won't need the functions provided here, */
nuclear@0 71 /* especially if they use the caching sub-system, so be cautious */
nuclear@0 72 /* when using these. */
nuclear@0 73 /* */
nuclear@0 74 /*************************************************************************/
nuclear@0 75
nuclear@0 76
nuclear@0 77 /*************************************************************************/
nuclear@0 78 /* */
nuclear@0 79 /* <Function> */
nuclear@0 80 /* FT_New_Size */
nuclear@0 81 /* */
nuclear@0 82 /* <Description> */
nuclear@0 83 /* Create a new size object from a given face object. */
nuclear@0 84 /* */
nuclear@0 85 /* <Input> */
nuclear@0 86 /* face :: A handle to a parent face object. */
nuclear@0 87 /* */
nuclear@0 88 /* <Output> */
nuclear@0 89 /* asize :: A handle to a new size object. */
nuclear@0 90 /* */
nuclear@0 91 /* <Return> */
nuclear@0 92 /* FreeType error code. 0~means success. */
nuclear@0 93 /* */
nuclear@0 94 /* <Note> */
nuclear@0 95 /* You need to call @FT_Activate_Size in order to select the new size */
nuclear@0 96 /* for upcoming calls to @FT_Set_Pixel_Sizes, @FT_Set_Char_Size, */
nuclear@0 97 /* @FT_Load_Glyph, @FT_Load_Char, etc. */
nuclear@0 98 /* */
nuclear@0 99 FT_EXPORT( FT_Error )
nuclear@0 100 FT_New_Size( FT_Face face,
nuclear@0 101 FT_Size* size );
nuclear@0 102
nuclear@0 103
nuclear@0 104 /*************************************************************************/
nuclear@0 105 /* */
nuclear@0 106 /* <Function> */
nuclear@0 107 /* FT_Done_Size */
nuclear@0 108 /* */
nuclear@0 109 /* <Description> */
nuclear@0 110 /* Discard a given size object. Note that @FT_Done_Face */
nuclear@0 111 /* automatically discards all size objects allocated with */
nuclear@0 112 /* @FT_New_Size. */
nuclear@0 113 /* */
nuclear@0 114 /* <Input> */
nuclear@0 115 /* size :: A handle to a target size object. */
nuclear@0 116 /* */
nuclear@0 117 /* <Return> */
nuclear@0 118 /* FreeType error code. 0~means success. */
nuclear@0 119 /* */
nuclear@0 120 FT_EXPORT( FT_Error )
nuclear@0 121 FT_Done_Size( FT_Size size );
nuclear@0 122
nuclear@0 123
nuclear@0 124 /*************************************************************************/
nuclear@0 125 /* */
nuclear@0 126 /* <Function> */
nuclear@0 127 /* FT_Activate_Size */
nuclear@0 128 /* */
nuclear@0 129 /* <Description> */
nuclear@0 130 /* Even though it is possible to create several size objects for a */
nuclear@0 131 /* given face (see @FT_New_Size for details), functions like */
nuclear@0 132 /* @FT_Load_Glyph or @FT_Load_Char only use the one which has been */
nuclear@0 133 /* activated last to determine the `current character pixel size'. */
nuclear@0 134 /* */
nuclear@0 135 /* This function can be used to `activate' a previously created size */
nuclear@0 136 /* object. */
nuclear@0 137 /* */
nuclear@0 138 /* <Input> */
nuclear@0 139 /* size :: A handle to a target size object. */
nuclear@0 140 /* */
nuclear@0 141 /* <Return> */
nuclear@0 142 /* FreeType error code. 0~means success. */
nuclear@0 143 /* */
nuclear@0 144 /* <Note> */
nuclear@0 145 /* If `face' is the size's parent face object, this function changes */
nuclear@0 146 /* the value of `face->size' to the input size handle. */
nuclear@0 147 /* */
nuclear@0 148 FT_EXPORT( FT_Error )
nuclear@0 149 FT_Activate_Size( FT_Size size );
nuclear@0 150
nuclear@0 151 /* */
nuclear@0 152
nuclear@0 153
nuclear@0 154 FT_END_HEADER
nuclear@0 155
nuclear@0 156 #endif /* __FTSIZES_H__ */
nuclear@0 157
nuclear@0 158
nuclear@0 159 /* END */