aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Text.h
blob: fbb1ad6833ef1551124ff4dfcd101d6db3380a44 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
#pragma once

#include <string>

#include "../Component.h"

#include "Asset.h"
#include "Color.h"
#include "UIObject.h"

namespace crepe {
/**
 * \brief Text UIObject component for displaying text
 * 
 * This class can be used to display text on screen. By setting the font_family to a font already stored on the current device it will automatically be loaded in.
 */
class Text : public UIObject {
public:
	//! Text data that does not have to be set in the constructor
	struct Data {
		/**
		 *  \brief fontsize for text rendering
		 * 
		 * \note this is not the actual font size that is loaded in.
		 * 
		 * Since SDL_TTF requires the font size when loading in the font it is not possible to switch the font size.
		 * The default font size that is loaded is set in the Config.
		 * Instead this value is used to upscale the font texture which can cause blurring or distorted text when upscaling or downscaling too much.
		 */
		unsigned int font_size = 16;

		//! Layer sorting level of the text
		const int sorting_in_layer = 0;

		//! Order within the sorting text
		const int order_in_layer = 0;

		//! Label text color.
		Color text_color = Color::BLACK;
	};

public:
	/**
	 * 
	 * \param dimensions Width and height of the UIObject.
	 * \param offset Offset of the UIObject relative to its transform
	 * \param text The text to be displayed.
	 * \param font_family The font style name to be displayed.
	 * \param data Data struct containing extra text parameters.
	 */
	Text(game_object_id_t id, const vec2 & dimensions, const vec2 & offset,
		 const std::string & text, const std::string & font_family, const Data & data);
	//! Label text.
	std::string text = "";
	//! Font asset variable
	Asset font;
	//! Data instance
	Data data;
};

} // namespace crepe