sdl3/sdl_image
library
Properties
-
SDL_IMAGE_COMPILEDVERSION
→ int
-
const SDL_IMAGE_COMPILEDVERSION = \ SDL_VERSIONNUM(SDL_IMAGE_MAJOR_VERSION, SDL_IMAGE_MINOR_VERSION, SDL_IMAGE_PATCHLEVEL);
final
Functions
-
imgAddAnimationEncoderFrame(Pointer<ImgAnimationEncoder> encoder, Pointer<SdlSurface> surface, int duration)
→ bool
image
-
Add a frame to an animation encoder.
-
imgCloseAnimationDecoder(Pointer<ImgAnimationDecoder> decoder)
→ bool
image
-
Close an animation decoder, finishing any decoding.
-
imgCloseAnimationEncoder(Pointer<ImgAnimationEncoder> encoder)
→ bool
image
-
Close an animation encoder, finishing any encoding.
-
imgCreateAnimatedCursor(Pointer<ImgAnimation> anim, int hotX, int hotY)
→ Pointer<SdlCursor>
image
-
Create an animated cursor from an animation.
-
imgCreateAnimationDecoder(String? file)
→ Pointer<ImgAnimationDecoder>
image
-
Create a decoder to read a series of images from a file.
-
imgCreateAnimationDecoderIo(Pointer<SdlIoStream> src, bool closeio, String? type)
→ Pointer<ImgAnimationDecoder>
image
-
Create a decoder to read a series of images from an IOStream.
-
imgCreateAnimationDecoderWithProperties(int props)
→ Pointer<ImgAnimationDecoder>
image
-
Create an animation decoder with the specified properties.
-
imgCreateAnimationEncoder(String? file)
→ Pointer<ImgAnimationEncoder>
image
-
Create an encoder to save a series of images to a file.
-
imgCreateAnimationEncoderIo(Pointer<SdlIoStream> dst, bool closeio, String? type)
→ Pointer<ImgAnimationEncoder>
image
-
Create an encoder to save a series of images to an IOStream.
-
imgCreateAnimationEncoderWithProperties(int props)
→ Pointer<ImgAnimationEncoder>
image
-
Create an animation encoder with the specified properties.
-
imgFreeAnimation(Pointer<ImgAnimation> anim)
→ void
image
-
Dispose of an IMG_Animation and free its resources.
-
imgGetAnimationDecoderFrame(Pointer<ImgAnimationDecoder> decoder, Pointer<Pointer<SdlSurface>> frame, Pointer<Uint64> duration)
→ bool
image
-
Get the next frame in an animation decoder.
-
imgGetAnimationDecoderProperties(Pointer<ImgAnimationDecoder> decoder)
→ int
image
-
Get the properties of an animation decoder.
-
imgGetAnimationDecoderStatus(Pointer<ImgAnimationDecoder> decoder)
→ int
image
-
Get the decoder status indicating the current state of the decoder.
-
imgGetClipboardImage()
→ Pointer<SdlSurface>
image
-
Get the image currently in the clipboard.
-
imgGetError()
→ String?
-
const IMG_GetError = SDL_GetError;
-
imgIsAni(Pointer<SdlIoStream> src)
→ bool
image
-
Detect ANI animated cursor data on a readable/seekable SDL_IOStream.
-
imgIsAvif(Pointer<SdlIoStream> src)
→ bool
image
-
Detect AVIF image data on a readable/seekable SDL_IOStream.
-
imgIsBmp(Pointer<SdlIoStream> src)
→ bool
image
-
Detect BMP image data on a readable/seekable SDL_IOStream.
-
imgIsCur(Pointer<SdlIoStream> src)
→ bool
image
-
Detect CUR image data on a readable/seekable SDL_IOStream.
-
imgIsGif(Pointer<SdlIoStream> src)
→ bool
image
-
Detect GIF image data on a readable/seekable SDL_IOStream.
-
imgIsIco(Pointer<SdlIoStream> src)
→ bool
image
-
Detect ICO image data on a readable/seekable SDL_IOStream.
-
imgIsJpg(Pointer<SdlIoStream> src)
→ bool
image
-
Detect JPG image data on a readable/seekable SDL_IOStream.
-
imgIsJxl(Pointer<SdlIoStream> src)
→ bool
image
-
Detect JXL image data on a readable/seekable SDL_IOStream.
-
imgIsLbm(Pointer<SdlIoStream> src)
→ bool
image
-
Detect LBM image data on a readable/seekable SDL_IOStream.
-
imgIsPcx(Pointer<SdlIoStream> src)
→ bool
image
-
Detect PCX image data on a readable/seekable SDL_IOStream.
-
imgIsPng(Pointer<SdlIoStream> src)
→ bool
image
-
Detect PNG image data on a readable/seekable SDL_IOStream.
-
imgIsPnm(Pointer<SdlIoStream> src)
→ bool
image
-
Detect PNM image data on a readable/seekable SDL_IOStream.
-
imgIsQoi(Pointer<SdlIoStream> src)
→ bool
image
-
Detect QOI image data on a readable/seekable SDL_IOStream.
-
imgIsSvg(Pointer<SdlIoStream> src)
→ bool
image
-
Detect SVG image data on a readable/seekable SDL_IOStream.
-
imgIsTif(Pointer<SdlIoStream> src)
→ bool
image
-
Detect TIFF image data on a readable/seekable SDL_IOStream.
-
imgIsWebp(Pointer<SdlIoStream> src)
→ bool
image
-
Detect WEBP image data on a readable/seekable SDL_IOStream.
-
imgIsXcf(Pointer<SdlIoStream> src)
→ bool
image
-
Detect XCF image data on a readable/seekable SDL_IOStream.
-
imgIsXpm(Pointer<SdlIoStream> src)
→ bool
image
-
Detect XPM image data on a readable/seekable SDL_IOStream.
-
imgIsXv(Pointer<SdlIoStream> src)
→ bool
image
-
Detect XV image data on a readable/seekable SDL_IOStream.
-
imgLoad(String? file)
→ Pointer<SdlSurface>
image
-
Load an image from a filesystem path into a software surface.
-
imgLoadAniAnimationIo(Pointer<SdlIoStream> src)
→ Pointer<ImgAnimation>
image
-
Load an ANI animation directly from an SDL_IOStream.
-
imgLoadAnimation(String? file)
→ Pointer<ImgAnimation>
image
-
Load an animation from a file.
-
imgLoadAnimationIo(Pointer<SdlIoStream> src, bool closeio)
→ Pointer<ImgAnimation>
image
-
Load an animation from an SDL_IOStream.
-
imgLoadAnimationTypedIo(Pointer<SdlIoStream> src, bool closeio, String? type)
→ Pointer<ImgAnimation>
image
-
Load an animation from an SDL_IOStream.
-
imgLoadApngAnimationIo(Pointer<SdlIoStream> src)
→ Pointer<ImgAnimation>
image
-
Load an APNG animation directly from an SDL_IOStream.
-
imgLoadAvifAnimationIo(Pointer<SdlIoStream> src)
→ Pointer<ImgAnimation>
image
-
Load an AVIF animation directly from an SDL_IOStream.
-
imgLoadAvifIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a AVIF image directly.
-
imgLoadBmpIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a BMP image directly.
-
imgLoadCurIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a CUR image directly.
-
imgLoadGifAnimationIo(Pointer<SdlIoStream> src)
→ Pointer<ImgAnimation>
image
-
Load a GIF animation directly.
-
imgLoadGifIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a GIF image directly.
-
imgLoadIcoIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a ICO image directly.
-
imgLoadIo(Pointer<SdlIoStream> src, bool closeio)
→ Pointer<SdlSurface>
image
-
Load an image from an SDL data source into a software surface.
-
imgLoadJpgIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a JPG image directly.
-
imgLoadJxlIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a JXL image directly.
-
imgLoadLbmIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a LBM image directly.
-
imgLoadPcxIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a PCX image directly.
-
imgLoadPngIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a PNG image directly.
-
imgLoadPnmIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a PNM image directly.
-
imgLoadQoiIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a QOI image directly.
-
imgLoadSizedSvgIo(Pointer<SdlIoStream> src, int width, int height)
→ Pointer<SdlSurface>
image
-
Load an SVG image, scaled to a specific size.
-
imgLoadSvgIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a SVG image directly.
-
imgLoadTexture(Pointer<SdlRenderer> renderer, String? file)
→ Pointer<SdlTexture>
image
-
Load an image from a filesystem path into a GPU texture.
-
imgLoadTextureIo(Pointer<SdlRenderer> renderer, Pointer<SdlIoStream> src, bool closeio)
→ Pointer<SdlTexture>
image
-
Load an image from an SDL data source into a GPU texture.
-
imgLoadTextureTypedIo(Pointer<SdlRenderer> renderer, Pointer<SdlIoStream> src, bool closeio, String? type)
→ Pointer<SdlTexture>
image
-
Load an image from an SDL data source into a GPU texture.
-
imgLoadTgaIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a TGA image directly.
-
imgLoadTifIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a TIFF image directly.
-
imgLoadTypedIo(Pointer<SdlIoStream> src, bool closeio, String? type)
→ Pointer<SdlSurface>
image
-
Load an image from an SDL data source into a software surface.
-
imgLoadWebpAnimationIo(Pointer<SdlIoStream> src)
→ Pointer<ImgAnimation>
image
-
Load a WEBP animation directly.
-
imgLoadWebpIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a WEBP image directly.
-
imgLoadXcfIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a XCF image directly.
-
imgLoadXpmIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a XPM image directly.
-
imgLoadXvIo(Pointer<SdlIoStream> src)
→ Pointer<SdlSurface>
image
-
Load a XV image directly.
-
imgReadXpmFromArray(Pointer<Pointer<Int8>> xpm)
→ Pointer<SdlSurface>
image
-
Load an XPM image from a memory array.
-
imgReadXpmFromArrayToRgb888(Pointer<Pointer<Int8>> xpm)
→ Pointer<SdlSurface>
image
-
Load an XPM image from a memory array.
-
imgResetAnimationDecoder(Pointer<ImgAnimationDecoder> decoder)
→ bool
image
-
Reset an animation decoder.
-
imgSave(Pointer<SdlSurface> surface, String? file)
→ bool
image
-
Save an SDL_Surface into an image file.
-
imgSaveAniAnimationIo(Pointer<ImgAnimation> anim, Pointer<SdlIoStream> dst, bool closeio)
→ bool
image
-
Save an animation in ANI format to an SDL_IOStream.
-
imgSaveAnimation(Pointer<ImgAnimation> anim, String? file)
→ bool
image
-
Save an animation to a file.
-
imgSaveAnimationTypedIo(Pointer<ImgAnimation> anim, Pointer<SdlIoStream> dst, bool closeio, String? type)
→ bool
image
-
Save an animation to an SDL_IOStream.
-
imgSaveApngAnimationIo(Pointer<ImgAnimation> anim, Pointer<SdlIoStream> dst, bool closeio)
→ bool
image
-
Save an animation in APNG format to an SDL_IOStream.
-
imgSaveAvif(Pointer<SdlSurface> surface, String? file, int quality)
→ bool
image
-
Save an SDL_Surface into a AVIF image file.
-
imgSaveAvifAnimationIo(Pointer<ImgAnimation> anim, Pointer<SdlIoStream> dst, bool closeio, int quality)
→ bool
image
-
Save an animation in AVIF format to an SDL_IOStream.
-
imgSaveAvifIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio, int quality)
→ bool
image
-
Save an SDL_Surface into AVIF image data, via an SDL_IOStream.
-
imgSaveBmp(Pointer<SdlSurface> surface, String? file)
→ bool
image
-
Save an SDL_Surface into a BMP image file.
-
imgSaveBmpIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio)
→ bool
image
-
Save an SDL_Surface into BMP image data, via an SDL_IOStream.
-
imgSaveCur(Pointer<SdlSurface> surface, String? file)
→ bool
image
-
Save an SDL_Surface into a CUR image file.
-
imgSaveCurIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio)
→ bool
image
-
Save an SDL_Surface into CUR image data, via an SDL_IOStream.
-
imgSaveGif(Pointer<SdlSurface> surface, String? file)
→ bool
image
-
Save an SDL_Surface into a GIF image file.
-
imgSaveGifAnimationIo(Pointer<ImgAnimation> anim, Pointer<SdlIoStream> dst, bool closeio)
→ bool
image
-
Save an animation in GIF format to an SDL_IOStream.
-
imgSaveGifIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio)
→ bool
image
-
Save an SDL_Surface into GIF image data, via an SDL_IOStream.
-
imgSaveIco(Pointer<SdlSurface> surface, String? file)
→ bool
image
-
Save an SDL_Surface into a ICO image file.
-
imgSaveIcoIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio)
→ bool
image
-
Save an SDL_Surface into ICO image data, via an SDL_IOStream.
-
imgSaveJpg(Pointer<SdlSurface> surface, String? file, int quality)
→ bool
image
-
Save an SDL_Surface into a JPEG image file.
-
imgSaveJpgIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio, int quality)
→ bool
image
-
Save an SDL_Surface into JPEG image data, via an SDL_IOStream.
-
imgSavePng(Pointer<SdlSurface> surface, String? file)
→ bool
image
-
Save an SDL_Surface into a PNG image file.
-
imgSavePngIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio)
→ bool
image
-
Save an SDL_Surface into PNG image data, via an SDL_IOStream.
-
imgSaveTga(Pointer<SdlSurface> surface, String? file)
→ bool
image
-
Save an SDL_Surface into a TGA image file.
-
imgSaveTgaIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio)
→ bool
image
-
Save an SDL_Surface into TGA image data, via an SDL_IOStream.
-
imgSaveTypedIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio, String? type)
→ bool
image
-
Save an SDL_Surface into formatted image data, via an SDL_IOStream.
-
imgSaveWebp(Pointer<SdlSurface> surface, String? file, double quality)
→ bool
image
-
Save an SDL_Surface into a WEBP image file.
-
imgSaveWebpAnimationIo(Pointer<ImgAnimation> anim, Pointer<SdlIoStream> dst, bool closeio, int quality)
→ bool
image
-
Save an animation in WEBP format to an SDL_IOStream.
-
imgSaveWebpIo(Pointer<SdlSurface> surface, Pointer<SdlIoStream> dst, bool closeio, double quality)
→ bool
image
-
Save an SDL_Surface into WEBP image data, via an SDL_IOStream.
-
imgSetError(String fmt)
→ bool
-
const IMG_SetError = SDL_SetError;
-
imgVersion()
→ int
image
-
This function gets the version of the dynamically linked SDL_image library.
-
sdlImageVersionAtleast(int x, int y, int z)
→ bool
-
const SDL_IMAGE_VERSION_ATLEAST = (X, Y, Z) \ (SDL_IMAGE_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z));
