Module Tsdl_image.Image

SDL2_image bindings for use with Tsdl

References

type 'a result = 'a Tsdl.Sdl.result

Initialization

module Init : sig ... end
val init : Init.t → Init.t

IMG_Init

val quit : unit → unit

IMG_Quit

type format =
  1. | Avif
  2. | Cur
  3. | Bmp
  4. | Gif
  5. | Ico
  6. | Jpg
  7. | Jxl
  8. | Lbm
  9. | Pcx
  10. | Png
  11. | Pnm
  12. | Svg
  13. | Qoi
  14. | Tga
  15. | Tif
  16. | Xcf
  17. | Xpm
  18. | Xv
  19. | Webp

Loading

val load : string → Tsdl.Sdl.surface result

IMG_Load

val load_rw : Tsdl.Sdl.rw_ops → bool → Tsdl.Sdl.surface result

IMG_Load_RW

val load_typed_rw : Tsdl.Sdl.rw_ops → bool → format → Tsdl.Sdl.surface result

IMG_LoadTyped_RW

val load_texture : Tsdl.Sdl.renderer → string → Tsdl.Sdl.texture result

IMG_LoadTexture

val load_texture_rw : Tsdl.Sdl.renderer → Tsdl.Sdl.rw_ops → bool → Tsdl.Sdl.texture result

IMG_LoadTexture_RW

val load_texture_typed_rw : Tsdl.Sdl.renderer → Tsdl.Sdl.rw_ops → bool → format → Tsdl.Sdl.texture result

IMG_LoadTextureTyped_RW

val load_format_rw : format → Tsdl.Sdl.rw_ops → Tsdl.Sdl.surface result
val load_sized_svg_rw : Tsdl.Sdl.rw_ops → int → int → Tsdl.Sdl.surface result

IMG_LoadSizedSVG_RW

val read_xpm_from_array : string → Tsdl.Sdl.surface result

IMG_ReadXPMFromArray

Saving

val save_png : Tsdl.Sdl.surface → string → int

IMG_SavePNG

val save_png_rw : Tsdl.Sdl.surface → Tsdl.Sdl.rw_ops → bool → int

IMG_SavePNG_RW

val save_jpg : Tsdl.Sdl.surface → string → int → int

IMG_SaveJPG

val save_jpg_rw : Tsdl.Sdl.surface → Tsdl.Sdl.rw_ops → bool → int → int

IMG_SaveJPG_RW

Info

val is_format : format → Tsdl.Sdl.rw_ops → bool

IMG_is*

Note that, uniquely, is_format Tga will throw an exception, as SDL_image does not support testing if a file is in Targa format.