Module: SDL2::IMG

Defined in:
video.c,
video.c

Overview

This module provides the interface to SDL_image. You can load many kinds of image files using this modules.

This module provides only initialization interface IMG.init. After calling init, you can load image files using Surface.load.

Constant Summary

INIT_JPG =

Initialize the JPEG loader

INT2NUM(IMG_INIT_JPG)
INIT_PNG =

Initialize the PNG loader

INT2NUM(IMG_INIT_PNG)
INIT_TIF =

Initialize the TIF loader

INT2NUM(IMG_INIT_TIF)
INIT_WEBP =

Initialize the WEBP loader

INT2NUM(IMG_INIT_WEBP)

Class Method Summary collapse

Class Method Details

.init(flags) ⇒ nil

Initialize SDL_image.

You can specify the supporting image formats by bitwise OR’d of the following constants.

You need to initialize SDL_image to check whether specified format is supported by your environment. If your environment does not support required support format, you have a Error exception.

Parameters:

  • flags (Integer) —

    submodule bits

Returns:

  • (nil)

Raises:

  • (SDL2::Error) —

    raised when initializing is failed.



3441
3442
3443
3444
3445
3446
3447
 
# File 'video.c', line 3441

static VALUE IMG_s_init(VALUE self, VALUE f)
{
    int flags = NUM2INT(f);
    if ((IMG_Init(flags) & flags) != flags)
        rb_raise(eSDL2Error, "Couldn't initialze SDL_image");
    return Qnil;
}