Text.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com)
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_TEXT_H
26 #define SFML_TEXT_H
27 
29 // Headers
31 #include <SFML/Graphics/Export.h>
32 #include <SFML/Graphics/Color.h>
33 #include <SFML/Graphics/Rect.h>
34 #include <SFML/Graphics/Types.h>
36 #include <SFML/System/Vector2.h>
37 #include <stddef.h>
38 
39 
43 typedef enum
44 {
46  sfTextBold = 1 << 0,
47  sfTextItalic = 1 << 1,
48  sfTextUnderlined = 1 << 2
49 } sfTextStyle;
50 
51 
59 
69 
77 
90 
102 CSFML_GRAPHICS_API void sfText_setRotation(sfText* text, float angle);
103 
116 
132 
142 
153 CSFML_GRAPHICS_API float sfText_getRotation(const sfText* text);
154 
164 
174 
185 CSFML_GRAPHICS_API void sfText_move(sfText* text, sfVector2f offset);
186 
197 CSFML_GRAPHICS_API void sfText_rotate(sfText* text, float angle);
198 
209 CSFML_GRAPHICS_API void sfText_scale(sfText* text, sfVector2f factors);
210 
220 
230 
240 CSFML_GRAPHICS_API void sfText_setString(sfText* text, const char* string);
241 
249 CSFML_GRAPHICS_API void sfText_setUnicodeString(sfText* text, const sfUint32* string);
250 
265 CSFML_GRAPHICS_API void sfText_setFont(sfText* text, const sfFont* font);
266 
276 CSFML_GRAPHICS_API void sfText_setCharacterSize(sfText* text, unsigned int size);
277 
290 
301 
310 CSFML_GRAPHICS_API const char* sfText_getString(const sfText* text);
311 
321 
334 CSFML_GRAPHICS_API const sfFont* sfText_getFont(const sfText* text);
335 
344 CSFML_GRAPHICS_API unsigned int sfText_getCharacterSize(const sfText* text);
345 
355 
365 
383 
399 
415 
416 
417 #endif // SFML_TEXT_H
CSFML_GRAPHICS_API sfTransform sfText_getInverseTransform(const sfText *text)
Get the inverse of the combined transform of a text.
#define CSFML_GRAPHICS_API
CSFML_GRAPHICS_API void sfText_setCharacterSize(sfText *text, unsigned int size)
Set the character size of a text.
sfTextStyle
sfText styles
Definition: Text.h:43
CSFML_GRAPHICS_API void sfText_setUnicodeString(sfText *text, const sfUint32 *string)
Set the string of a text (from a unicode string)
Characters are bold.
Definition: Text.h:46
CSFML_GRAPHICS_API sfText * sfText_create(void)
Create a new text.
CSFML_GRAPHICS_API void sfText_move(sfText *text, sfVector2f offset)
Move a text by a given offset.
CSFML_GRAPHICS_API sfVector2f sfText_getOrigin(const sfText *text)
Get the local origin of a text.
CSFML_GRAPHICS_API float sfText_getRotation(const sfText *text)
Get the orientation of a text.
Characters are in italic.
Definition: Text.h:47
CSFML_GRAPHICS_API sfFloatRect sfText_getLocalBounds(const sfText *text)
Get the local bounding rectangle of a text.
CSFML_GRAPHICS_API sfVector2f sfText_getScale(const sfText *text)
Get the current scale of a text.
Characters are underlined.
Definition: Text.h:48
CSFML_GRAPHICS_API void sfText_setPosition(sfText *text, sfVector2f position)
Set the position of a text.
CSFML_GRAPHICS_API unsigned int sfText_getCharacterSize(const sfText *text)
Get the size of the characters of a text.
CSFML_GRAPHICS_API const sfUint32 * sfText_getUnicodeString(const sfText *text)
Get the string of a text (returns a unicode string)
sfFloatRect and sfIntRect are utility classes for manipulating rectangles.
Definition: Rect.h:38
Utility class for manpulating RGBA colors.
Definition: Color.h:38
CSFML_GRAPHICS_API void sfText_scale(sfText *text, sfVector2f factors)
Scale a text.
CSFML_GRAPHICS_API void sfText_setColor(sfText *text, sfColor color)
Set the global color of a text.
CSFML_GRAPHICS_API sfTransform sfText_getTransform(const sfText *text)
Get the combined transform of a text.
CSFML_GRAPHICS_API void sfText_setString(sfText *text, const char *string)
Set the string of a text (from an ANSI string)
struct sfFont sfFont
CSFML_GRAPHICS_API const char * sfText_getString(const sfText *text)
Get the string of a text (returns an ANSI string)
unsigned int sfUint32
Definition: Config.h:129
CSFML_GRAPHICS_API void sfText_setRotation(sfText *text, float angle)
Set the orientation of a text.
struct sfText sfText
CSFML_GRAPHICS_API sfColor sfText_getColor(const sfText *text)
Get the global color of a text.
CSFML_GRAPHICS_API void sfText_destroy(sfText *text)
Destroy an existing text.
CSFML_GRAPHICS_API void sfText_rotate(sfText *text, float angle)
Rotate a text.
CSFML_GRAPHICS_API sfUint32 sfText_getStyle(const sfText *text)
Get the style of a text.
CSFML_GRAPHICS_API sfVector2f sfText_findCharacterPos(const sfText *text, size_t index)
Return the position of the index-th character in a text.
CSFML_GRAPHICS_API void sfText_setOrigin(sfText *text, sfVector2f origin)
Set the local origin of a text.
Encapsulate a 3x3 transform matrix.
Definition: Transform.h:42
2-component vector of floats
Definition: Vector2.h:60
CSFML_GRAPHICS_API sfFloatRect sfText_getGlobalBounds(const sfText *text)
Get the global bounding rectangle of a text.
CSFML_GRAPHICS_API void sfText_setStyle(sfText *text, sfUint32 style)
Set the style of a text.
CSFML_GRAPHICS_API sfVector2f sfText_getPosition(const sfText *text)
Get the position of a text.
CSFML_GRAPHICS_API sfText * sfText_copy(const sfText *text)
Copy an existing text.
CSFML_GRAPHICS_API void sfText_setScale(sfText *text, sfVector2f scale)
Set the scale factors of a text.
Regular characters, no style.
Definition: Text.h:45
CSFML_GRAPHICS_API const sfFont * sfText_getFont(const sfText *text)
Get the font used by a text.
CSFML_GRAPHICS_API void sfText_setFont(sfText *text, const sfFont *font)
Set the font of a text.