SDL3_image

This page is under development.

SDL3_image.IMG_AddAnimationEncoderFrame(encoder: LP_IMG_AnimationEncoder, surface: LP_SDL_Surface, duration: c_uint64) → c_bool

Add a frame to an animation encoder.

SDL3_image.IMG_CloseAnimationDecoder(decoder: LP_IMG_AnimationDecoder) → c_bool

Close an animation decoder, finishing any decoding.

SDL3_image.IMG_CloseAnimationEncoder(encoder: LP_IMG_AnimationEncoder) → c_bool

Close an animation encoder, finishing any encoding.

SDL3_image.IMG_CreateAnimatedCursor(anim: LP_IMG_Animation, hot_x: c_int, hot_y: c_int) → LP_SDL_Cursor

Create an animated cursor from an animation.

SDL3_image.IMG_CreateAnimationDecoder(file: c_char_p) → LP_IMG_AnimationDecoder

Create a decoder to read a series of images from a file.

SDL3_image.IMG_CreateAnimationDecoderWithProperties(props: SDL_PropertiesID) → LP_IMG_AnimationDecoder

Create an animation decoder with the specified properties.

SDL3_image.IMG_CreateAnimationDecoder_IO(src: LP_SDL_IOStream, closeio: c_bool, type: c_char_p) → LP_IMG_AnimationDecoder

Create a decoder to read a series of images from an IOStream.

SDL3_image.IMG_CreateAnimationEncoder(file: c_char_p) → LP_IMG_AnimationEncoder

Create an encoder to save a series of images to a file.

SDL3_image.IMG_CreateAnimationEncoderWithProperties(props: SDL_PropertiesID) → LP_IMG_AnimationEncoder

Create an animation encoder with the specified properties.

SDL3_image.IMG_CreateAnimationEncoder_IO(dst: LP_SDL_IOStream, closeio: c_bool, type: c_char_p) → LP_IMG_AnimationEncoder

Create an encoder to save a series of images to an IOStream.

SDL3_image.IMG_FreeAnimation(anim: LP_IMG_Animation) → None

Dispose of an IMG_Animation and free its resources.

SDL3_image.IMG_GetAnimationDecoderFrame(decoder: LP_IMG_AnimationDecoder, frame: LP_LP_SDL_Surface, duration: LP_c_uint64) → c_bool

Get the next frame in an animation decoder.

SDL3_image.IMG_GetAnimationDecoderProperties(decoder: LP_IMG_AnimationDecoder) → SDL_PropertiesID

Get the properties of an animation decoder.

SDL3_image.IMG_GetAnimationDecoderStatus(decoder: LP_IMG_AnimationDecoder) → IMG_AnimationDecoderStatus

Get the decoder status indicating the current state of the decoder.

SDL3_image.IMG_GetClipboardImage() → LP_SDL_Surface

Get the image currently in the clipboard.

SDL3_image.IMG_Load(file: c_char_p) → LP_SDL_Surface

Load an image from a filesystem path into a software surface.

SDL3_image.IMG_LoadANIAnimation_IO(src: LP_SDL_IOStream) → LP_IMG_Animation

Load an ANI animation directly from an SDL_IOStream.

SDL3_image.IMG_LoadAPNGAnimation_IO(src: LP_SDL_IOStream) → LP_IMG_Animation

Load an APNG animation directly from an SDL_IOStream.

SDL3_image.IMG_LoadAVIFAnimation_IO(src: LP_SDL_IOStream) → LP_IMG_Animation

Load an AVIF animation directly from an SDL_IOStream.

SDL3_image.IMG_LoadAVIF_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a AVIF image directly.

SDL3_image.IMG_LoadAnimation(file: c_char_p) → LP_IMG_Animation

Load an animation from a file.

SDL3_image.IMG_LoadAnimationTyped_IO(src: LP_SDL_IOStream, closeio: c_bool, type: c_char_p) → LP_IMG_Animation

Load an animation from an SDL_IOStream.

