162 lines
6.7 KiB
C
162 lines
6.7 KiB
C
/*
|
|
SDL_image: An example image loading library for use with SDL
|
|
Copyright (C) 1997-2019 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.
|
|
*/
|
|
|
|
/* A simple library to load images of various formats as SDL surfaces */
|
|
|
|
#ifndef SDL_IMAGE_H_
|
|
#define SDL_IMAGE_H_
|
|
|
|
#include "SDL.h"
|
|
#include "SDL_version.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_IMAGE_MAJOR_VERSION 2
|
|
#define SDL_IMAGE_MINOR_VERSION 0
|
|
#define SDL_IMAGE_PATCHLEVEL 5
|
|
|
|
/* This macro can be used to fill a version structure with the compile-time
|
|
* version of the SDL_image library.
|
|
*/
|
|
#define SDL_IMAGE_VERSION(X) \
|
|
{ \
|
|
(X)->major = SDL_IMAGE_MAJOR_VERSION; \
|
|
(X)->minor = SDL_IMAGE_MINOR_VERSION; \
|
|
(X)->patch = SDL_IMAGE_PATCHLEVEL; \
|
|
}
|
|
|
|
/**
|
|
* This is the version number macro for the current SDL_image version.
|
|
*/
|
|
#define SDL_IMAGE_COMPILEDVERSION \
|
|
SDL_VERSIONNUM(SDL_IMAGE_MAJOR_VERSION, SDL_IMAGE_MINOR_VERSION, SDL_IMAGE_PATCHLEVEL)
|
|
|
|
/**
|
|
* 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_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z))
|
|
|
|
/* This function gets the version of the dynamically linked SDL_image library.
|
|
it should NOT be used to fill a version structure, instead you should
|
|
use the SDL_IMAGE_VERSION() macro.
|
|
*/
|
|
extern DECLSPEC const SDL_version * SDLCALL IMG_Linked_Version(void);
|
|
|
|
typedef enum
|
|
{
|
|
IMG_INIT_JPG = 0x00000001,
|
|
IMG_INIT_PNG = 0x00000002,
|
|
IMG_INIT_TIF = 0x00000004,
|
|
IMG_INIT_WEBP = 0x00000008
|
|
} IMG_InitFlags;
|
|
|
|
/* Loads dynamic libraries and prepares them for use. Flags should be
|
|
one or more flags from IMG_InitFlags OR'd together.
|
|
It returns the flags successfully initialized, or 0 on failure.
|
|
*/
|
|
extern DECLSPEC int SDLCALL IMG_Init(int flags);
|
|
|
|
/* Unloads libraries loaded with IMG_Init */
|
|
extern DECLSPEC void SDLCALL IMG_Quit(void);
|
|
|
|
/* Load an image from an SDL data source.
|
|
The 'type' may be one of: "BMP", "GIF", "PNG", etc.
|
|
|
|
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_SetColorKey(image, SDL_RLEACCEL, image->format->colorkey);
|
|
*/
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadTyped_RW(SDL_RWops *src, int freesrc, const char *type);
|
|
/* Convenience functions */
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_Load(const char *file);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_Load_RW(SDL_RWops *src, int freesrc);
|
|
|
|
#if SDL_VERSION_ATLEAST(2,0,0)
|
|
/* Load an image directly into a render texture.
|
|
*/
|
|
extern DECLSPEC SDL_Texture * SDLCALL IMG_LoadTexture(SDL_Renderer *renderer, const char *file);
|
|
extern DECLSPEC SDL_Texture * SDLCALL IMG_LoadTexture_RW(SDL_Renderer *renderer, SDL_RWops *src, int freesrc);
|
|
extern DECLSPEC SDL_Texture * SDLCALL IMG_LoadTextureTyped_RW(SDL_Renderer *renderer, SDL_RWops *src, int freesrc, const char *type);
|
|
#endif /* SDL 2.0 */
|
|
|
|
/* Functions to detect a file type, given a seekable source */
|
|
extern DECLSPEC int SDLCALL IMG_isICO(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isCUR(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isBMP(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isGIF(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isJPG(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isLBM(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isPCX(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isPNG(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isPNM(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isSVG(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isTIF(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isXCF(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isXPM(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isXV(SDL_RWops *src);
|
|
extern DECLSPEC int SDLCALL IMG_isWEBP(SDL_RWops *src);
|
|
|
|
/* Individual loading functions */
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadICO_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadCUR_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadBMP_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadGIF_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadJPG_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadLBM_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadPCX_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadPNG_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadPNM_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadSVG_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadTGA_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadTIF_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadXCF_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadXPM_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadXV_RW(SDL_RWops *src);
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_LoadWEBP_RW(SDL_RWops *src);
|
|
|
|
extern DECLSPEC SDL_Surface * SDLCALL IMG_ReadXPMFromArray(char **xpm);
|
|
|
|
/* Individual saving functions */
|
|
extern DECLSPEC int SDLCALL IMG_SavePNG(SDL_Surface *surface, const char *file);
|
|
extern DECLSPEC int SDLCALL IMG_SavePNG_RW(SDL_Surface *surface, SDL_RWops *dst, int freedst);
|
|
extern DECLSPEC int SDLCALL IMG_SaveJPG(SDL_Surface *surface, const char *file, int quality);
|
|
extern DECLSPEC int SDLCALL IMG_SaveJPG_RW(SDL_Surface *surface, SDL_RWops *dst, int freedst, int quality);
|
|
|
|
/* We'll use SDL for reporting errors */
|
|
#define IMG_SetError SDL_SetError
|
|
#define IMG_GetError SDL_GetError
|
|
|
|
/* Ends C function definitions when using C++ */
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#include "close_code.h"
|
|
|
|
#endif /* SDL_IMAGE_H_ */
|