package vendor:sdl3/image

⌘K
Ctrl+K
or
/

    Types

    Animation ¶

    Animation :: struct {
    	w:      i32,
    	h:      i32,
    	count:  i32,
    	frames: [^]^sdl3.Surface,
    	delays: [^]i32,
    }
    Related Procedures With Parameters
    Related Procedures With Returns

    Constants

    MAJOR_VERSION ¶

    MAJOR_VERSION: int : 3

    MINOR_VERSION ¶

    MINOR_VERSION: int : 2

    PATCHLEVEL ¶

    PATCHLEVEL: int : 0

    Variables

    This section is empty.

    Procedures

    FreeAnimation ¶

    FreeAnimation :: proc "c" (anim: ^Animation) ---

    Load ¶

    Load :: proc "c" (file: cstring) -> ^sdl3.Surface ---
     

    Convenience functions

    LoadAVIF_IO ¶

    LoadAVIF_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
     

    Individual loading functions

    LoadAnimation ¶

    LoadAnimation :: proc "c" (file: cstring) -> ^Animation ---

    LoadAnimationTyped_IO ¶

    LoadAnimationTyped_IO :: proc "c" (src: ^sdl3.IOStream, closeio: bool, type: cstring) -> ^Animation ---

    LoadAnimation_IO ¶

    LoadAnimation_IO :: proc "c" (src: ^sdl3.IOStream, closeio: bool) -> ^Animation ---

    LoadBMP_IO ¶

    LoadBMP_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadCUR_IO ¶

    LoadCUR_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadGIFAnimation_IO ¶

    LoadGIFAnimation_IO :: proc "c" (src: ^sdl3.IOStream) -> ^Animation ---
     

    Individual loading functions

    LoadGIF_IO ¶

    LoadGIF_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadICO_IO ¶

    LoadICO_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadJPG_IO ¶

    LoadJPG_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadJXL_IO ¶

    LoadJXL_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadLBM_IO ¶

    LoadLBM_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadPCX_IO ¶

    LoadPCX_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadPNG_IO ¶

    LoadPNG_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadPNM_IO ¶

    LoadPNM_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadQOI_IO ¶

    LoadQOI_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadSVG_IO ¶

    LoadSVG_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadSizedSVG_IO ¶

    LoadSizedSVG_IO :: proc "c" (src: ^sdl3.IOStream, width, height: i32) -> ^sdl3.Surface ---

    LoadTGA_IO ¶

    LoadTGA_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadTIF_IO ¶

    LoadTIF_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadTexture ¶

    LoadTexture :: proc "c" (renderer: ^sdl3.Renderer, file: cstring) -> ^sdl3.Texture ---
     

    Load an image directly into a render texture.

    LoadTextureTyped_IO ¶

    LoadTextureTyped_IO :: proc "c" (renderer: ^sdl3.Renderer, src: ^sdl3.IOStream, closeio: bool, type: cstring) -> ^sdl3.Texture ---

    LoadTexture_IO ¶

    LoadTexture_IO :: proc "c" (renderer: ^sdl3.Renderer, src: ^sdl3.IOStream, closeio: bool) -> ^sdl3.Texture ---

    LoadTyped_IO ¶

    LoadTyped_IO :: proc "c" (src: ^sdl3.IOStream, closeio: bool, type: cstring) -> ^sdl3.Surface ---
     

    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);
    

    LoadWEBPAnimation_IO ¶

    LoadWEBPAnimation_IO :: proc "c" (src: ^sdl3.IOStream) -> ^Animation ---

    LoadWEBP_IO ¶

    LoadWEBP_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadXCF_IO ¶

    LoadXCF_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadXPM_IO ¶

    LoadXPM_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    LoadXV_IO ¶

    LoadXV_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---

    Load_IO ¶

    Load_IO :: proc "c" (src: ^sdl3.IOStream, closeio: bool) -> ^sdl3.Surface ---

    ReadXPMFromArray ¶

    ReadXPMFromArray :: proc "c" (xpm: [^]cstring) -> ^sdl3.Surface ---

    ReadXPMFromArrayToRGB888 ¶

    ReadXPMFromArrayToRGB888 :: proc "c" (xpm: [^]cstring) -> ^sdl3.Surface ---

    SaveAVIF ¶

    SaveAVIF :: proc "c" (surface: ^sdl3.Surface, file: cstring, quality: i32) -> i32 ---
     

    Individual saving functions

    SaveAVIF_IO ¶

    SaveAVIF_IO :: proc "c" (surface: ^sdl3.Surface, dst: ^sdl3.IOStream, closeio: bool, quality: i32) -> i32 ---

    SaveJPG ¶

    SaveJPG :: proc "c" (surface: ^sdl3.Surface, file: cstring, quality: i32) -> i32 ---

    SaveJPG_IO ¶

    SaveJPG_IO :: proc "c" (surface: ^sdl3.Surface, dst: ^sdl3.IOStream, closeio: bool, quality: i32) -> i32 ---

    SavePNG ¶

    SavePNG :: proc "c" (surface: ^sdl3.Surface, file: cstring) -> i32 ---

    SavePNG_IO ¶

    SavePNG_IO :: proc "c" (surface: ^sdl3.Surface, dst: ^sdl3.IOStream, closeio: bool) -> i32 ---

    Version ¶

    Version :: proc "c" () -> i32 ---

    isAVIF ¶

    isAVIF :: proc "c" (src: ^sdl3.IOStream) -> bool ---
     

    Functions to detect a file type, given a seekable source

    isBMP ¶

    isBMP :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isCUR ¶

    isCUR :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isGIF ¶

    isGIF :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isICO ¶

    isICO :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isJPG ¶

    isJPG :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isJXL ¶

    isJXL :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isLBM ¶

    isLBM :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isPCX ¶

    isPCX :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isPNG ¶

    isPNG :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isPNM ¶

    isPNM :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isQOI ¶

    isQOI :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isSVG ¶

    isSVG :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isTIF ¶

    isTIF :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isWEBP ¶

    isWEBP :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isXCF ¶

    isXCF :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isXPM ¶

    isXPM :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    isXV ¶

    isXV :: proc "c" (src: ^sdl3.IOStream) -> bool ---

    Procedure Groups

    This section is empty.

    Source Files

    Generation Information

    Generated with odin version dev-2025-06 (vendor "odin") Windows_amd64 @ 2025-06-04 21:11:01.998158200 +0000 UTC