SDL3_image.IMG_LoadAnimation_IO(src: LP_SDL_IOStream, closeio: c_bool) → LP_IMG_Animation

Load an animation from an SDL_IOStream.

SDL3_image.IMG_LoadBMP_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a BMP image directly.

SDL3_image.IMG_LoadCUR_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a CUR image directly.

SDL3_image.IMG_LoadGIFAnimation_IO(src: LP_SDL_IOStream) → LP_IMG_Animation

Load a GIF animation directly.

SDL3_image.IMG_LoadGIF_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a GIF image directly.

SDL3_image.IMG_LoadGPUTexture(device: LP_SDL_GPUDevice, copy_pass: LP_SDL_GPUCopyPass, file: c_char_p, width: LP_c_int, height: LP_c_int) → LP_SDL_GPUTexture

Load an image from a filesystem path into a GPU texture.

SDL3_image.IMG_LoadGPUTextureTyped_IO(device: LP_SDL_GPUDevice, copy_pass: LP_SDL_GPUCopyPass, src: LP_SDL_IOStream, closeio: c_bool, type: c_char_p, width: LP_c_int, height: LP_c_int) → LP_SDL_GPUTexture

Load an image from an SDL data source into a GPU texture.

SDL3_image.IMG_LoadGPUTexture_IO(device: LP_SDL_GPUDevice, copy_pass: LP_SDL_GPUCopyPass, src: LP_SDL_IOStream, closeio: c_bool, width: LP_c_int, height: LP_c_int) → LP_SDL_GPUTexture

Load an image from an SDL data source into a GPU texture.

SDL3_image.IMG_LoadICO_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a ICO image directly.

SDL3_image.IMG_LoadJPG_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a JPG image directly.

SDL3_image.IMG_LoadJXL_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a JXL image directly.

SDL3_image.IMG_LoadLBM_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a LBM image directly.

SDL3_image.IMG_LoadPCX_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a PCX image directly.

SDL3_image.IMG_LoadPNG_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a PNG image directly.

SDL3_image.IMG_LoadPNM_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a PNM image directly.

SDL3_image.IMG_LoadQOI_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a QOI image directly.

SDL3_image.IMG_LoadSVG_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a SVG image directly.

SDL3_image.IMG_LoadSizedSVG_IO(src: LP_SDL_IOStream, width: c_int, height: c_int) → LP_SDL_Surface

Load an SVG image, scaled to a specific size.

SDL3_image.IMG_LoadTGA_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a TGA image directly.

SDL3_image.IMG_LoadTIF_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a TIFF image directly.

SDL3_image.IMG_LoadTexture(renderer: LP_SDL_Renderer, file: c_char_p) → LP_SDL_Texture

Load an image from a filesystem path into a texture.

SDL3_image.IMG_LoadTextureTyped_IO(renderer: LP_SDL_Renderer, src: LP_SDL_IOStream, closeio: c_bool, type: c_char_p) → LP_SDL_Texture

Load an image from an SDL data source into a texture.

SDL3_image.IMG_LoadTexture_IO(renderer: LP_SDL_Renderer, src: LP_SDL_IOStream, closeio: c_bool) → LP_SDL_Texture

Load an image from an SDL data source into a texture.

SDL3_image.IMG_LoadTyped_IO(src: LP_SDL_IOStream, closeio: c_bool, type: c_char_p) → LP_SDL_Surface

Load an image from an SDL data source into a software surface.

SDL3_image.IMG_LoadWEBPAnimation_IO(src: LP_SDL_IOStream) → LP_IMG_Animation

Load a WEBP animation directly.

SDL3_image.IMG_LoadWEBP_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a WEBP image directly.

SDL3_image.IMG_LoadXCF_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a XCF image directly.

SDL3_image.IMG_LoadXPM_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a XPM image directly.

SDL3_image.IMG_LoadXV_IO(src: LP_SDL_IOStream) → LP_SDL_Surface

Load a XV image directly.

SDL3_image.IMG_Load_IO(src: LP_SDL_IOStream, closeio: c_bool) → LP_SDL_Surface

