summaryrefslogtreecommitdiff
path: root/modules/gdnative/include/text/godot_text.h
blob: 9de47edf870b6c02fc25c3a3d23b56b2effdc1d7 (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
/*************************************************************************/
/*  godot_text.h                                                         */
/*************************************************************************/
/*                       This file is part of:                           */
/*                           GODOT ENGINE                                */
/*                      https://godotengine.org                          */
/*************************************************************************/
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur.                 */
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md).   */
/*                                                                       */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the       */
/* "Software"), to deal in the Software without restriction, including   */
/* without limitation the rights to use, copy, modify, merge, publish,   */
/* distribute, sublicense, and/or sell copies of the Software, and to    */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions:                                             */
/*                                                                       */
/* The above copyright notice and this permission notice shall be        */
/* included in all copies or substantial portions of the Software.       */
/*                                                                       */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
/*************************************************************************/

#ifndef GODOT_NATIVETEXT_H
#define GODOT_NATIVETEXT_H

#include <gdnative/gdnative.h>

#ifdef __cplusplus
extern "C" {
#endif

#define GODOT_TEXT_API_MAJOR 1
#define GODOT_TEXT_API_MINOR 0

#define GODOT_GLYPH_SIZE 40

#ifndef GODOT_TEXT_API_GODOT_GLYPH_TYPE_DEFINED
#define GODOT_TEXT_API_GODOT_GLYPH_TYPE_DEFINED
typedef struct {
	uint8_t _dont_touch_that[GODOT_GLYPH_SIZE];
} godot_glyph;
#endif

#define GODOT_PACKED_GLYPH_ARRAY_SIZE (2 * sizeof(void *))

#ifndef GODOT_TEXT_API_GODOT_PACKED_GLYPH_ARRAY_TYPE_DEFINED
#define GODOT_TEXT_API_GODOT_PACKED_GLYPH_ARRAY_TYPE_DEFINED
typedef struct {
	uint8_t _dont_touch_that[GODOT_PACKED_GLYPH_ARRAY_SIZE];
} godot_packed_glyph_array;
#endif

typedef struct {
	godot_gdnative_api_version version;
	void *(*constructor)(godot_object *);
	void (*destructor)(void *);
	godot_string (*get_name)(const void *);
	godot_bool (*has_feature)(const void *, godot_int);
	bool (*load_support_data)(void *, const godot_string *);
	godot_string (*get_support_data_filename)(const void *);
	godot_string (*get_support_data_info)(const void *);
	bool (*save_support_data)(void *, const godot_string *);
	bool (*is_locale_right_to_left)(void *, const godot_string *);
	void (*free)(void *, godot_rid *);
	bool (*has)(void *, godot_rid *);
	godot_rid (*create_font_system)(void *, const godot_string *, int);
	godot_rid (*create_font_resource)(void *, const godot_string *, int);
	godot_rid (*create_font_memory)(void *, const uint8_t *, size_t, godot_string *, int);
	float (*font_get_height)(void *, godot_rid *, int);
	float (*font_get_ascent)(void *, godot_rid *, int);
	float (*font_get_descent)(void *, godot_rid *, int);
	float (*font_get_underline_position)(void *, godot_rid *, int);
	float (*font_get_underline_thickness)(void *, godot_rid *, int);
	void (*font_set_antialiased)(void *, godot_rid *, bool);
	bool (*font_get_antialiased)(void *, godot_rid *);
	godot_dictionary (*font_get_feature_list)(void *, godot_rid *);
	godot_dictionary (*font_get_variation_list)(void *, godot_rid *);
	void (*font_set_variation)(void *, godot_rid *, const godot_string *, double);
	double (*font_get_variation)(void *, godot_rid *, const godot_string *);
	void (*font_set_distance_field_hint)(void *, godot_rid *, bool);
	bool (*font_get_distance_field_hint)(void *, godot_rid *);
	void (*font_set_hinting)(void *, godot_rid *, godot_int);
	godot_int (*font_get_hinting)(void *, godot_rid *);
	void (*font_set_force_autohinter)(void *, godot_rid *, bool);
	bool (*font_get_force_autohinter)(void *, godot_rid *);
	bool (*font_has_char)(void *, godot_rid *, char32_t);
	godot_string (*font_get_supported_chars)(void *, godot_rid *);
	bool (*font_has_outline)(void *, godot_rid *);
	int (*font_get_base_size)(void *, godot_rid *);
	bool (*font_is_language_supported)(void *, godot_rid *, const godot_string *);
	void (*font_set_language_support_override)(void *, godot_rid *, const godot_string *, bool);
	bool (*font_get_language_support_override)(void *, godot_rid *, const godot_string *);
	void (*font_remove_language_support_override)(void *, godot_rid *, const godot_string *);
	godot_packed_string_array (*font_get_language_support_overrides)(void *, godot_rid *);
	bool (*font_is_script_supported)(void *, godot_rid *, const godot_string *);
	void (*font_set_script_support_override)(void *, godot_rid *, const godot_string *, bool);
	bool (*font_get_script_support_override)(void *, godot_rid *, const godot_string *);
	void (*font_remove_script_support_override)(void *, godot_rid *, const godot_string *);
	godot_packed_string_array (*font_get_script_support_overrides)(void *, godot_rid *);
	uint32_t (*font_get_glyph_index)(void *, godot_rid *, char32_t, char32_t);
	godot_vector2 (*font_get_glyph_advance)(void *, godot_rid *, uint32_t, int);
	godot_vector2 (*font_get_glyph_kerning)(void *, godot_rid *, uint32_t, uint32_t, int);
	godot_vector2 (*font_draw_glyph)(void *, godot_rid *, godot_rid *, int, const godot_vector2 *, uint32_t, const godot_color *);
	godot_vector2 (*font_draw_glyph_outline)(void *, godot_rid *, godot_rid *, int, int, const godot_vector2 *, uint32_t, const godot_color *);
	float (*font_get_oversampling)(void *);
	void (*font_set_oversampling)(void *, float);
	godot_packed_string_array (*get_system_fonts)(void *);
	godot_rid (*create_shaped_text)(void *, godot_int, godot_int);
	void (*shaped_text_clear)(void *, godot_rid *);
	void (*shaped_text_set_direction)(void *, godot_rid *, godot_int);
	godot_int (*shaped_text_get_direction)(void *, godot_rid *);
	void (*shaped_text_set_bidi_override)(void *, godot_rid *, const godot_packed_vector2i_array *);
	void (*shaped_text_set_orientation)(void *, godot_rid *, godot_int);
	godot_int (*shaped_text_get_orientation)(void *, godot_rid *);
	void (*shaped_text_set_preserve_invalid)(void *, godot_rid *, bool);
	bool (*shaped_text_get_preserve_invalid)(void *, godot_rid *);
	void (*shaped_text_set_preserve_control)(void *, godot_rid *, bool);
	bool (*shaped_text_get_preserve_control)(void *, godot_rid *);
	bool (*shaped_text_add_string)(void *, godot_rid *, const godot_string *, const godot_rid **, int, const godot_dictionary *, const godot_string *);
	bool (*shaped_text_add_object)(void *, godot_rid *, const godot_variant *, const godot_vector2 *, godot_int, godot_int);
	bool (*shaped_text_resize_object)(void *, godot_rid *, const godot_variant *, const godot_vector2 *, godot_int);
	godot_rid (*shaped_text_substr)(void *, godot_rid *, godot_int, godot_int);
	godot_rid (*shaped_text_get_parent)(void *, godot_rid *);
	float (*shaped_text_fit_to_width)(void *, godot_rid *, float, uint8_t);
	float (*shaped_text_tab_align)(void *, godot_rid *, godot_packed_float32_array *);
	bool (*shaped_text_shape)(void *, godot_rid *);
	bool (*shaped_text_update_breaks)(void *, godot_rid *);
	bool (*shaped_text_update_justification_ops)(void *, godot_rid *);
	bool (*shaped_text_is_ready)(void *, godot_rid *);
	godot_packed_glyph_array (*shaped_text_get_glyphs)(void *, godot_rid *);
	godot_vector2i (*shaped_text_get_range)(void *, godot_rid *);
	godot_packed_glyph_array (*shaped_text_sort_logical)(void *, godot_rid *);
	godot_packed_vector2i_array (*shaped_text_get_line_breaks_adv)(void *, godot_rid *, godot_packed_float32_array *, int, bool, uint8_t);
	godot_packed_vector2i_array (*shaped_text_get_line_breaks)(void *, godot_rid *, float, int, uint8_t);
	godot_packed_vector2i_array (*shaped_text_get_word_breaks)(void *, godot_rid *);
	godot_array (*shaped_text_get_objects)(void *, godot_rid *);
	godot_rect2 (*shaped_text_get_object_rect)(void *, godot_rid *, const godot_variant *);
	godot_vector2 (*shaped_text_get_size)(void *, godot_rid *);
	float (*shaped_text_get_ascent)(void *, godot_rid *);
	float (*shaped_text_get_descent)(void *, godot_rid *);
	float (*shaped_text_get_width)(void *, godot_rid *);
	float (*shaped_text_get_underline_position)(void *, godot_rid *);
	float (*shaped_text_get_underline_thickness)(void *, godot_rid *);
	godot_string (*format_number)(void *, const godot_string *, const godot_string *);
	godot_string (*parse_number)(void *, const godot_string *, const godot_string *);
	godot_string (*percent_sign)(void *, const godot_string *);
} godot_text_interface_gdnative;

void GDAPI godot_text_register_interface(const godot_text_interface_gdnative *p_interface, const godot_string *p_name, uint32_t p_features);

// Glyph

void GDAPI godot_glyph_new(godot_glyph *r_dest);

godot_vector2i GDAPI godot_glyph_get_range(const godot_glyph *p_self);
void GDAPI godot_glyph_set_range(godot_glyph *p_self, const godot_vector2i *p_range);

godot_int GDAPI godot_glyph_get_count(const godot_glyph *p_self);
void GDAPI godot_glyph_set_count(godot_glyph *p_self, godot_int p_count);

godot_int GDAPI godot_glyph_get_repeat(const godot_glyph *p_self);
void GDAPI godot_glyph_set_repeat(godot_glyph *p_self, godot_int p_repeat);

godot_int GDAPI godot_glyph_get_flags(const godot_glyph *p_self);
void GDAPI godot_glyph_set_flags(godot_glyph *p_self, godot_int p_flags);

godot_vector2 GDAPI godot_glyph_get_offset(const godot_glyph *p_self);
void GDAPI godot_glyph_set_offset(godot_glyph *p_self, const godot_vector2 *p_offset);

godot_real GDAPI godot_glyph_get_advance(const godot_glyph *p_self);
void GDAPI godot_glyph_set_advance(godot_glyph *p_self, godot_real p_advance);

godot_rid GDAPI godot_glyph_get_font(const godot_glyph *p_self);
void GDAPI godot_glyph_set_font(godot_glyph *p_self, godot_rid *p_font);

godot_int GDAPI godot_glyph_get_font_size(const godot_glyph *p_self);
void GDAPI godot_glyph_set_font_size(godot_glyph *p_self, godot_int p_size);

godot_int GDAPI godot_glyph_get_index(const godot_glyph *p_self);
void GDAPI godot_glyph_set_index(godot_glyph *p_self, godot_int p_index);

// GlyphArray

void GDAPI godot_packed_glyph_array_new(godot_packed_glyph_array *r_dest);
void GDAPI godot_packed_glyph_array_new_copy(godot_packed_glyph_array *r_dest, const godot_packed_glyph_array *p_src);

const godot_glyph GDAPI *godot_packed_glyph_array_ptr(const godot_packed_glyph_array *p_self);
godot_glyph GDAPI *godot_packed_glyph_array_ptrw(godot_packed_glyph_array *p_self);

void GDAPI godot_packed_glyph_array_append(godot_packed_glyph_array *p_self, const godot_glyph *p_data);

void GDAPI godot_packed_glyph_array_append_array(godot_packed_glyph_array *p_self, const godot_packed_glyph_array *p_array);

godot_error GDAPI godot_packed_glyph_array_insert(godot_packed_glyph_array *p_self, const godot_int p_idx, const godot_glyph *p_data);

godot_bool GDAPI godot_packed_glyph_array_has(godot_packed_glyph_array *p_self, const godot_glyph *p_value);

void GDAPI godot_packed_glyph_array_sort(godot_packed_glyph_array *p_self);

void GDAPI godot_packed_glyph_array_invert(godot_packed_glyph_array *p_self);

void GDAPI godot_packed_glyph_array_push_back(godot_packed_glyph_array *p_self, const godot_glyph *p_data);

void GDAPI godot_packed_glyph_array_remove(godot_packed_glyph_array *p_self, godot_int p_idx);

void GDAPI godot_packed_glyph_array_resize(godot_packed_glyph_array *p_self, godot_int p_size);

void GDAPI godot_packed_glyph_array_set(godot_packed_glyph_array *p_self, godot_int p_idx, const godot_glyph *p_data);
godot_glyph GDAPI godot_packed_glyph_array_get(const godot_packed_glyph_array *p_self, godot_int p_idx);

godot_int GDAPI godot_packed_glyph_array_size(const godot_packed_glyph_array *p_self);

godot_bool GDAPI godot_packed_glyph_array_is_empty(const godot_packed_glyph_array *p_self);

void GDAPI godot_packed_glyph_array_destroy(godot_packed_glyph_array *p_self);

// Grapheme

#ifdef __cplusplus
}
#endif

#endif /* !GODOT_NATIVETEXT_H */