orx  stable
Portable Game Engine
orxFont.h
Go to the documentation of this file.
1 /* Orx - Portable Game Engine
2  *
3  * Copyright (c) 2008-2017 Orx-Project
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  *
18  * 2. Altered source versions must be plainly marked as such, and must not be
19  * misrepresented as being the original software.
20  *
21  * 3. This notice may not be removed or altered from any source
22  * distribution.
23  */
24 
43 #ifndef _orxFONT_H_
44 #define _orxFONT_H_
45 
46 #include "orxInclude.h"
47 
48 #include "display/orxTexture.h"
49 #include "math/orxVector.h"
50 
51 
54 #define orxFONT_KZ_DEFAULT_FONT_NAME "default"
55 
56 
58 typedef struct __orxFONT_t orxFONT;
59 
60 
63 extern orxDLLAPI void orxFASTCALL orxFont_Setup();
64 
68 extern orxDLLAPI orxSTATUS orxFASTCALL orxFont_Init();
69 
72 extern orxDLLAPI void orxFASTCALL orxFont_Exit();
73 
74 
78 extern orxDLLAPI orxFONT *orxFASTCALL orxFont_Create();
79 
84 extern orxDLLAPI orxFONT *orxFASTCALL orxFont_CreateFromConfig(const orxSTRING _zConfigID);
85 
90 extern orxDLLAPI orxSTATUS orxFASTCALL orxFont_Delete(orxFONT *_pstFont);
91 
92 
96 extern orxDLLAPI const orxFONT *orxFASTCALL orxFont_GetDefaultFont();
97 
98 
104 extern orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetTexture(orxFONT *_pstFont, orxTEXTURE *_pstTexture);
105 
111 extern orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterList(orxFONT *_pstFont, const orxSTRING _zList);
112 
118 extern orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterHeight(orxFONT *_pstFont, orxFLOAT _fCharacterHeight);
119 
126 extern orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterWidthList(orxFONT *_pstFont, orxU32 _u32CharacterNumber, const orxFLOAT *_afCharacterWidthList);
127 
133 extern orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterSpacing(orxFONT *_pstFont, const orxVECTOR *_pvSpacing);
134 
140 extern orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetOrigin(orxFONT *_pstFont, const orxVECTOR *_pvOrigin);
141 
147 extern orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetSize(orxFONT *_pstFont, const orxVECTOR *_pvSize);
148 
149 
154 extern orxDLLAPI orxTEXTURE *orxFASTCALL orxFont_GetTexture(const orxFONT *_pstFont);
155 
160 extern orxDLLAPI const orxSTRING orxFASTCALL orxFont_GetCharacterList(const orxFONT *_pstFont);
161 
166 extern orxDLLAPI orxFLOAT orxFASTCALL orxFont_GetCharacterHeight(const orxFONT *_pstFont);
167 
173 extern orxDLLAPI orxFLOAT orxFASTCALL orxFont_GetCharacterWidth(const orxFONT *_pstFont, orxU32 _u32CharacterCodePoint);
174 
180 extern orxDLLAPI orxVECTOR *orxFASTCALL orxFont_GetCharacterSpacing(const orxFONT *_pstFont, orxVECTOR *_pvSpacing);
181 
187 extern orxDLLAPI orxVECTOR *orxFASTCALL orxFont_GetOrigin(const orxFONT *_pstFont, orxVECTOR *_pvOrigin);
188 
194 extern orxDLLAPI orxVECTOR *orxFASTCALL orxFont_GetSize(const orxFONT *_pstFont, orxVECTOR *_pvSize);
195 
196 
201 extern orxDLLAPI const orxCHARACTER_MAP *orxFASTCALL orxFont_GetMap(const orxFONT *_pstFont);
202 
203 
208 extern orxDLLAPI const orxSTRING orxFASTCALL orxFont_GetName(const orxFONT *_pstFont);
209 
210 #endif /* _orxFONT_H_ */
211 
orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetOrigin(orxFONT *_pstFont, const orxVECTOR *_pvOrigin)
orxDLLAPI const orxCHARACTER_MAP *orxFASTCALL orxFont_GetMap(const orxFONT *_pstFont)
struct __orxTEXTURE_t orxTEXTURE
Definition: orxTexture.h:77
orxDLLAPI const orxSTRING orxFASTCALL orxFont_GetCharacterList(const orxFONT *_pstFont)
orxDLLAPI orxVECTOR *orxFASTCALL orxFont_GetCharacterSpacing(const orxFONT *_pstFont, orxVECTOR *_pvSpacing)
orxDLLAPI orxFONT *orxFASTCALL orxFont_CreateFromConfig(const orxSTRING _zConfigID)
orxDLLAPI orxSTATUS orxFASTCALL orxFont_Init()
orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterHeight(orxFONT *_pstFont, orxFLOAT _fCharacterHeight)
orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetSize(orxFONT *_pstFont, const orxVECTOR *_pvSize)
orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterWidthList(orxFONT *_pstFont, orxU32 _u32CharacterNumber, const orxFLOAT *_afCharacterWidthList)
orxDLLAPI orxFONT *orxFASTCALL orxFont_Create()
orxDLLAPI orxVECTOR *orxFASTCALL orxFont_GetOrigin(const orxFONT *_pstFont, orxVECTOR *_pvOrigin)
orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterList(orxFONT *_pstFont, const orxSTRING _zList)
orxSTATUS
Definition: orxType.h:243
orxDLLAPI const orxSTRING orxFASTCALL orxFont_GetName(const orxFONT *_pstFont)
orxDLLAPI orxTEXTURE *orxFASTCALL orxFont_GetTexture(const orxFONT *_pstFont)
orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetTexture(orxFONT *_pstFont, orxTEXTURE *_pstTexture)
orxDLLAPI orxSTATUS orxFASTCALL orxFont_SetCharacterSpacing(orxFONT *_pstFont, const orxVECTOR *_pvSpacing)
#define orxDLLAPI
Definition: orxDecl.h:387
orxDLLAPI orxFLOAT orxFASTCALL orxFont_GetCharacterHeight(const orxFONT *_pstFont)
orxDLLAPI const orxFONT *orxFASTCALL orxFont_GetDefaultFont()
orxDLLAPI orxVECTOR *orxFASTCALL orxFont_GetSize(const orxFONT *_pstFont, orxVECTOR *_pvSize)
orxDLLAPI void orxFASTCALL orxFont_Setup()
orxDLLAPI void orxFASTCALL orxFont_Exit()
orxDLLAPI orxSTATUS orxFASTCALL orxFont_Delete(orxFONT *_pstFont)
orxDLLAPI orxFLOAT orxFASTCALL orxFont_GetCharacterWidth(const orxFONT *_pstFont, orxU32 _u32CharacterCodePoint)
struct __orxFONT_t orxFONT
Definition: orxFont.h:58

Generated for orx by doxygen 1.5.6