Load an image from an SDL data source into a software surface.

SDL3_image.IMG_ReadXPMFromArray(xpm: LP_c_char_p) → LP_SDL_Surface

Load an XPM image from a memory array.

SDL3_image.IMG_ReadXPMFromArrayToRGB888(xpm: LP_c_char_p) → LP_SDL_Surface

Load an XPM image from a memory array.

SDL3_image.IMG_ResetAnimationDecoder(decoder: LP_IMG_AnimationDecoder) → c_bool

Reset an animation decoder.

SDL3_image.IMG_Save(surface: LP_SDL_Surface, file: c_char_p) → c_bool

Save an SDL_Surface into an image file.

SDL3_image.IMG_SaveANIAnimation_IO(anim: LP_IMG_Animation, dst: LP_SDL_IOStream, closeio: c_bool) → c_bool

Save an animation in ANI format to an SDL_IOStream.

SDL3_image.IMG_SaveAPNGAnimation_IO(anim: LP_IMG_Animation, dst: LP_SDL_IOStream, closeio: c_bool) → c_bool

Save an animation in APNG format to an SDL_IOStream.

SDL3_image.IMG_SaveAVIF(surface: LP_SDL_Surface, file: c_char_p, quality: c_int) → c_bool

Save an SDL_Surface into a AVIF image file.

SDL3_image.IMG_SaveAVIFAnimation_IO(anim: LP_IMG_Animation, dst: LP_SDL_IOStream, closeio: c_bool, quality: c_int) → c_bool

Save an animation in AVIF format to an SDL_IOStream.

SDL3_image.IMG_SaveAVIF_IO(surface: LP_SDL_Surface, dst: LP_SDL_IOStream, closeio: c_bool, quality: c_int) → c_bool

Save an SDL_Surface into AVIF image data, via an SDL_IOStream.

SDL3_image.IMG_SaveAnimation(anim: LP_IMG_Animation, file: c_char_p) → c_bool

Save an animation to a file.

SDL3_image.IMG_SaveAnimationTyped_IO(anim: LP_IMG_Animation, dst: LP_SDL_IOStream, closeio: c_bool, type: c_char_p) → c_bool

Save an animation to an SDL_IOStream.

SDL3_image.IMG_SaveBMP(surface: LP_SDL_Surface, file: c_char_p) → c_bool

Save an SDL_Surface into a BMP image file.

SDL3_image.IMG_SaveBMP_IO(surface: LP_SDL_Surface, dst: LP_SDL_IOStream, closeio: c_bool) → c_bool

Save an SDL_Surface into BMP image data, via an SDL_IOStream.

SDL3_image.IMG_SaveCUR(surface: LP_SDL_Surface, file: c_char_p) → c_bool

Save an SDL_Surface into a CUR image file.

SDL3_image.IMG_SaveCUR_IO(surface: LP_SDL_Surface, dst: LP_SDL_IOStream, closeio: c_bool) → c_bool

Save an SDL_Surface into CUR image data, via an SDL_IOStream.

SDL3_image.IMG_SaveGIF(surface: LP_SDL_Surface, file: c_char_p) → c_bool

Save an SDL_Surface into a GIF image file.

SDL3_image.IMG_SaveGIFAnimation_IO(anim: LP_IMG_Animation, dst: LP_SDL_IOStream, closeio: c_bool) → c_bool

Save an animation in GIF format to an SDL_IOStream.

SDL3_image.IMG_SaveGIF_IO(surface: LP_SDL_Surface, dst: LP_SDL_IOStream, closeio: c_bool) → c_bool

Save an SDL_Surface into GIF image data, via an SDL_IOStream.

SDL3_image.IMG_SaveICO(surface: LP_SDL_Surface, file: c_char_p) → c_bool

Save an SDL_Surface into a ICO image file.

SDL3_image.IMG_SaveICO_IO(surface: LP_SDL_Surface, dst: LP_SDL_IOStream, closeio: c_bool) → c_bool

Save an SDL_Surface into ICO image data, via an SDL_IOStream.

