orxFont.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008- Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */


 
 
#ifndef _orxFONT_H_
#define _orxFONT_H_
 
#include "orxInclude.h"
 
#include "display/orxTexture.h"
#include "math/orxVector.h"
#include "render/orxShader.h"
 

#define orxFONT_KZ_CONFIG_TEXTURE_NAME                "Texture"
#define orxFONT_KZ_CONFIG_CHARACTER_LIST              "CharacterList"
#define orxFONT_KZ_CONFIG_CHARACTER_SIZE              "CharacterSize"
#define orxFONT_KZ_CONFIG_CHARACTER_HEIGHT            "CharacterHeight"
#define orxFONT_KZ_CONFIG_CHARACTER_WIDTH_LIST        "CharacterWidthList"
#define orxFONT_KZ_CONFIG_CHARACTER_SPACING           "CharacterSpacing"
#define orxFONT_KZ_CONFIG_CHARACTER_PADDING           "CharacterPadding"
#define orxFONT_KZ_CONFIG_TEXTURE_ORIGIN              "TextureOrigin"
#define orxFONT_KZ_CONFIG_TEXTURE_SIZE                "TextureSize"
#define orxFONT_KZ_CONFIG_KEEP_IN_CACHE               "KeepInCache"
#define orxFONT_KZ_CONFIG_TYPEFACE                    "Typeface"
#define orxFONT_KZ_CONFIG_SDF                         "SDF"
#define orxFONT_KZ_CONFIG_SHADER                      "Shader"
 
#define orxFONT_KZ_ASCII                              "ascii"
#define orxFONT_KZ_ANSI                               "ansi"
 
#define orxFONT_KZ_DEFAULT_FONT_NAME                  "orx:font:default"
#define orxFONT_KZ_DEFAULT_TEXTURE_NAME               "orx:texture:font:default"
#define orxFONT_KZ_SDF_SHADER_NAME                    "orx:shader:font:sdf"
#define orxFONT_KZ_RESOURCE_GROUP                     "Font"
 

typedef struct __orxFONT_t                            orxFONT;
 

extern orxDLLAPI void orxFASTCALL                     orxFont_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_Init();

extern orxDLLAPI void orxFASTCALL                     orxFont_Exit();
 

extern orxDLLAPI orxFONT *orxFASTCALL                 orxFont_Create();

extern orxDLLAPI orxFONT *orxFASTCALL                 orxFont_CreateFromConfig(const orxSTRING _zConfigID);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_Delete(orxFONT *_pstFont);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_ClearCache();
 

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_SetTexture(orxFONT *_pstFont, orxTEXTURE *_pstTexture);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_SetCharacterList(orxFONT *_pstFont, const orxSTRING _zList);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_SetCharacterHeight(orxFONT *_pstFont, orxFLOAT _fCharacterHeight);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_SetCharacterWidthList(orxFONT *_pstFont, orxU32 _u32CharacterNumber, const orxFLOAT *_afCharacterWidthList);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_SetCharacterSpacing(orxFONT *_pstFont, const orxVECTOR *_pvSpacing);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_SetOrigin(orxFONT *_pstFont, const orxVECTOR *_pvOrigin);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_SetSize(orxFONT *_pstFont, const orxVECTOR *_pvSize);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_SetShader(orxFONT *_pstFont, orxSHADER *_pstShader);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxFont_SetShaderFromConfig(orxFONT *_pstFont, const orxSTRING _zShaderID);
 

extern orxDLLAPI orxTEXTURE *orxFASTCALL              orxFont_GetTexture(const orxFONT *_pstFont);

extern orxDLLAPI const orxSTRING orxFASTCALL          orxFont_GetCharacterList(const orxFONT *_pstFont);

extern orxDLLAPI orxFLOAT orxFASTCALL                 orxFont_GetCharacterHeight(const orxFONT *_pstFont);

extern orxDLLAPI orxFLOAT orxFASTCALL                 orxFont_GetCharacterWidth(const orxFONT *_pstFont, orxU32 _u32CharacterCodePoint);

extern orxDLLAPI orxVECTOR *orxFASTCALL               orxFont_GetCharacterSpacing(const orxFONT *_pstFont, orxVECTOR *_pvSpacing);

extern orxDLLAPI orxVECTOR *orxFASTCALL               orxFont_GetOrigin(const orxFONT *_pstFont, orxVECTOR *_pvOrigin);

extern orxDLLAPI orxVECTOR *orxFASTCALL               orxFont_GetSize(const orxFONT *_pstFont, orxVECTOR *_pvSize);

extern orxDLLAPI const orxSHADER *orxFASTCALL         orxFont_GetShader(const orxFONT *_pstFont);

extern orxDLLAPI orxBOOL orxFASTCALL                  orxFont_IsSDF(const orxFONT *_pstFont);
 

extern orxDLLAPI const orxCHARACTER_MAP *orxFASTCALL  orxFont_GetMap(const orxFONT *_pstFont);
 

extern orxDLLAPI orxFONT *orxFASTCALL                 orxFont_Get(const orxSTRING _zName);

extern orxDLLAPI const orxSTRING orxFASTCALL          orxFont_GetName(const orxFONT *_pstFont);
 
#endif /* _orxFONT_H_ */