Repository navigation
Expand file tree
/
Copy pathSDL_ttf.h
More file actions
2312 lines (2198 loc) · 84.9 KB
/
Copy pathSDL_ttf.h
File metadata and controls
2312 lines (2198 loc) · 84.9 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-2022 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.
*/
/**
* \file SDL_ttf.h
*
* Header file for SDL_ttf library
*
* This library is a wrapper around the excellent FreeType 2.0 library,
* available at: https://www.freetype.org/
*
* Note: In many places, SDL_ttf will say "glyph" when it means "code point."
* Unicode is hard, we learn as we go, and we apologize for adding to the
* confusion.
*
*/
#ifndef SDL_TTF_H_
#define SDL_TTF_H_
#include "SDL.h"
#include "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, PATCHLEVEL
*/
#define SDL_TTF_MAJOR_VERSION 2
#define SDL_TTF_MINOR_VERSION 19
#define SDL_TTF_PATCHLEVEL 3
/**
* This macro can be used to fill a version structure with the compile-time
* version of the SDL_ttf library.
*/
#define SDL_TTF_VERSION(X) \
{ \
(X)->major = SDL_TTF_MAJOR_VERSION; \
(X)->minor = SDL_TTF_MINOR_VERSION; \
(X)->patch = SDL_TTF_PATCHLEVEL; \
}
/**
* Backwards compatibility
*/
#define TTF_MAJOR_VERSION SDL_TTF_MAJOR_VERSION
#define TTF_MINOR_VERSION SDL_TTF_MINOR_VERSION
#define TTF_PATCHLEVEL SDL_TTF_PATCHLEVEL
#define TTF_VERSION(X) SDL_TTF_VERSION(X)
#if SDL_TTF_MAJOR_VERSION < 3 && SDL_MAJOR_VERSION < 3
/**
* This is the version number macro for the current SDL_ttf version.
*
* In versions higher than 2.9.0, the minor version overflows into
* the thousands digit: for example, 2.23.0 is encoded as 4300.
* This macro will not be available in SDL 3.x or SDL_ttf 3.x.
*
* \deprecated, use SDL_TTF_VERSION_ATLEAST or SDL_TTF_VERSION instead.
*/
#define SDL_TTF_COMPILEDVERSION \
SDL_VERSIONNUM(SDL_TTF_MAJOR_VERSION, SDL_TTF_MINOR_VERSION, SDL_TTF_PATCHLEVEL)
#endif /* SDL_TTF_MAJOR_VERSION < 3 && SDL_MAJOR_VERSION < 3 */
/**
* 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_PATCHLEVEL >= Z))
/* Make sure this is defined (only available in newer SDL versions) */
#ifndef SDL_DEPRECATED
#define SDL_DEPRECATED
#endif
/**
* Query the version of SDL_ttf that the program is linked against.
*
* This function gets the version of the dynamically linked SDL_ttf library.
* This is separate from the SDL_TTF_VERSION() macro, which tells you what
* version of the SDL_ttf headers you compiled against.
*
* This returns static internal data; do not free or modify it!
*
* \returns a pointer to the version information.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC const SDL_version * SDLCALL TTF_Linked_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.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_Init
*/
extern 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.
*
* \since This function is available since SDL_ttf 2.0.18.
*/
extern DECLSPEC void SDLCALL TTF_GetHarfBuzzVersion(int *major, int *minor, int *patch);
/**
* ZERO WIDTH NO-BREAKSPACE (Unicode byte order mark)
*/
#define UNICODE_BOM_NATIVE 0xFEFF
#define UNICODE_BOM_SWAPPED 0xFFFE
/**
* Tell SDL_ttf whether UNICODE text is generally byteswapped.
*
* A UNICODE BOM character in a string will override this setting for the
* remainder of that string.
*
* \param swapped boolean to indicate whether text is byteswapped
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC void SDLCALL TTF_ByteSwappedUNICODE(SDL_bool swapped);
/**
* 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, with one exception: a human-readable error
* message can be retrieved from TTF_GetError() if this function fails.
*
* SDL must be initialized before calls to functions in this library, because
* this library uses utility functions from the SDL library.
*
* It is safe to call this more than once; the library keeps a counter of init
* calls, and decrements it on each call to TTF_Quit, so you must pair your
* init and quit calls.
*
* \returns 0 on success, -1 on error.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_Quit
*/
extern DECLSPEC int 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 error.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_CloseFont
*/
extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFont(const char *file, int ptsize);
/**
* Create a font from a file, using a specified face index.
*
* 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.
*
* Some fonts have multiple "faces" included. The index specifies which face
* to use from the font file. Font files with only one face should specify
* zero for the index.
*
* 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.
* \param index index of the face in the font file.
* \returns a valid TTF_Font, or NULL on error.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_CloseFont
*/
extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontIndex(const char *file, int ptsize, long index);
/**
* Create a font from an SDL_RWops, 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 `freesrc` is non-zero, the RWops will be closed before returning,
* whether this function succeeds or not. SDL_ttf reads everything it needs
* from the RWops during this call in any case.
*
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
*
* \param src an SDL_RWops to provide a font file's data.
* \param freesrc non-zero to close the RWops before returning, zero to leave
* it open.
* \param ptsize point size to use for the newly-opened font.
* \returns a valid TTF_Font, or NULL on error.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_CloseFont
*/
extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontRW(SDL_RWops *src, int freesrc, int ptsize);
/**
* Create a font from an SDL_RWops, using a specified face index.
*
* 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 `freesrc` is non-zero, the RWops will be closed before returning,
* whether this function succeeds or not. SDL_ttf reads everything it needs
* from the RWops during this call in any case.
*
* Some fonts have multiple "faces" included. The index specifies which face
* to use from the font file. Font files with only one face should specify
* zero for the index.
*
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
*
* \param src an SDL_RWops to provide a font file's data.
* \param freesrc non-zero to close the RWops before returning, zero to leave
* it open.
* \param ptsize point size to use for the newly-opened font.
* \param index index of the face in the font file.
* \returns a valid TTF_Font, or NULL on error.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_CloseFont
*/
extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontIndexRW(SDL_RWops *src, int freesrc, int ptsize, long index);
/**
* Create a font from a file, using target resolutions (in DPI).
*
* DPI scaling only applies to scalable fonts (e.g. TrueType).
*
* 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.
* \param hdpi the target horizontal DPI.
* \param vdpi the target vertical DPI.
* \returns a valid TTF_Font, or NULL on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_CloseFont
*/
extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontDPI(const char *file, int ptsize, unsigned int hdpi, unsigned int vdpi);
/**
* Create a font from a file, using target resolutions (in DPI).
*
* DPI scaling only applies to scalable fonts (e.g. TrueType).
*
* 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.
*
* Some fonts have multiple "faces" included. The index specifies which face
* to use from the font file. Font files with only one face should specify
* zero for the index.
*
* 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.
* \param index index of the face in the font file.
* \param hdpi the target horizontal DPI.
* \param vdpi the target vertical DPI.
* \returns a valid TTF_Font, or NULL on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_CloseFont
*/
extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontIndexDPI(const char *file, int ptsize, long index, unsigned int hdpi, unsigned int vdpi);
/**
* Opens a font from an SDL_RWops with target resolutions (in DPI).
*
* DPI scaling only applies to scalable fonts (e.g. TrueType).
*
* 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 `freesrc` is non-zero, the RWops will be closed before returning,
* whether this function succeeds or not. SDL_ttf reads everything it needs
* from the RWops during this call in any case.
*
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
*
* \param src an SDL_RWops to provide a font file's data.
* \param freesrc non-zero to close the RWops before returning, zero to leave
* it open.
* \param ptsize point size to use for the newly-opened font.
* \param hdpi the target horizontal DPI.
* \param vdpi the target vertical DPI.
* \returns a valid TTF_Font, or NULL on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_CloseFont
*/
extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontDPIRW(SDL_RWops *src, int freesrc, int ptsize, unsigned int hdpi, unsigned int vdpi);
/**
* Opens a font from an SDL_RWops with target resolutions (in DPI).
*
* DPI scaling only applies to scalable fonts (e.g. TrueType).
*
* 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 `freesrc` is non-zero, the RWops will be closed before returning,
* whether this function succeeds or not. SDL_ttf reads everything it needs
* from the RWops during this call in any case.
*
* Some fonts have multiple "faces" included. The index specifies which face
* to use from the font file. Font files with only one face should specify
* zero for the index.
*
* When done with the returned TTF_Font, use TTF_CloseFont() to dispose of it.
*
* \param src an SDL_RWops to provide a font file's data.
* \param freesrc non-zero to close the RWops before returning, zero to leave
* it open.
* \param ptsize point size to use for the newly-opened font.
* \param index index of the face in the font file.
* \param hdpi the target horizontal DPI.
* \param vdpi the target vertical DPI.
* \returns a valid TTF_Font, or NULL on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_CloseFont
*/
extern DECLSPEC TTF_Font * SDLCALL TTF_OpenFontIndexDPIRW(SDL_RWops *src, int freesrc, int ptsize, long index, unsigned int hdpi, unsigned int vdpi);
/**
* Set a font's size dynamically.
*
* This clears already-generated glyphs, if any, from the cache.
*
* \param font the font to resize.
* \param ptsize the new point size.
* \returns 0 if successful, -1 on error
*
* \since This function is available since SDL_ttf 2.0.18.
*/
extern DECLSPEC int SDLCALL TTF_SetFontSize(TTF_Font *font, int ptsize);
/**
* Set font size dynamically with target resolutions (in DPI).
*
* This 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 0 if successful, -1 on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*/
extern DECLSPEC int SDLCALL TTF_SetFontSizeDPI(TTF_Font *font, int ptsize, unsigned int hdpi, unsigned int vdpi);
/**
* Font style flags
*/
#define TTF_STYLE_NORMAL 0x00
#define TTF_STYLE_BOLD 0x01
#define TTF_STYLE_ITALIC 0x02
#define TTF_STYLE_UNDERLINE 0x04
#define TTF_STYLE_STRIKETHROUGH 0x08
/**
* 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.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_SetFontStyle
*/
extern DECLSPEC int SDLCALL TTF_GetFontStyle(const TTF_Font *font);
/**
* Set a font's current style.
*
* Setting the style 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.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_GetFontStyle
*/
extern DECLSPEC void SDLCALL TTF_SetFontStyle(TTF_Font *font, int style);
/**
* Query a font's current outline.
*
* \param font the font to query.
* \returns the font's current outline value.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_SetFontOutline
*/
extern DECLSPEC int SDLCALL TTF_GetFontOutline(const TTF_Font *font);
/**
* Set a font's current outline.
*
* \param font the font to set a new outline on.
* \param outline positive outline value, 0 to default.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_GetFontOutline
*/
extern DECLSPEC void SDLCALL TTF_SetFontOutline(TTF_Font *font, int outline);
/**
* Hinting flags
*/
#define TTF_HINTING_NORMAL 0
#define TTF_HINTING_LIGHT 1
#define TTF_HINTING_MONO 2
#define TTF_HINTING_NONE 3
#define TTF_HINTING_LIGHT_SUBPIXEL 4
/**
* 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 2.0.18 and later)
*
* \param font the font to query.
* \returns the font's current hinter value.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_SetFontHinting
*/
extern DECLSPEC int SDLCALL TTF_GetFontHinting(const TTF_Font *font);
/**
* Set a font's current hinter setting.
*
* Setting it 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` (avai
10BC8
lable in SDL_ttf 2.0.18 and later)
*
* \param font the font to set a new hinter setting on.
* \param hinting the new hinter setting.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_GetFontHinting
*/
extern DECLSPEC void SDLCALL TTF_SetFontHinting(TTF_Font *font, int hinting);
/**
* Special layout option for rendering wrapped text
*/
#define TTF_WRAPPED_ALIGN_LEFT 0
#define TTF_WRAPPED_ALIGN_CENTER 1
#define TTF_WRAPPED_ALIGN_RIGHT 2
/**
* Query a font's current wrap alignment option.
*
* The wrap alignment option can be one of the following:
*
* - `TTF_WRAPPED_ALIGN_LEFT`
* - `TTF_WRAPPED_ALIGN_CENTER`
* - `TTF_WRAPPED_ALIGN_RIGHT`
*
* \param font the font to query.
* \returns the font's current wrap alignment option.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_SetFontWrappedAlign
*/
extern DECLSPEC int SDLCALL TTF_GetFontWrappedAlign(const TTF_Font *font);
/**
* Set a font's current wrap alignment option.
*
* The wrap alignment option can be one of the following:
*
* - `TTF_WRAPPED_ALIGN_LEFT`
* - `TTF_WRAPPED_ALIGN_CENTER`
* - `TTF_WRAPPED_ALIGN_RIGHT`
*
* \param font the font to set a new wrap alignment option on.
* \param align the new wrap alignment option.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_GetFontWrappedAlign
*/
extern DECLSPEC void SDLCALL TTF_SetFontWrappedAlign(TTF_Font *font, int align);
/**
* 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.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC int SDLCALL TTF_FontHeight(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.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC int SDLCALL TTF_FontAscent(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.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC int SDLCALL TTF_FontDescent(const TTF_Font *font);
/**
* Query the recommended spacing between lines of text for a font.
*
* \param font the font to query.
* \returns the font's recommended spacing.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC int SDLCALL TTF_FontLineSkip(const TTF_Font *font);
/**
* Query whether or not kerning is allowed for a font.
*
* \param font the font to query.
* \returns non-zero if kerning is enabled, zero otherwise.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC int SDLCALL TTF_GetFontKerning(const TTF_Font *font);
/**
* Set if kerning is allowed 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).
*
* \param font the font to set kerning on.
* \param allowed non-zero to allow kerning, zero to disallow.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC void SDLCALL TTF_SetFontKerning(TTF_Font *font, int allowed);
/**
* Query the number of faces of a font.
*
* \param font the font to query.
* \returns the number of FreeType font faces.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC long SDLCALL TTF_FontFaces(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 non-zero if fixed-width, zero if not.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC int SDLCALL TTF_FontFaceIsFixedWidth(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
* modifed 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.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC const char * SDLCALL TTF_FontFaceFamilyName(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
* modifed 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.
*
* \since This function is available since SDL_ttf 2.0.0.
*/
extern DECLSPEC const char * SDLCALL TTF_FontFaceStyleName(const TTF_Font *font);
/**
* Check whether a glyph is provided by the font for a 16-bit codepoint.
*
* Note that this version of the function takes a 16-bit character code, which
* covers the Basic Multilingual Plane, but is insufficient to cover the
* entire set of possible Unicode values, including emoji glyphs. You should
* use TTF_GlyphIsProvided32() instead, which offers the same functionality
* but takes a 32-bit codepoint instead.
*
* The only reason to use this function is that it was available since the
* beginning of time, more or less.
*
* \param font the font to query.
* \param ch the character code to check.
* \returns non-zero if font provides a glyph for this character, zero if not.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_GlyphIsProvided32
*/
extern DECLSPEC int SDLCALL TTF_GlyphIsProvided(TTF_Font *font, Uint16 ch);
/**
* Check whether a glyph is provided by the font for a 32-bit codepoint.
*
* This is the same as TTF_GlyphIsProvided(), but takes a 32-bit character
* instead of 16-bit, and thus can query a larger range. If you are sure
* you'll have an SDL_ttf that's version 2.0.18 or newer, there's no reason
* not to use this function exclusively.
*
* \param font the font to query.
* \param ch the character code to check.
* \returns non-zero if font provides a glyph for this character, zero if not.
*
* \since This function is available since SDL_ttf 2.0.18.
*/
extern DECLSPEC int SDLCALL TTF_GlyphIsProvided32(TTF_Font *font, Uint32 ch);
/**
* Query the metrics (dimensions) of a font's 16-bit glyph.
*
* To understand what these metrics mean, here is a useful link:
*
* https://freetype.sourceforge.net/freetype2/docs/tutorial/step2.html
*
* Note that this version of the function takes a 16-bit character code, which
* covers the Basic Multilingual Plane, but is insufficient to cover the
* entire set of possible Unicode values, including emoji glyphs. You should
* use TTF_GlyphMetrics32() instead, which offers the same functionality but
* takes a 32-bit codepoint instead.
*
* The only reason to use this function is that it was available since the
* beginning of time, more or less.
*
* \param font the font to query.
* \param ch the character code to check.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_GlyphMetrics32
*/
extern DECLSPEC int SDLCALL TTF_GlyphMetrics(TTF_Font *font, Uint16 ch,
int *minx, int *maxx,
int *miny, int *maxy, int *advance);
/**
* Query the metrics (dimensions) of a font's 32-bit glyph.
*
* To understand what these metrics mean, here is a useful link:
*
* https://freetype.sourceforge.net/freetype2/docs/tutorial/step2.html
*
* This is the same as TTF_GlyphMetrics(), but takes a 32-bit character
* instead of 16-bit, and thus can query a larger range. If you are sure
* you'll have an SDL_ttf that's version 2.0.18 or newer, there's no reason
* not to use this function exclusively.
*
* \param font the font to query.
* \param ch the character code to check.
*
* \since This function is available since SDL_ttf 2.0.18.
*/
extern DECLSPEC int SDLCALL TTF_GlyphMetrics32(TTF_Font *font, Uint32 ch,
int *minx, int *maxx,
int *miny, int *maxy, int *advance);
/**
* Calculate the dimensions of a rendered string of Latin1 text.
*
* This will report the width and height, in pixels, of the space that the
* specified string will take to fully render.
*
* This does not need to render the string to do this calculation.
*
* You almost certainly want TTF_SizeUTF8() unless you're sure you have a
* 1-byte Latin1 encoding. US ASCII characters will work with either function,
* but most other Unicode characters packed into a `const char *` will need
* UTF-8.
*
* \param font the font to query.
* \param text text to calculate, in Latin1 encoding.
* \param w will be filled with width, in pixels, on return.
* \param h will be filled with height, in pixels, on return.
* \returns 0 if successful, -1 on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_SizeUTF8
* \sa TTF_SizeUNICODE
*/
extern DECLSPEC int SDLCALL TTF_SizeText(TTF_Font *font, const char *text, int *w, int *h);
/**
* Calculate the dimensions of a rendered string of UTF-8 text.
*
* This will report the width and height, in pixels, of the space that the
* specified string will take to fully render.
*
* This does not need to render the string to do this calculation.
*
* \param font the font to query.
* \param text text to calculate, in Latin1 encoding.
* \param w will be filled with width, in pixels, on return.
* \param h will be filled with height, in pixels, on return.
* \returns 0 if successful, -1 on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_SizeUNICODE
*/
extern DECLSPEC int SDLCALL TTF_SizeUTF8(TTF_Font *font, const char *text, int *w, int *h);
/**
* Calculate the dimensions of a rendered string of UCS-2 text.
*
* This will report the width and height, in pixels, of the space that the
* specified string will take to fully render.
*
* This does not need to render the string to do this calculation.
*
* Please note that this function is named "Unicode" but currently expects
* UCS-2 encoding (16 bits per codepoint). This does not give you access to
* large Unicode values, such as emoji glyphs. These codepoints are accessible
* through the UTF-8 version of this function.
*
* \param font the font to query.
* \param text text to calculate, in UCS-2 encoding.
* \param w will be filled with width, in pixels, on return.
* \param h will be filled with height, in pixels, on return.
* \returns 0 if successful, -1 on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_SizeUTF8
*/
extern DECLSPEC int SDLCALL TTF_SizeUNICODE(TTF_Font *font, const Uint16 *text, int *w, int *h);
/**
* Calculate how much of a Latin1 string will fit in a given width.
*
* This reports the number of characters that can be rendered before reaching
* `measure_width`.
*
* This does not need to render the string to do this calculation.
*
* You almost certainly want TTF_MeasureUTF8() unless you're sure you have a
* 1-byte Latin1 encoding. US ASCII characters will work with either function,
* but most other Unicode characters packed into a `const char *` will need
* UTF-8.
*
* \param font the font to query.
* \param text text to calculate, in Latin1 encoding.
* \param measure_width maximum width, in pixels, available for the string.
* \param count on return, filled with number of characters that can be
* rendered.
* \param extent on return, filled with latest calculated width.
* \returns 0 if successful, -1 on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_MeasureText
* \sa TTF_MeasureUTF8
* \sa TTF_MeasureUNICODE
*/
extern DECLSPEC int SDLCALL TTF_MeasureText(TTF_Font *font, const char *text, int measure_width, int *extent, int *count);
/**
* Calculate how much of a UTF-8 string will fit in a given width.
*
* This reports the number of characters that can be rendered before reaching
* `measure_width`.
*
* This does not need to render the string to do this calculation.
*
* \param font the font to query.
* \param text text to calculate, in UTF-8 encoding.
* \param measure_width maximum width, in pixels, available for the string.
* \param count on return, filled with number of characters that can be
* rendered.
* \param extent on return, filled with latest calculated width.
* \returns 0 if successful, -1 on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_MeasureText
* \sa TTF_MeasureUTF8
* \sa TTF_MeasureUNICODE
*/
extern DECLSPEC int SDLCALL TTF_MeasureUTF8(TTF_Font *font, const char *text, int measure_width, int *extent, int *count);
/**
* Calculate how much of a UCS-2 string will fit in a given width.
*
* This reports the number of characters that can be rendered before reaching
* `measure_width`.
*
* This does not need to render the string to do this calculation.
*
* Please note that this function is named "Unicode" but currently expects
* UCS-2 encoding (16 bits per codepoint). This does not give you access to
* large Unicode values, such as emoji glyphs. These codepoints are accessible
* through the UTF-8 version of this function.
*
* \param font the font to query.
* \param text text to calculate, in UCS-2 encoding.
* \param measure_width maximum width, in pixels, available for the string.
* \param count on return, filled with number of characters that can be
* rendered.
* \param extent on return, filled with latest calculated width.
* \returns 0 if successful, -1 on error.
*
* \since This function is available since SDL_ttf 2.0.18.
*
* \sa TTF_MeasureText
* \sa TTF_MeasureUTF8
* \sa TTF_MeasureUNICODE
*/
extern DECLSPEC int SDLCALL TTF_MeasureUNICODE(TTF_Font *font, const Uint16 *text, int measure_width, int *extent, int *count);
/**
* Render Latin1 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 almost certainly want TTF_RenderUTF8_Solid() unless you're sure you
* have a 1-byte Latin1 encoding. US ASCII characters will work with either
* function, but most other Unicode characters packed into a `const char *`
* will need UTF-8.
*
* 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 Latin1 encoding.
* \param fg the foreground color for the text.
* \returns a new 8-bit, palettized surface, or NULL if there was an error.
*
* \since This function is available since SDL_ttf 2.0.0.
*
* \sa TTF_RenderUTF8_Solid
* \sa TTF_RenderUNICODE_Solid
*/
extern DECLSPEC SDL_Surface * SDLCALL TTF_RenderText_Solid(TTF_Font *font,
const char *text, SDL_Color fg);