-
Notifications
You must be signed in to change notification settings - Fork 208
/
Copy pathSDL_image.h
2110 lines (2037 loc) · 67.3 KB
/
SDL_image.h
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_image: An example image loading library for use with SDL
Copyright (C) 1997-2025 Sam Lantinga <[email protected]>
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: SDLImage */
/**
* # CategorySDLImage
*
* Header file for SDL_image library
*
* A simple library to load images of various formats as SDL surfaces
*/
#ifndef SDL_IMAGE_H_
#define SDL_IMAGE_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_IMAGE_MAJOR_VERSION 3
#define SDL_IMAGE_MINOR_VERSION 3
#define SDL_IMAGE_MICRO_VERSION 0
/**
* This is the version number macro for the current SDL_image version.
*/
#define SDL_IMAGE_VERSION \
SDL_VERSIONNUM(SDL_IMAGE_MAJOR_VERSION, SDL_IMAGE_MINOR_VERSION, SDL_IMAGE_MICRO_VERSION)
/**
* This macro will evaluate to true if compiled with SDL_image at least X.Y.Z.
*/
#define SDL_IMAGE_VERSION_ATLEAST(X, Y, Z) \
((SDL_IMAGE_MAJOR_VERSION >= X) && \
(SDL_IMAGE_MAJOR_VERSION > X || SDL_IMAGE_MINOR_VERSION >= Y) && \
(SDL_IMAGE_MAJOR_VERSION > X || SDL_IMAGE_MINOR_VERSION > Y || SDL_IMAGE_MICRO_VERSION >= Z))
/**
* This function gets the version of the dynamically linked SDL_image library.
*
* \returns SDL_image version.
*
* \since This function is available since SDL_image 3.0.0.
*/
extern SDL_DECLSPEC int SDLCALL IMG_Version(void);
/**
* Load an image from an SDL data source into a software surface.
*
* An SDL_Surface is a buffer of pixels in memory accessible by the CPU. Use
* this if you plan to hand the data to something else or manipulate it
* further in code.
*
* There are no guarantees about what format the new SDL_Surface data will be;
* in many cases, SDL_image will attempt to supply a surface that exactly
* matches the provided image, but in others it might have to convert (either
* because the image is in a format that SDL doesn't directly support or
* because it's compressed data that could reasonably uncompress to various
* formats and SDL_image had to pick one). You can inspect an SDL_Surface for
* its specifics, and use SDL_ConvertSurface to then migrate to any supported
* format.
*
* If the image format supports a transparent pixel, SDL will set the colorkey
* for the surface. You can enable RLE acceleration on the surface afterwards
* by calling: SDL_SetSurfaceColorKey(image, SDL_RLEACCEL,
* image->format->colorkey);
*
* If `closeio` is true, `src` will be closed before returning, whether this
* function succeeds or not. SDL_image reads everything it needs from `src`
* during this call in any case.
*
* Even though this function accepts a file type, SDL_image may still try
* other decoders that are capable of detecting file type from the contents of
* the image data, but may rely on the caller-provided type string for formats
* that it cannot autodetect. If `type` is NULL, SDL_image will rely solely on
* its ability to guess the format.
*
* There is a separate function to read files from disk without having to deal
* with SDL_IOStream: `IMG_Load("filename.jpg")` will call this function and
* manage those details for you, determining the file type from the filename's
* extension.
*
* There is also IMG_Load_IO(), which is equivalent to this function except
* that it will rely on SDL_image to determine what type of data it is
* loading, much like passing a NULL for type.
*
* If you are using SDL's 2D rendering API, there is an equivalent call to
* load images directly into an SDL_Texture for use by the GPU without using a
* software surface: call IMG_LoadTextureTyped_IO() instead.
*
* When done with the returned surface, the app should dispose of it with a
* call to SDL_DestroySurface().
*
* \param src an SDL_IOStream that data will be read from.
* \param closeio true to close/free the SDL_IOStream before returning, false
* to leave it open.
* \param type a filename extension that represent this data ("BMP", "GIF",
* "PNG", etc).
* \returns a new SDL surface, or NULL on error.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_Load
* \sa IMG_Load_IO
* \sa SDL_DestroySurface
*/
extern SDL_DECLSPEC SDL_Surface * SDLCALL IMG_LoadTyped_IO(SDL_IOStream *src, bool closeio, const char *type);
/**
* Load an image from a filesystem path into a software surface.
*
* An SDL_Surface is a buffer of pixels in memory accessible by the CPU. Use
* this if you plan to hand the data to something else or manipulate it
* further in code.
*
* There are no guarantees about what format the new SDL_Surface data will be;
* in many cases, SDL_image will attempt to supply a surface that exactly
* matches the provided image, but in others it might have to convert (either
* because the image is in a format that SDL doesn't directly support or
* because it's compressed data that could reasonably uncompress to various
* formats and SDL_image had to pick one). You can inspect an SDL_Surface for
* its specifics, and use SDL_ConvertSurface to then migrate to any supported
* format.
*
* If the image format supports a transparent pixel, SDL will set the colorkey
* for the surface. You can enable RLE acceleration on the surface afterwards
* by calling: SDL_SetSurfaceColorKey(image, SDL_RLEACCEL,
* image->format->colorkey);
*
* There is a separate function to read files from an SDL_IOStream, if you
* need an i/o abstraction to provide data from anywhere instead of a simple
* filesystem read; that function is IMG_Load_IO().
*
* If you are using SDL's 2D rendering API, there is an equivalent call to
* load images directly into an SDL_Texture for use by the GPU without using a
* software surface: call IMG_LoadTexture() instead.
*
* When done with the returned surface, the app should dispose of it with a
* call to
* [SDL_DestroySurface](https://wiki.libsdl.org/SDL3/SDL_DestroySurface)
* ().
*
* \param file a path on the filesystem to load an image from.
* \returns a new SDL surface, or NULL on error.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_LoadTyped_IO
* \sa IMG_Load_IO
* \sa SDL_DestroySurface
*/
extern SDL_DECLSPEC SDL_Surface * SDLCALL IMG_Load(const char *file);
/**
* Load an image from an SDL data source into a software surface.
*
* An SDL_Surface is a buffer of pixels in memory accessible by the CPU. Use
* this if you plan to hand the data to something else or manipulate it
* further in code.
*
* There are no guarantees about what format the new SDL_Surface data will be;
* in many cases, SDL_image will attempt to supply a surface that exactly
* matches the provided image, but in others it might have to convert (either
* because the image is in a format that SDL doesn't directly support or
* because it's compressed data that could reasonably uncompress to various
* formats and SDL_image had to pick one). You can inspect an SDL_Surface for
* its specifics, and use SDL_ConvertSurface to then migrate to any supported
* format.
*
* If the image format supports a transparent pixel, SDL will set the colorkey
* for the surface. You can enable RLE acceleration on the surface afterwards
* by calling: SDL_SetSurfaceColorKey(image, SDL_RLEACCEL,
* image->format->colorkey);
*
* If `closeio` is true, `src` will be closed before returning, whether this
* function succeeds or not. SDL_image reads everything it needs from `src`
* during this call in any case.
*
* There is a separate function to read files from disk without having to deal
* with SDL_IOStream: `IMG_Load("filename.jpg")` will call this function and
* manage those details for you, determining the file type from the filename's
* extension.
*
* There is also IMG_LoadTyped_IO(), which is equivalent to this function
* except a file extension (like "BMP", "JPG", etc) can be specified, in case
* SDL_image cannot autodetect the file format.
*
* If you are using SDL's 2D rendering API, there is an equivalent call to
* load images directly into an SDL_Texture for use by the GPU without using a
* software surface: call IMG_LoadTexture_IO() instead.
*
* When done with the returned surface, the app should dispose of it with a
* call to SDL_DestroySurface().
*
* \param src an SDL_IOStream that data will be read from.
* \param closeio true to close/free the SDL_IOStream before returning, false
* to leave it open.
* \returns a new SDL surface, or NULL on error.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_Load
* \sa IMG_LoadTyped_IO
* \sa SDL_DestroySurface
*/
extern SDL_DECLSPEC SDL_Surface * SDLCALL IMG_Load_IO(SDL_IOStream *src, bool closeio);
/**
* Load an image from a filesystem path into a GPU texture.
*
* An SDL_Texture represents an image in GPU memory, usable by SDL's 2D Render
* API. This can be significantly more efficient than using a CPU-bound
* SDL_Surface if you don't need to manipulate the image directly after
* loading it.
*
* If the loaded image has transparency or a colorkey, a texture with an alpha
* channel will be created. Otherwise, SDL_image will attempt to create an
* SDL_Texture in the most format that most reasonably represents the image
* data (but in many cases, this will just end up being 32-bit RGB or 32-bit
* RGBA).
*
* There is a separate function to read files from an SDL_IOStream, if you
* need an i/o abstraction to provide data from anywhere instead of a simple
* filesystem read; that function is IMG_LoadTexture_IO().
*
* If you would rather decode an image to an SDL_Surface (a buffer of pixels
* in CPU memory), call IMG_Load() instead.
*
* When done with the returned texture, the app should dispose of it with a
* call to SDL_DestroyTexture().
*
* \param renderer the SDL_Renderer to use to create the GPU texture.
* \param file a path on the filesystem to load an image from.
* \returns a new texture, or NULL on error.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_LoadTextureTyped_IO
* \sa IMG_LoadTexture_IO
*/
extern SDL_DECLSPEC SDL_Texture * SDLCALL IMG_LoadTexture(SDL_Renderer *renderer, const char *file);
/**
* Load an image from an SDL data source into a GPU texture.
*
* An SDL_Texture represents an image in GPU memory, usable by SDL's 2D Render
* API. This can be significantly more efficient than using a CPU-bound
* SDL_Surface if you don't need to manipulate the image directly after
* loading it.
*
* If the loaded image has transparency or a colorkey, a texture with an alpha
* channel will be created. Otherwise, SDL_image will attempt to create an
* SDL_Texture in the most format that most reasonably represents the image
* data (but in many cases, this will just end up being 32-bit RGB or 32-bit
* RGBA).
*
* If `closeio` is true, `src` will be closed before returning, whether this
* function succeeds or not. SDL_image reads everything it needs from `src`
* during this call in any case.
*
* There is a separate function to read files from disk without having to deal
* with SDL_IOStream: `IMG_LoadTexture(renderer, "filename.jpg")` will call
* this function and manage those details for you, determining the file type
* from the filename's extension.
*
* There is also IMG_LoadTextureTyped_IO(), which is equivalent to this
* function except a file extension (like "BMP", "JPG", etc) can be specified,
* in case SDL_image cannot autodetect the file format.
*
* If you would rather decode an image to an SDL_Surface (a buffer of pixels
* in CPU memory), call IMG_Load() instead.
*
* When done with the returned texture, the app should dispose of it with a
* call to SDL_DestroyTexture().
*
* \param renderer the SDL_Renderer to use to create the GPU texture.
* \param src an SDL_IOStream that data will be read from.
* \param closeio true to close/free the SDL_IOStream before returning, false
* to leave it open.
* \returns a new texture, or NULL on error.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_LoadTexture
* \sa IMG_LoadTextureTyped_IO
* \sa SDL_DestroyTexture
*/
extern SDL_DECLSPEC SDL_Texture * SDLCALL IMG_LoadTexture_IO(SDL_Renderer *renderer, SDL_IOStream *src, bool closeio);
/**
* Load an image from an SDL data source into a GPU texture.
*
* An SDL_Texture represents an image in GPU memory, usable by SDL's 2D Render
* API. This can be significantly more efficient than using a CPU-bound
* SDL_Surface if you don't need to manipulate the image directly after
* loading it.
*
* If the loaded image has transparency or a colorkey, a texture with an alpha
* channel will be created. Otherwise, SDL_image will attempt to create an
* SDL_Texture in the most format that most reasonably represents the image
* data (but in many cases, this will just end up being 32-bit RGB or 32-bit
* RGBA).
*
* If `closeio` is true, `src` will be closed before returning, whether this
* function succeeds or not. SDL_image reads everything it needs from `src`
* during this call in any case.
*
* Even though this function accepts a file type, SDL_image may still try
* other decoders that are capable of detecting file type from the contents of
* the image data, but may rely on the caller-provided type string for formats
* that it cannot autodetect. If `type` is NULL, SDL_image will rely solely on
* its ability to guess the format.
*
* There is a separate function to read files from disk without having to deal
* with SDL_IOStream: `IMG_LoadTexture("filename.jpg")` will call this
* function and manage those details for you, determining the file type from
* the filename's extension.
*
* There is also IMG_LoadTexture_IO(), which is equivalent to this function
* except that it will rely on SDL_image to determine what type of data it is
* loading, much like passing a NULL for type.
*
* If you would rather decode an image to an SDL_Surface (a buffer of pixels
* in CPU memory), call IMG_LoadTyped_IO() instead.
*
* When done with the returned texture, the app should dispose of it with a
* call to SDL_DestroyTexture().
*
* \param renderer the SDL_Renderer to use to create the GPU texture.
* \param src an SDL_IOStream that data will be read from.
* \param closeio true to close/free the SDL_IOStream before returning, false
* to leave it open.
* \param type a filename extension that represent this data ("BMP", "GIF",
* "PNG", etc).
* \returns a new texture, or NULL on error.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_LoadTexture
* \sa IMG_LoadTexture_IO
* \sa SDL_DestroyTexture
*/
extern SDL_DECLSPEC SDL_Texture * SDLCALL IMG_LoadTextureTyped_IO(SDL_Renderer *renderer, SDL_IOStream *src, bool closeio, const char *type);
/**
* Detect AVIF image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is AVIF data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isAVIF(SDL_IOStream *src);
/**
* Detect ICO image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is ICO data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isICO(SDL_IOStream *src);
/**
* Detect CUR image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is CUR data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isCUR(SDL_IOStream *src);
/**
* Detect BMP image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is BMP data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isBMP(SDL_IOStream *src);
/**
* Detect GIF image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is GIF data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isGIF(SDL_IOStream *src);
/**
* Detect JPG image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is JPG data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isJPG(SDL_IOStream *src);
/**
* Detect JXL image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is JXL data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isJXL(SDL_IOStream *src);
/**
* Detect LBM image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is LBM data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isLBM(SDL_IOStream *src);
/**
* Detect PCX image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is PCX data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isPCX(SDL_IOStream *src);
/**
* Detect PNG image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is PNG data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isPNG(SDL_IOStream *src);
/**
* Detect PNM image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is PNM data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isPNM(SDL_IOStream *src);
/**
* Detect SVG image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is SVG data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isQOI
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isSVG(SDL_IOStream *src);
/**
* Detect QOI image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is QOI data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isTIF
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isQOI(SDL_IOStream *src);
/**
* Detect TIFF image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is TIFF data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP
* \sa IMG_isGIF
* \sa IMG_isJPG
* \sa IMG_isJXL
* \sa IMG_isLBM
* \sa IMG_isPCX
* \sa IMG_isPNG
* \sa IMG_isPNM
* \sa IMG_isSVG
* \sa IMG_isQOI
* \sa IMG_isXCF
* \sa IMG_isXPM
* \sa IMG_isXV
* \sa IMG_isWEBP
*/
extern SDL_DECLSPEC bool SDLCALL IMG_isTIF(SDL_IOStream *src);
/**
* Detect XCF image data on a readable/seekable SDL_IOStream.
*
* This function attempts to determine if a file is a given filetype, reading
* the least amount possible from the SDL_IOStream (usually a few bytes).
*
* There is no distinction made between "not the filetype in question" and
* basic i/o errors.
*
* This function will always attempt to seek `src` back to where it started
* when this function was called, but it will not report any errors in doing
* so, but assuming seeking works, this means you can immediately use this
* with a different IMG_isTYPE function, or load the image without further
* seeking.
*
* You do not need to call this function to load data; SDL_image can work to
* determine file type in many cases in its standard load functions.
*
* \param src a seekable/readable SDL_IOStream to provide image data.
* \returns non-zero if this is XCF data, zero otherwise.
*
* \since This function is available since SDL_image 3.0.0.
*
* \sa IMG_isAVIF
* \sa IMG_isICO
* \sa IMG_isCUR
* \sa IMG_isBMP