Repository navigation
Expand file tree
/
Copy pathSDL_ttf.h
More file actions
2472 lines (2335 loc) · 87.2 KB
/
Copy pathSDL_ttf.h
File metadata and controls
2472 lines (2335 loc) · 87.2 KB
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
SDL_ttf: A companion library to SDL for working with TrueType (tm) fonts
Copyright (C) 2001-2025 Sam Lantinga <slouken@libsdl.org>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
/* WIKI CATEGORY: SDLTTF */
/**
* # CategorySDLTTF
*
* Header file for SDL_ttf library
*
* This library is a wrapper around the excellent FreeType 2.0 library,
* available at: https://www.freetype.org/
*/
#ifndef SDL_TTF_H_
#define SDL_TTF_H_
#include <SDL3/SDL.h>
#include <SDL3/SDL_begin_code.h>
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/**
* Printable format: "%d.%d.%d", MAJOR, MINOR, MICRO
*/
#define SDL_TTF_MAJOR_VERSION 3
#define SDL_TTF_MINOR_VERSION 0
#define SDL_TTF_MICRO_VERSION 0
/**
* This is the version number macro for the current SDL_ttf version.
*/
#define SDL_TTF_VERSION \
SDL_VERSIONNUM(SDL_TTF_MAJOR_VERSION, SDL_TTF_MINOR_VERSION, SDL_TTF_MICRO_VERSION)
/**
* This macro will evaluate to true if compiled with SDL_ttf at least X.Y.Z.
*/
#define SDL_TTF_VERSION_ATLEAST(X, Y, Z) \
((SDL_TTF_MAJOR_VERSION >= X) && \
(SDL_TTF_MAJOR_VERSION > X || SDL_TTF_MINOR_VERSION >= Y) && \
(SDL_TTF_MAJOR_VERSION > X || SDL_TTF_MINOR_VERSION > Y || SDL_TTF_MICRO_VERSION >= Z))
/**
* This function gets the version of the dynamically linked SDL_ttf library.
*
* \returns SDL_ttf version.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC int SDLCALL TTF_Version(void);
/**
* Query the version of the FreeType library in use.
*
* TTF_Init() should be called before calling this function.
*
* \param major to be filled in with the major version number. Can be NULL.
* \param minor to be filled in with the minor version number. Can be NULL.
* \param patch to be filled in with the param version number. Can be NULL.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_Init
*/
extern SDL_DECLSPEC void SDLCALL TTF_GetFreeTypeVersion(int *major, int *minor, int *patch);
/**
* Query the version of the HarfBuzz library in use.
*
* If HarfBuzz is not available, the version reported is 0.0.0.
*
* \param major to be filled in with the major version number. Can be NULL.
* \param minor to be filled in with the minor version number. Can be NULL.
* \param patch to be filled in with the param version number. Can be NULL.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC void SDLCALL TTF_GetHarfBuzzVersion(int *major, int *minor, int *patch);
/**
* The internal structure containing font information.
*
* Opaque data!
*/
typedef struct TTF_Font TTF_Font;
/**
* Initialize SDL_ttf.
*
* You must successfully call this function before it is safe to call any
* other function in this library.
*
* It is safe to call this more than once, and each successful TTF_Init() call
* should be paired with a matching TTF_Quit() call.
*
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_Quit
*/
extern SDL_DECLSPEC bool SDLCALL TTF_Init(void);
/**
* Create a font from a file, using a specified point size.
*
* Some .fon fonts will have several sizes embedded in the file, so the point
* size becomes the index of choosing which size. If the value is too high,
* the last indexed size will be the default.
*
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
*
* \param file path to font file.
* \param ptsize point size to use for the newly-opened font.
* \returns a valid TTF_Font, or NULL on failure; call SDL_GetError() for more
* information.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_CloseFont
*/
extern SDL_DECLSPEC TTF_Font * SDLCALL TTF_OpenFont(const char *file, float ptsize);
/**
* Create a font from an SDL_IOStream, using a specified point size.
*
* Some .fon fonts will have several sizes embedded in the file, so the point
* size becomes the index of choosing which size. If the value is too high,
* the last indexed size will be the default.
*
* If `closeio` is true, `src` will be automatically closed once the font is
* closed. Otherwise you should close `src` yourself after closing the font.
*
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
*
* \param src an SDL_IOStream to provide a font file's data.
* \param closeio true to close `src` when the font is closed, false to leave
* it open.
* \param ptsize point size to use for the newly-opened font.
* \returns a valid TTF_Font, or NULL on failure; call SDL_GetError() for more
* information.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_CloseFont
*/
extern SDL_DECLSPEC TTF_Font * SDLCALL TTF_OpenFontIO(SDL_IOStream *src, bool closeio, float ptsize);
/**
* Create a font with the specified properties.
*
* These are the supported properties:
*
* - `TTF_PROP_FONT_CREATE_FILENAME_STRING`: the font file to open, if an
* SDL_IOStream isn't being used. This is required if
* `TTF_PROP_FONT_CREATE_IOSTREAM_POINTER` isn't set.
* - `TTF_PROP_FONT_CREATE_IOSTREAM_POINTER`: an SDL_IOStream containing the
* font to be opened. This should not be closed until the font is closed.
* This is required if `TTF_PROP_FONT_CREATE_FILENAME_STRING` isn't set.
* - `TTF_PROP_FONT_CREATE_IOSTREAM_OFFSET_NUMBER`: the offset in the iostream
* for the beginning of the font, defaults to 0.
* - `TTF_PROP_FONT_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN`: true if closing the
* font should also close the associated SDL_IOStream.
* - `TTF_PROP_FONT_CREATE_SIZE_FLOAT`: the point size of the font. Some .fon
* fonts will have several sizes embedded in the file, so the point size
* becomes the index of choosing which size. If the value is too high, the
* last indexed size will be the default.
* - `TTF_PROP_FONT_CREATE_FACE_NUMBER`: the face index of the font, if the
* font contains multiple font faces.
* - `TTF_PROP_FONT_CREATE_HORIZONTAL_DPI_NUMBER`: the horizontal DPI to use
* for font rendering, defaults to
* `TTF_PROP_FONT_CREATE_VERTICAL_DPI_NUMBER` if set, or 72 otherwise.
* - `TTF_PROP_FONT_CREATE_VERTICAL_DPI_NUMBER`: the vertical DPI to use for
* font rendering, defaults to `TTF_PROP_FONT_CREATE_HORIZONTAL_DPI_NUMBER`
* if set, or 72 otherwise.
*
* \param props the properties to use.
* \returns a valid TTF_Font, or NULL on failure; call SDL_GetError() for more
* information.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_CloseFont
*/
extern SDL_DECLSPEC TTF_Font * SDLCALL TTF_OpenFontWithProperties(SDL_PropertiesID props);
#define TTF_PROP_FONT_CREATE_FILENAME_STRING "SDL_ttf.font.create.filename"
#define TTF_PROP_FONT_CREATE_IOSTREAM_POINTER "SDL_ttf.font.create.iostream"
#define TTF_PROP_FONT_CREATE_IOSTREAM_OFFSET_NUMBER "SDL_ttf.font.create.iostream.offset"
#define TTF_PROP_FONT_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN "SDL_ttf.font.create.iostream.autoclose"
#define TTF_PROP_FONT_CREATE_SIZE_FLOAT "SDL_ttf.font.create.size"
#define TTF_PROP_FONT_CREATE_FACE_NUMBER "SDL_ttf.font.create.face"
#define TTF_PROP_FONT_CREATE_HORIZONTAL_DPI_NUMBER "SDL_ttf.font.create.hdpi"
#define TTF_PROP_FONT_CREATE_VERTICAL_DPI_NUMBER "SDL_ttf.font.create.vdpi"
/**
* Get the properties associated with a font.
*
* The following read-write properties are provided by SDL:
*
* - `TTF_PROP_FONT_OUTLINE_LINE_CAP_NUMBER`: The FT_Stroker_LineCap value
* used when setting the font outline, defaults to
* `FT_STROKER_LINECAP_ROUND`.
* - `TTF_PROP_FONT_OUTLINE_LINE_JOIN_NUMBER`: The FT_Stroker_LineJoin value
* used when setting the font outline, defaults to
* `FT_STROKER_LINEJOIN_ROUND`.
* - `TTF_PROP_FONT_OUTLINE_MITER_LIMIT_NUMBER`: The FT_Fixed miter limit used
* when setting the font outline, defaults to 0.
*
* \param font the font to query.
* \returns a valid property ID on success or 0 on failure; call
* SDL_GetError() for more information.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL TTF_GetFontProperties(TTF_Font *font);
#define TTF_PROP_FONT_OUTLINE_LINE_CAP_NUMBER "SDL_ttf.font.outline.line_cap"
#define TTF_PROP_FONT_OUTLINE_LINE_JOIN_NUMBER "SDL_ttf.font.outline.line_join"
#define TTF_PROP_FONT_OUTLINE_MITER_LIMIT_NUMBER "SDL_ttf.font.outline.miter_limit"
/**
* Get the font generation.
*
* The generation is incremented each time font properties change that require
* rebuilding glyphs, such as style, size, etc.
*
* \param font the font to query.
* \returns the font generation or 0 on failure; call SDL_GetError() for more
* information.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC Uint32 SDLCALL TTF_GetFontGeneration(TTF_Font *font);
/**
* Set a font's size dynamically.
*
* This updates any TTF_Text objects using this font, and clears
* already-generated glyphs, if any, from the cache.
*
* \param font the font to resize.
* \param ptsize the new point size.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_GetFontSize
*/
extern SDL_DECLSPEC bool SDLCALL TTF_SetFontSize(TTF_Font *font, float ptsize);
/**
* Set font size dynamically with target resolutions, in dots per inch.
*
* This updates any TTF_Text objects using this font, and clears
* already-generated glyphs, if any, from the cache.
*
* \param font the font to resize.
* \param ptsize the new point size.
* \param hdpi the target horizontal DPI.
* \param vdpi the target vertical DPI.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_GetFontSize
* \sa TTF_GetFontSizeDPI
*/
extern SDL_DECLSPEC bool SDLCALL TTF_SetFontSizeDPI(TTF_Font *font, float ptsize, int hdpi, int vdpi);
/**
* Get the size of a font.
*
* \param font the font to query.
* \returns the size of the font, or 0.0f on failure; call SDL_GetError() for
* more information.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontSize
* \sa TTF_SetFontSizeDPI
*/
extern SDL_DECLSPEC float SDLCALL TTF_GetFontSize(TTF_Font *font);
/**
* Get font target resolutions, in dots per inch.
*
* \param font the font to query.
* \param hdpi a pointer filled in with the target horizontal DPI.
* \param vdpi a pointer filled in with the target vertical DPI.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontSizeDPI
*/
extern SDL_DECLSPEC bool SDLCALL TTF_GetFontDPI(TTF_Font *font, int *hdpi, int *vdpi);
/**
* Font style flags for TTF_Font
*
* These are the flags which can be used to set the style of a font in
* SDL_ttf. A combination of these flags can be used with functions that set
* or query font style, such as TTF_SetFontStyle or TTF_GetFontStyle.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontStyle
* \sa TTF_GetFontStyle
*/
typedef Uint32 TTF_FontStyleFlags;
#define TTF_STYLE_NORMAL 0x00 /**< No special style */
#define TTF_STYLE_BOLD 0x01 /**< Bold style */
#define TTF_STYLE_ITALIC 0x02 /**< Italic style */
#define TTF_STYLE_UNDERLINE 0x04 /**< Underlined text */
#define TTF_STYLE_STRIKETHROUGH 0x08 /**< Strikethrough text */
/**
* Set a font's current style.
*
* This updates any TTF_Text objects using this font, and clears
* already-generated glyphs, if any, from the cache.
*
* The font styles are a set of bit flags, OR'd together:
*
* - `TTF_STYLE_NORMAL` (is zero)
* - `TTF_STYLE_BOLD`
* - `TTF_STYLE_ITALIC`
* - `TTF_STYLE_UNDERLINE`
* - `TTF_STYLE_STRIKETHROUGH`
*
* \param font the font to set a new style on.
* \param style the new style values to set, OR'd together.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_GetFontStyle
*/
extern SDL_DECLSPEC void SDLCALL TTF_SetFontStyle(TTF_Font *font, TTF_FontStyleFlags style);
/**
* Query a font's current style.
*
* The font styles are a set of bit flags, OR'd together:
*
* - `TTF_STYLE_NORMAL` (is zero)
* - `TTF_STYLE_BOLD`
* - `TTF_STYLE_ITALIC`
* - `TTF_STYLE_UNDERLINE`
* - `TTF_STYLE_STRIKETHROUGH`
*
* \param font the font to query.
* \returns the current font style, as a set of bit flags.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontStyle
*/
extern SDL_DECLSPEC TTF_FontStyleFlags SDLCALL TTF_GetFontStyle(const TTF_Font *font);
/**
* Set a font's current outline.
*
* This uses the font properties `TTF_PROP_FONT_OUTLINE_LINE_CAP_NUMBER`,
* `TTF_PROP_FONT_OUTLINE_LINE_JOIN_NUMBER`, and
* `TTF_PROP_FONT_OUTLINE_MITER_LIMIT_NUMBER` when setting the font outline.
*
* This updates any TTF_Text objects using this font, and clears
* already-generated glyphs, if any, from the cache.
*
* \param font the font to set a new outline on.
* \param outline positive outline value, 0 to default.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_GetFontOutline
*/
extern SDL_DECLSPEC bool SDLCALL TTF_SetFontOutline(TTF_Font *font, int outline);
/**
* Query a font's current outline.
*
* \param font the font to query.
* \returns the font's current outline value.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontOutline
*/
extern SDL_DECLSPEC int SDLCALL TTF_GetFontOutline(const TTF_Font *font);
/**
* Hinting flags for TTF (TrueType Fonts)
*
* This enum specifies the level of hinting to be applied to the font
* rendering. The hinting level determines how much the font's outlines are
* adjusted for better alignment on the pixel grid.
*
* \since This enum is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontHinting
* \sa TTF_GetFontHinting
*/
typedef enum TTF_HintingFlags
{
TTF_HINTING_NORMAL = 0, /**< Normal hinting applies standard grid-fitting. */
TTF_HINTING_LIGHT, /**< Light hinting applies subtle adjustments to improve rendering. */
TTF_HINTING_MONO, /**< Monochrome hinting adjusts the font for better rendering at lower resolutions. */
TTF_HINTING_NONE, /**< No hinting, the font is rendered without any grid-fitting. */
TTF_HINTING_LIGHT_SUBPIXEL /**< Light hinting with subpixel rendering for more precise font edges. */
} TTF_HintingFlags;
/**
* Set a font's current hinter setting.
*
* This updates any TTF_Text objects using this font, and clears
* already-generated glyphs, if any, from the cache.
*
* The hinter setting is a single value:
*
* - `TTF_HINTING_NORMAL`
* - `TTF_HINTING_LIGHT`
* - `TTF_HINTING_MONO`
* - `TTF_HINTING_NONE`
* - `TTF_HINTING_LIGHT_SUBPIXEL` (available in SDL_ttf 3.0.0 and later)
*
* \param font the font to set a new hinter setting on.
* \param hinting the new hinter setting.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_GetFontHinting
*/
extern SDL_DECLSPEC void SDLCALL TTF_SetFontHinting(TTF_Font *font, TTF_HintingFlags hinting);
/**
* Query a font's current FreeType hinter setting.
*
* The hinter setting is a single value:
*
* - `TTF_HINTING_NORMAL`
* - `TTF_HINTING_LIGHT`
* - `TTF_HINTING_MONO`
* - `TTF_HINTING_NONE`
* - `TTF_HINTING_LIGHT_SUBPIXEL` (available in SDL_ttf 3.0.0 and later)
*
* \param font the font to query.
* \returns the font's current hinter value.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontHinting
*/
extern SDL_DECLSPEC TTF_HintingFlags SDLCALL TTF_GetFontHinting(const TTF_Font *font);
/**
* Enable Signed Distance Field rendering for a font.
*
* This works with the Blended APIs. SDF is a technique that
* helps fonts look sharp even when scaling and rotating.
*
* This updates any TTF_Text objects using this font, and clears already-generated glyphs, if any, from the cache.
*
* \param font the font to set SDF support on.
* \param enabled true to enable SDF, false to disable.
* \returns true on success or false on failure; call SDL_GetError()
* for more information.
*
* \threadsafety This function should be called on the thread that created the font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_GetFontSDF
*/
extern SDL_DECLSPEC bool TTF_SetFontSDF(TTF_Font *font, bool enabled);
/**
* Query whether Signed Distance Field rendering is enabled for a font.
*
* \param font the font to query
*
* \returns true if enabled, false otherwise.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontSDF
*/
extern SDL_DECLSPEC bool TTF_GetFontSDF(const TTF_Font *font);
/**
* The horizontal alignment used when rendering wrapped text.
*
* \since This enum is available since SDL_ttf 3.0.0.
*/
typedef enum TTF_HorizontalAlignment
{
TTF_HORIZONTAL_ALIGN_INVALID = -1,
TTF_HORIZONTAL_ALIGN_LEFT,
TTF_HORIZONTAL_ALIGN_CENTER,
TTF_HORIZONTAL_ALIGN_RIGHT
} TTF_HorizontalAlignment;
/**
* Set a font's current wrap alignment option.
*
* This updates any TTF_Text objects using this font.
*
* \param font the font to set a new wrap alignment option on.
* \param align the new wrap alignment option.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_GetFontWrapAlignment
*/
extern SDL_DECLSPEC void SDLCALL TTF_SetFontWrapAlignment(TTF_Font *font, TTF_HorizontalAlignment align);
/**
* Query a font's current wrap alignment option.
*
* \param font the font to query.
* \returns the font's current wrap alignment option.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontWrapAlignment
*/
extern SDL_DECLSPEC TTF_HorizontalAlignment SDLCALL TTF_GetFontWrapAlignment(const TTF_Font *font);
/**
* Query the total height of a font.
*
* This is usually equal to point size.
*
* \param font the font to query.
* \returns the font's height.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC int SDLCALL TTF_GetFontHeight(const TTF_Font *font);
/**
* Query the offset from the baseline to the top of a font.
*
* This is a positive value, relative to the baseline.
*
* \param font the font to query.
* \returns the font's ascent.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC int SDLCALL TTF_GetFontAscent(const TTF_Font *font);
/**
* Query the offset from the baseline to the bottom of a font.
*
* This is a negative value, relative to the baseline.
*
* \param font the font to query.
* \returns the font's descent.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC int SDLCALL TTF_GetFontDescent(const TTF_Font *font);
/**
* Set the spacing between lines of text for a font.
*
* This updates any TTF_Text objects using this font.
*
* \param font the font to modify.
* \param lineskip the new line spacing for the font.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_GetFontLineSkip
*/
extern SDL_DECLSPEC void SDLCALL TTF_SetFontLineSkip(TTF_Font *font, int lineskip);
/**
* Query the spacing between lines of text for a font.
*
* \param font the font to query.
* \returns the font's recommended spacing.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontLineSkip
*/
extern SDL_DECLSPEC int SDLCALL TTF_GetFontLineSkip(const TTF_Font *font);
/**
* Set if kerning is enabled for a font.
*
* Newly-opened fonts default to allowing kerning. This is generally a good
* policy unless you have a strong reason to disable it, as it tends to
* produce better rendering (with kerning disabled, some fonts might render
* the word `kerning` as something that looks like `keming` for example).
*
* This updates any TTF_Text objects using this font.
*
* \param font the font to set kerning on.
* \param enabled true to enable kerning, false to disable.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_GetFontKerning
*/
extern SDL_DECLSPEC void SDLCALL TTF_SetFontKerning(TTF_Font *font, bool enabled);
/**
* Query whether or not kerning is enabled for a font.
*
* \param font the font to query.
* \returns true if kerning is enabled, false otherwise.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontKerning
*/
extern SDL_DECLSPEC bool SDLCALL TTF_GetFontKerning(const TTF_Font *font);
/**
* Query whether a font is fixed-width.
*
* A "fixed-width" font means all glyphs are the same width across; a
* lowercase 'i' will be the same size across as a capital 'W', for example.
* This is common for terminals and text editors, and other apps that treat
* text as a grid. Most other things (WYSIWYG word processors, web pages, etc)
* are more likely to not be fixed-width in most cases.
*
* \param font the font to query.
* \returns true if the font is fixed-width, false otherwise.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC bool SDLCALL TTF_FontIsFixedWidth(const TTF_Font *font);
/**
* Query whether a font is scalable or not.
*
* Scalability lets us distinguish between outline and bitmap fonts.
*
* \param font the font to query
*
* \returns true if the font is scalable, false otherwise.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontSDF
*/
extern SDL_DECLSPEC bool TTF_FontIsScalable(const TTF_Font *font);
/**
* Query a font's family name.
*
* This string is dictated by the contents of the font file.
*
* Note that the returned string is to internal storage, and should not be
* modified or free'd by the caller. The string becomes invalid, with the rest
* of the font, when `font` is handed to TTF_CloseFont().
*
* \param font the font to query.
* \returns the font's family name.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC const char * SDLCALL TTF_GetFontFamilyName(const TTF_Font *font);
/**
* Query a font's style name.
*
* This string is dictated by the contents of the font file.
*
* Note that the returned string is to internal storage, and should not be
* modified or free'd by the caller. The string becomes invalid, with the rest
* of the font, when `font` is handed to TTF_CloseFont().
*
* \param font the font to query.
* \returns the font's style name.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC const char * SDLCALL TTF_GetFontStyleName(const TTF_Font *font);
/**
* Direction flags
*
* \since This enum is available since SDL_ttf 3.0.0.
*
* \sa TTF_SetFontDirection
*/
typedef enum TTF_Direction
{
TTF_DIRECTION_LTR = 0, /* Left to Right */
TTF_DIRECTION_RTL, /* Right to Left */
TTF_DIRECTION_TTB, /* Top to Bottom */
TTF_DIRECTION_BTT /* Bottom to Top */
} TTF_Direction;
/**
* Render UTF-8 text at fast quality to a new 8-bit surface.
*
* This function will allocate a new 8-bit, palettized surface. The surface's
* 0 pixel will be the colorkey, giving a transparent background. The 1 pixel
* will be set to the text color.
*
* This will not word-wrap the string; you'll get a surface with a single line
* of text, as long as the string requires. You can use
* TTF_RenderText_Solid_Wrapped() instead if you need to wrap the output to
* multiple lines.
*
* This will not wrap on newline characters.
*
* You can render at other quality levels with TTF_RenderText_Shaded,
* TTF_RenderText_Blended, and TTF_RenderText_LCD.
*
* \param font the font to render with.
* \param text text to render, in UTF-8 encoding.
* \param length the length of the text, in bytes, or 0 for null terminated
* text.
* \param fg the foreground color for the text.
* \returns a new 8-bit, palettized surface, or NULL if there was an error.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_RenderText_Blended
* \sa TTF_RenderText_LCD
* \sa TTF_RenderText_Shaded
* \sa TTF_RenderText_Solid
* \sa TTF_RenderText_Solid_Wrapped
*/
extern SDL_DECLSPEC SDL_Surface * SDLCALL TTF_RenderText_Solid(TTF_Font *font, const char *text, size_t length, SDL_Color fg);
/**
* Render word-wrapped UTF-8 text at fast quality to a new 8-bit surface.
*
* This function will allocate a new 8-bit, palettized surface. The surface's
* 0 pixel will be the colorkey, giving a transparent background. The 1 pixel
* will be set to the text color.
*
* Text is wrapped to multiple lines on line endings and on word boundaries if
* it extends beyond `wrapLength` in pixels.
*
* If wrapLength is 0, this function will only wrap on newline characters.
*
* You can render at other quality levels with TTF_RenderText_Shaded_Wrapped,
* TTF_RenderText_Blended_Wrapped, and TTF_RenderText_LCD_Wrapped.
*
* \param font the font to render with.
* \param text text to render, in UTF-8 encoding.
* \param length the length of the text, in bytes, or 0 for null terminated
* text.
* \param fg the foreground color for the text.
* \param wrapLength the maximum width of the text surface or 0 to wrap on
* newline characters.
* \returns a new 8-bit, palettized surface, or NULL if there was an error.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_RenderText_Blended_Wrapped
* \sa TTF_RenderText_LCD_Wrapped
* \sa TTF_RenderText_Shaded_Wrapped
* \sa TTF_RenderText_Solid
*/
extern SDL_DECLSPEC SDL_Surface * SDLCALL TTF_RenderText_Solid_Wrapped(TTF_Font *font, const char *text, size_t length, SDL_Color fg, int wrapLength);
/**
* Render a single 32-bit glyph at fast quality to a new 8-bit surface.
*
* This function will allocate a new 8-bit, palettized surface. The surface's
* 0 pixel will be the colorkey, giving a transparent background. The 1 pixel
* will be set to the text color.
*
* The glyph is rendered without any padding or centering in the X direction,
* and aligned normally in the Y direction.
*
* You can render at other quality levels with TTF_RenderGlyph_Shaded,
* TTF_RenderGlyph_Blended, and TTF_RenderGlyph_LCD.
*
* \param font the font to render with.
* \param ch the character to render.
* \param fg the foreground color for the text.
* \returns a new 8-bit, palettized surface, or NULL if there was an error.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*
* \sa TTF_RenderGlyph_Blended
* \sa TTF_RenderGlyph_LCD
* \sa TTF_RenderGlyph_Shaded
*/
extern SDL_DECLSPEC SDL_Surface * SDLCALL TTF_RenderGlyph_Solid(TTF_Font *font, Uint32 ch, SDL_Color fg);
/**
* Set direction to be used for text shaping by a font.
*
* Possible direction values are:
*
* - `TTF_DIRECTION_LTR` (Left to Right)
* - `TTF_DIRECTION_RTL` (Right to Left)
* - `TTF_DIRECTION_TTB` (Top to Bottom)
* - `TTF_DIRECTION_BTT` (Bottom to Top)
*
* If SDL_ttf was not built with HarfBuzz support, this function returns
* false.
*
* This updates any TTF_Text objects using this font.
*
* \param font the font to specify a direction for.
* \param direction the new direction for text to flow.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC bool SDLCALL TTF_SetFontDirection(TTF_Font *font, TTF_Direction direction);
/**
* Get direction to be used for text shaping by a font.
*
* Possible direction values are:
*
* - `TTF_DIRECTION_LTR` (Left to Right)
* - `TTF_DIRECTION_RTL` (Right to Left)
* - `TTF_DIRECTION_TTB` (Top to Bottom)
* - `TTF_DIRECTION_BTT` (Bottom to Top)
*
* If SDL_ttf was not built with HarfBuzz support, this function returns
* TTF_DIRECTION_LTR.
*
* \param font the font to query.
* \returns the direction to be used for text shaping.
*
* \threadsafety This function should be called on the thread that created the
*
8
font.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC TTF_Direction SDLCALL TTF_GetFontDirection(TTF_Font *font);
/**
* Set script to be used for text shaping by a font.
*
* The supplied script value must be a null-terminated string of exactly four
* characters.
*
* If SDL_ttf was not built with HarfBuzz support, this function returns
* false.
*
* This updates any TTF_Text objects using this font.
*
* \param font the font to specify a script name for.
* \param script null-terminated string of exactly 4 characters.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \threadsafety This function is not thread-safe.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC bool SDLCALL TTF_SetFontScript(TTF_Font *font, const char *script);
/**
* Get the script used by a 32-bit codepoint.
*
* The supplied script value will be a null-terminated string of exactly four
* characters.
*
* If SDL_ttf was not built with HarfBuzz support, this function returns
* false.
*
* \param ch the character code to check.
* \param script a pointer filled in with the script used by `ch`.
* \param script_size the size of the script buffer, which must be at least 5
* characters.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \threadsafety This function should be called on the thread that created the
* font.
*
* \since This function is available since SDL_ttf 3.0.0.
*/
extern SDL_DECLSPEC bool SDLCALL TTF_GetGlyphScript(Uint32 ch, char *script, size_t script_size);