SDL3_image.IMG_SaveJPG(surface: LP_SDL_Surface, file: c_char_p, quality: c_int) → c_bool

Save an SDL_Surface into a JPEG image file.

SDL3_image.IMG_SaveJPG_IO(surface: LP_SDL_Surface, dst: LP_SDL_IOStream, closeio: c_bool, quality: c_int) → c_bool

Save an SDL_Surface into JPEG image data, via an SDL_IOStream.

SDL3_image.IMG_SavePNG(surface: LP_SDL_Surface, file: c_char_p) → c_bool

Save an SDL_Surface into a PNG image file.

SDL3_image.IMG_SavePNG_IO(surface: LP_SDL_Surface, dst: LP_SDL_IOStream, closeio: c_bool) → c_bool

Save an SDL_Surface into PNG image data, via an SDL_IOStream.

SDL3_image.IMG_SaveTGA(surface: LP_SDL_Surface, file: c_char_p) → c_bool

Save an SDL_Surface into a TGA image file.

SDL3_image.IMG_SaveTGA_IO(surface: LP_SDL_Surface, dst: LP_SDL_IOStream, closeio: c_bool) → c_bool

Save an SDL_Surface into TGA image data, via an SDL_IOStream.

SDL3_image.IMG_SaveTyped_IO(surface: LP_SDL_Surface, dst: LP_SDL_IOStream, closeio: c_bool, type: c_char_p) → c_bool

Save an SDL_Surface into formatted image data, via an SDL_IOStream.

SDL3_image.IMG_SaveWEBP(surface: LP_SDL_Surface, file: c_char_p, quality: c_float) → c_bool

Save an SDL_Surface into a WEBP image file.

SDL3_image.IMG_SaveWEBPAnimation_IO(anim: LP_IMG_Animation, dst: LP_SDL_IOStream, closeio: c_bool, quality: c_int) → c_bool

Save an animation in WEBP format to an SDL_IOStream.

SDL3_image.IMG_SaveWEBP_IO(surface: LP_SDL_Surface, dst: LP_SDL_IOStream, closeio: c_bool, quality: c_float) → c_bool

Save an SDL_Surface into WEBP image data, via an SDL_IOStream.

SDL3_image.IMG_Version() → c_int

This function gets the version of the dynamically linked SDL_image library.

SDL3_image.IMG_isANI(src: LP_SDL_IOStream) → c_bool

Detect ANI animated cursor data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isAVIF(src: LP_SDL_IOStream) → c_bool

Detect AVIF image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isBMP(src: LP_SDL_IOStream) → c_bool

Detect BMP image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isCUR(src: LP_SDL_IOStream) → c_bool

Detect CUR image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isGIF(src: LP_SDL_IOStream) → c_bool

Detect GIF image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isICO(src: LP_SDL_IOStream) → c_bool

Detect ICO image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isJPG(src: LP_SDL_IOStream) → c_bool

Detect JPG image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isJXL(src: LP_SDL_IOStream) → c_bool

Detect JXL image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isLBM(src: LP_SDL_IOStream) → c_bool

Detect LBM image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isPCX(src: LP_SDL_IOStream) → c_bool

Detect PCX image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isPNG(src: LP_SDL_IOStream) → c_bool

Detect PNG image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isPNM(src: LP_SDL_IOStream) → c_bool

Detect PNM image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isQOI(src: LP_SDL_IOStream) → c_bool

Detect QOI image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isSVG(src: LP_SDL_IOStream) → c_bool

Detect SVG image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isTIF(src: LP_SDL_IOStream) → c_bool

Detect TIFF image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isWEBP(src: LP_SDL_IOStream) → c_bool

Detect WEBP image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isXCF(src: LP_SDL_IOStream) → c_bool

Detect XCF image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isXPM(src: LP_SDL_IOStream) → c_bool

Detect XPM image data on a readable/seekable SDL_IOStream.

SDL3_image.IMG_isXV(src: LP_SDL_IOStream) → c_bool

Detect XV image data on a readable/seekable SDL_IOStream.