Font.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages 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 freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_FONT_H
26 #define SFML_FONT_H
27 
29 // Headers
31 #include <SFML/Graphics/Export.h>
32 #include <SFML/Graphics/FontInfo.h>
33 #include <SFML/Graphics/Glyph.h>
34 #include <SFML/Graphics/Types.h>
36 #include <stddef.h>
37 
38 
47 CSFML_GRAPHICS_API sfFont* sfFont_createFromFile(const char* filename);
48 
58 CSFML_GRAPHICS_API sfFont* sfFont_createFromMemory(const void* data, size_t sizeInBytes);
59 
69 
79 
87 
100 CSFML_GRAPHICS_API sfGlyph sfFont_getGlyph(sfFont* font, sfUint32 codePoint, unsigned int characterSize, sfBool bold, float outlineThickness);
101 
113 CSFML_GRAPHICS_API float sfFont_getKerning(sfFont* font, sfUint32 first, sfUint32 second, unsigned int characterSize);
114 
124 CSFML_GRAPHICS_API float sfFont_getLineSpacing(sfFont* font, unsigned int characterSize);
125 
138 CSFML_GRAPHICS_API float sfFont_getUnderlinePosition(sfFont* font, unsigned int characterSize);
139 
151 CSFML_GRAPHICS_API float sfFont_getUnderlineThickness(sfFont* font, unsigned int characterSize);
152 
162 CSFML_GRAPHICS_API const sfTexture* sfFont_getTexture(sfFont* font, unsigned int characterSize);
163 
177 
178 
179 #endif // SFML_FONT_H
#define CSFML_GRAPHICS_API
CSFML_GRAPHICS_API sfGlyph sfFont_getGlyph(sfFont *font, sfUint32 codePoint, unsigned int characterSize, sfBool bold, float outlineThickness)
Get a glyph in a font.
CSFML_GRAPHICS_API float sfFont_getKerning(sfFont *font, sfUint32 first, sfUint32 second, unsigned int characterSize)
Get the kerning value corresponding to a given pair of characters in a font.
CSFML_GRAPHICS_API float sfFont_getLineSpacing(sfFont *font, unsigned int characterSize)
Get the line spacing value.
Set of callbacks that allow users to define custom file streams.
Definition: InputStream.h:44
CSFML_GRAPHICS_API const sfTexture * sfFont_getTexture(sfFont *font, unsigned int characterSize)
Get the texture containing the glyphs of a given size in a font.
sfFontInfo holds various information about a font
Definition: FontInfo.h:36
CSFML_GRAPHICS_API void sfFont_destroy(sfFont *font)
Destroy an existing font.
CSFML_GRAPHICS_API float sfFont_getUnderlinePosition(sfFont *font, unsigned int characterSize)
Get the position of the underline.
int sfBool
Definition: Config.h:153
CSFML_GRAPHICS_API sfFontInfo sfFont_getInfo(const sfFont *font)
Get the font information.
sfGlyph describes a glyph (a visual character)
Definition: Glyph.h:38
CSFML_GRAPHICS_API sfFont * sfFont_createFromStream(sfInputStream *stream)
Create a new image font a custom stream.
struct sfFont sfFont
unsigned int sfUint32
Definition: Config.h:176
CSFML_GRAPHICS_API sfFont * sfFont_createFromFile(const char *filename)
Create a new font from a file.
CSFML_GRAPHICS_API sfFont * sfFont_copy(const sfFont *font)
Copy an existing font.
struct sfTexture sfTexture
CSFML_GRAPHICS_API sfFont * sfFont_createFromMemory(const void *data, size_t sizeInBytes)
Create a new image font a file in memory.
CSFML_GRAPHICS_API float sfFont_getUnderlineThickness(sfFont *font, unsigned int characterSize)
Get the thickness of the underline.