CSFML 2.6.1

- Main Page
- Related Pages
- Classes
- Files

- File List
- File Members

Loading...
Searching...
No Matches
Text.h
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2024 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_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>
35#include <SFML/Graphics/Transform.h>
36#include <SFML/System/Vector2.h>
37#include <stddef.h>
38
39
43 typedef enum
44{
45 sfTextRegular = 0,
46 sfTextBold = 1 << 0,
47 sfTextItalic = 1 << 1,
48 sfTextUnderlined = 1 << 2,
49 sfTextStrikeThrough = 1 << 3
50} sfTextStyle;
51
52
59 CSFML_GRAPHICS_API sfText* sfText_create(void);
60
69 CSFML_GRAPHICS_API sfText* sfText_copy(const sfText* text);
70
77 CSFML_GRAPHICS_API void sfText_destroy(sfText* text);
78
90 CSFML_GRAPHICS_API void sfText_setPosition(sfText* text, sfVector2f position);
91
103 CSFML_GRAPHICS_API void sfText_setRotation(sfText* text, float angle);
104
116 CSFML_GRAPHICS_API void sfText_setScale(sfText* text, sfVector2f scale);
117
132 CSFML_GRAPHICS_API void sfText_setOrigin(sfText* text, sfVector2f origin);
133
142 CSFML_GRAPHICS_API sfVector2f sfText_getPosition(const sfText* text);
143
154 CSFML_GRAPHICS_API float sfText_getRotation(const sfText* text);
155
164 CSFML_GRAPHICS_API sfVector2f sfText_getScale(const sfText* text);
165
174 CSFML_GRAPHICS_API sfVector2f sfText_getOrigin(const sfText* text);
175
186 CSFML_GRAPHICS_API void sfText_move(sfText* text, sfVector2f offset);
187
198 CSFML_GRAPHICS_API void sfText_rotate(sfText* text, float angle);
199
210 CSFML_GRAPHICS_API void sfText_scale(sfText* text, sfVector2f factors);
211
220 CSFML_GRAPHICS_API sfTransform sfText_getTransform(const sfText* text);
221
230 CSFML_GRAPHICS_API sfTransform sfText_getInverseTransform(const sfText* text);
231
241 CSFML_GRAPHICS_API void sfText_setString(sfText* text, const char* string);
242
250 CSFML_GRAPHICS_API void sfText_setUnicodeString(sfText* text, const sfUint32* string);
251
266 CSFML_GRAPHICS_API void sfText_setFont(sfText* text, const sfFont* font);
267
277 CSFML_GRAPHICS_API void sfText_setCharacterSize(sfText* text, unsigned int size);
278
292 CSFML_GRAPHICS_API void sfText_setLineSpacing(sfText* text, float spacingFactor);
293
312 CSFML_GRAPHICS_API void sfText_setLetterSpacing(sfText* text, float spacingFactor);
313
325 CSFML_GRAPHICS_API void sfText_setStyle(sfText* text, sfUint32 style);
326
341 CSFML_GRAPHICS_API void sfText_setColor(sfText* text, sfColor color);
342
354 CSFML_GRAPHICS_API void sfText_setFillColor(sfText* text, sfColor color);
355
365 CSFML_GRAPHICS_API void sfText_setOutlineColor(sfText* text, sfColor color);
366
380 CSFML_GRAPHICS_API void sfText_setOutlineThickness(sfText* text, float thickness);
381
390 CSFML_GRAPHICS_API const char* sfText_getString(const sfText* text);
391
400 CSFML_GRAPHICS_API const sfUint32* sfText_getUnicodeString(const sfText* text);
401
414 CSFML_GRAPHICS_API const sfFont* sfText_getFont(const sfText* text);
415
424 CSFML_GRAPHICS_API unsigned int sfText_getCharacterSize(const sfText* text);
425
436 CSFML_GRAPHICS_API float sfText_getLetterSpacing(const sfText* text);
437
448 CSFML_GRAPHICS_API float sfText_getLineSpacing(const sfText* text);
449
458 CSFML_GRAPHICS_API sfUint32 sfText_getStyle(const sfText* text);
459
471 CSFML_GRAPHICS_API sfColor sfText_getColor(const sfText* text);
472
481 CSFML_GRAPHICS_API sfColor sfText_getFillColor(const sfText* text);
482
491 CSFML_GRAPHICS_API sfColor sfText_getOutlineColor(const sfText* text);
492
501 CSFML_GRAPHICS_API float sfText_getOutlineThickness(const sfText* text);
502
519 CSFML_GRAPHICS_API sfVector2f sfText_findCharacterPos(const sfText* text, size_t index);
520
535 CSFML_GRAPHICS_API sfFloatRect sfText_getLocalBounds(const sfText* text);
536
551 CSFML_GRAPHICS_API sfFloatRect sfText_getGlobalBounds(const sfText* text);
552
553
554#endif // SFML_TEXT_H
Color.h
sfUint32
unsigned int sfUint32
Definition Config.h:176
Export.h
CSFML_GRAPHICS_API
#define CSFML_GRAPHICS_API
Definition Graphics/Export.h:43
Types.h
sfText
struct sfText sfText
Definition Graphics/Types.h:39
sfFont
struct sfFont sfFont
Definition Graphics/Types.h:31
Rect.h
sfText_getFont
const sfFont * sfText_getFont(const sfText *text)
Get the font used by a text.
sfText_getLetterSpacing
float sfText_getLetterSpacing(const sfText *text)
Get the size of the letter spacing factor.
sfText_getInverseTransform
sfTransform sfText_getInverseTransform(const sfText *text)
Get the inverse of the combined transform of a text.
sfText_setColor
void sfText_setColor(sfText *text, sfColor color)
Set the fill color of a text.
sfText_getString
const char * sfText_getString(const sfText *text)
Get the string of a text (returns an ANSI string)
sfText_setOutlineColor
void sfText_setOutlineColor(sfText *text, sfColor color)
Set the outline color of the text.
sfText_getUnicodeString
const sfUint32 * sfText_getUnicodeString(const sfText *text)
Get the string of a text (returns a unicode string)
sfText_scale
void sfText_scale(sfText *text, sfVector2f factors)
Scale a text.
sfText_setCharacterSize
void sfText_setCharacterSize(sfText *text, unsigned int size)
Set the character size of a text.
sfText_getPosition
sfVector2f sfText_getPosition(const sfText *text)
Get the position of a text.
sfText_setPosition
void sfText_setPosition(sfText *text, sfVector2f position)
Set the position of a text.
sfText_setFont
void sfText_setFont(sfText *text, const sfFont *font)
Set the font of a text.
sfText_getLocalBounds
sfFloatRect sfText_getLocalBounds(const sfText *text)
Get the local bounding rectangle of a text.
sfTextStyle
sfTextStyle
sfText styles
Definition Text.h:44
sfTextRegular
@ sfTextRegular
Regular characters, no style.
Definition Text.h:45
sfTextBold
@ sfTextBold
Bold characters.
Definition Text.h:46
sfTextStrikeThrough
@ sfTextStrikeThrough
Strike through characters.
Definition Text.h:49
sfTextUnderlined
@ sfTextUnderlined
Underlined characters.
Definition Text.h:48
sfTextItalic
@ sfTextItalic
Italic characters.
Definition Text.h:47
sfText_getRotation
float sfText_getRotation(const sfText *text)
Get the orientation of a text.
sfText_getStyle
sfUint32 sfText_getStyle(const sfText *text)
Get the style of a text.
sfText_getColor
sfColor sfText_getColor(const sfText *text)
Get the fill color of a text.
sfText_getOutlineThickness
float sfText_getOutlineThickness(const sfText *text)
Get the outline thickness of a text.
sfText_move
void sfText_move(sfText *text, sfVector2f offset)
Move a text by a given offset.
sfText_getScale
sfVector2f sfText_getScale(const sfText *text)
Get the current scale of a text.
sfText_setLineSpacing
void sfText_setLineSpacing(sfText *text, float spacingFactor)
Set the line spacing factor.
sfText_getCharacterSize
unsigned int sfText_getCharacterSize(const sfText *text)
Get the size of the characters of a text.
sfText_setString
void sfText_setString(sfText *text, const char *string)
Set the string of a text (from an ANSI string)
sfText_getOutlineColor
sfColor sfText_getOutlineColor(const sfText *text)
Get the outline color of a text.
sfText_getFillColor
sfColor sfText_getFillColor(const sfText *text)
Get the fill color of a text.
sfText_setScale
void sfText_setScale(sfText *text, sfVector2f scale)
Set the scale factors of a text.
sfText_setRotation
void sfText_setRotation(sfText *text, float angle)
Set the orientation of a text.
sfText_getLineSpacing
float sfText_getLineSpacing(const sfText *text)
Get the size of the line spacing factor.
sfText_setStyle
void sfText_setStyle(sfText *text, sfUint32 style)
Set the style of a text.
sfText_findCharacterPos
sfVector2f sfText_findCharacterPos(const sfText *text, size_t index)
Return the position of the index-th character in a text.
sfText_setOrigin
void sfText_setOrigin(sfText *text, sfVector2f origin)
Set the local origin of a text.
sfText_rotate
void sfText_rotate(sfText *text, float angle)
Rotate a text.
sfText_getOrigin
sfVector2f sfText_getOrigin(const sfText *text)
Get the local origin of a text.
sfText_setLetterSpacing
void sfText_setLetterSpacing(sfText *text, float spacingFactor)
Set the letter spacing factor.
sfText_setFillColor
void sfText_setFillColor(sfText *text, sfColor color)
Set the fill color of a text.
sfText_getGlobalBounds
sfFloatRect sfText_getGlobalBounds(const sfText *text)
Get the global bounding rectangle of a text.
sfText_setOutlineThickness
void sfText_setOutlineThickness(sfText *text, float thickness)
Set the thickness of the text's outline.
sfText_create
sfText * sfText_create(void)
Create a new text.
sfText_copy
sfText * sfText_copy(const sfText *text)
Copy an existing text.
sfText_getTransform
sfTransform sfText_getTransform(const sfText *text)
Get the combined transform of a text.
sfText_setUnicodeString
void sfText_setUnicodeString(sfText *text, const sfUint32 *string)
Set the string of a text (from a unicode string)
sfText_destroy
void sfText_destroy(sfText *text)
Destroy an existing text.
Transform.h
Vector2.h
sfColor
Utility class for manpulating RGBA colors.
Definition Color.h:39
sfFloatRect
sfFloatRect and sfIntRect are utility classes for manipulating rectangles.
Definition Rect.h:41
sfTransform
Encapsulate a 3x3 transform matrix.
Definition Transform.h:43
sfVector2f
2-component vector of floats
Definition Vector2.h:61