Class: SDL2::PixelFormat

Inherits:

Object

• Object
• SDL2::PixelFormat

Defined in:

video.c,
video.c

Overview

This class represents pixel format of textures, windows, and displays.

In C level, SDL use unsigned integers as pixel formats. This class wraps these integers. You can get the integers from #format.

Defined Under Namespace

Modules: ArrayOrder, BitmapOrder, PackedLayout, PackedOrder, Type

Constant Summary

FORMATS =

Returns array of all available formats.

Returns:

• (Array<SDL2::PixelFormat>) —

  array of all available formats

-

UNKNOWN =

Returns Unused - reserved by SDL.

Returns:

• (SDL2::PixelFormat) —

  Unused - reserved by SDL

-

INDEX1LSB =

Returns:

• (SDL2::PixelFormat)

-

INDEX1MSB =

Returns:

• (SDL2::PixelFormat)

-

INDEX4LSB =

Returns:

• (SDL2::PixelFormat)

-

INDEX4MSB =

Returns:

• (SDL2::PixelFormat)

-

INDEX8 =

Returns:

• (SDL2::PixelFormat)

-

RGB332 =

Returns:

• (SDL2::PixelFormat)

-

RGB444 =

Returns:

• (SDL2::PixelFormat)

-

RGB555 =

Returns:

• (SDL2::PixelFormat)

-

BGR555 =

Returns:

• (SDL2::PixelFormat)

-

ARGB4444 =

Returns:

• (SDL2::PixelFormat)

-

RGBA4444 =

Returns:

• (SDL2::PixelFormat)

-

ABGR4444 =

Returns:

• (SDL2::PixelFormat)

-

BGRA4444 =

Returns:

• (SDL2::PixelFormat)

-

ARGB1555 =

Returns:

• (SDL2::PixelFormat)

-

RGBA5551 =

Returns:

• (SDL2::PixelFormat)

-

ABGR1555 =

Returns:

• (SDL2::PixelFormat)

-

BGRA5551 =

Returns:

• (SDL2::PixelFormat)

-

RGB565 =

Returns:

• (SDL2::PixelFormat)

-

BGR565 =

Returns:

• (SDL2::PixelFormat)

-

RGB24 =

Returns:

• (SDL2::PixelFormat)

-

BGR24 =

Returns:

• (SDL2::PixelFormat)

-

RGB888 =

Returns:

• (SDL2::PixelFormat)

-

RGBX8888 =

Returns:

• (SDL2::PixelFormat)

-

BGR888 =

Returns:

• (SDL2::PixelFormat)

-

BGRX8888 =

Returns:

• (SDL2::PixelFormat)

-

ARGB8888 =

Returns:

• (SDL2::PixelFormat)

-

RGBA8888 =

Returns:

• (SDL2::PixelFormat)

-

ABGR8888 =

Returns:

• (SDL2::PixelFormat)

-

BGRA8888 =

Returns:

• (SDL2::PixelFormat)

-

ARGB2101010 =

Returns:

• (SDL2::PixelFormat)

-

YV12 =

Returns:

• (SDL2::PixelFormat)

-

IYUV =

Returns:

• (SDL2::PixelFormat)

-

YUY2 =

Returns:

• (SDL2::PixelFormat)

-

UYVY =

Returns:

• (SDL2::PixelFormat)

-

YVYU =

Returns:

• (SDL2::PixelFormat)

-

Instance Attribute Summary

• #format ⇒ Integer readonly

  An integer representing the pixel format.

Instance Method Summary

• #==(other) ⇒ Boolean

  Return true if two pixel format is the same format.

• #alpha? ⇒ Boolean

  Return true if the pixel format have an alpha channel.

• #bits_per_pixel ⇒ Integer (also: #bpp)

  Get the number of bits per pixel.

• #bytes_per_pixel ⇒ Integer

  Get the number of bytes per pixel.

• #fourcc? ⇒ Boolean

  Return true if the pixel format is not indexed, and not RGB(A), for example, the pixel format is YUV.

• #indexed? ⇒ Boolean

  Return true if the pixel format have a palette.

• #initialze(format) ⇒ Object constructor

  Initialize pixel format from the given integer representing a fomrmat.

• #inspect ⇒ String

  Inspection string.

• #layout ⇒ Integer

  Get the channel bit pattern of the pixel format.

• #name ⇒ String

  Get the human readable name of the pixel format.

• #order ⇒ Integer

  Get the ordering of channels or bits in the pixel format.

• #type ⇒ Integer

  Get the type of the format.

Constructor Details

#initialze(format) ⇒ Object

Initialize pixel format from the given integer representing a fomrmat.

Parameters:

• format (Integer) —

  an unsigned integer as a pixel formats

# File 'video.c', line 2728

static VALUE PixelForamt_initialize(VALUE self, VALUE format)
{
    rb_iv_set(self, "@format", format);
    return Qnil;
}

Instance Attribute Details

#format ⇒ Integer (readonly)

An integer representing the pixel format.

Returns:

• (Integer)

Instance Method Details

#==(other) ⇒ Boolean

Return true if two pixel format is the same format.

Parameters:

• other (SDL2::PixelFormat) —

  other PixelFormat object

Returns:

• (Boolean)

# File 'video.c', line 2831

static VALUE PixelFormat_eq(VALUE self, VALUE other)
{
    if (!rb_obj_is_kind_of(other, cPixelFormat))
        return Qfalse;

    return INT2BOOL(rb_iv_get(self, "@format") == rb_iv_get(other, "@format"));
}

#alpha? ⇒ Boolean

Return true if the pixel format have an alpha channel.

Returns:

• (Boolean)

# File 'video.c', line 2809

static VALUE PixelFormat_alpha_p(VALUE self)
{
    return INT2BOOL(SDL_ISPIXELFORMAT_ALPHA(NUM2UINT(rb_iv_get(self, "@format"))));
};

#bits_per_pixel ⇒ Integer Also known as: bpp

Get the number of bits per pixel.

Returns:

• (Integer)

# File 'video.c', line 2783

static VALUE PixelFormat_bits_per_pixel(VALUE self)
{
    return INT2NUM(SDL_BITSPERPIXEL(NUM2UINT(rb_iv_get(self, "@format"))));
};

#bytes_per_pixel ⇒ Integer

Get the number of bytes per pixel.

Returns:

• (Integer)

# File 'video.c', line 2793

static VALUE PixelFormat_bytes_per_pixel(VALUE self)
{
    return INT2NUM(SDL_BYTESPERPIXEL(NUM2UINT(rb_iv_get(self, "@format"))));
};

#fourcc? ⇒ Boolean

Return true if the pixel format is not indexed, and not RGB(A), for example, the pixel format is YUV.

Returns:

• (Boolean)

# File 'video.c', line 2818

static VALUE PixelFormat_fourcc_p(VALUE self)
{
    return INT2BOOL(SDL_ISPIXELFORMAT_FOURCC(NUM2UINT(rb_iv_get(self, "@format"))));
};

#indexed? ⇒ Boolean

Return true if the pixel format have a palette.

Returns:

• (Boolean)

# File 'video.c', line 2801

static VALUE PixelFormat_indexed_p(VALUE self)
{
    return INT2BOOL(SDL_ISPIXELFORMAT_INDEXED(NUM2UINT(rb_iv_get(self, "@format"))));
};

#inspect ⇒ String

Returns inspection string.

Returns:

• (String) —

  inspection string

# File 'video.c', line 2840

static VALUE PixelFormat_inspect(VALUE self)
{
    Uint32 format = NUM2UINT(rb_iv_get(self, "@format"));
    return rb_sprintf("<%s: %s type=%d order=%d layout=%d"
                      " bits=%d bytes=%d indexed=%s alpha=%s fourcc=%s>",
                      rb_obj_classname(self),
                      SDL_GetPixelFormatName(format),
                      SDL_PIXELTYPE(format), SDL_PIXELORDER(format), SDL_PIXELLAYOUT(format),
                      SDL_BITSPERPIXEL(format), SDL_BYTESPERPIXEL(format),
                      INT2BOOLCSTR(SDL_ISPIXELFORMAT_INDEXED(format)),
                      INT2BOOLCSTR(SDL_ISPIXELFORMAT_ALPHA(format)),
                      INT2BOOLCSTR(SDL_ISPIXELFORMAT_FOURCC(format)));
}

#layout ⇒ Integer

Get the channel bit pattern of the pixel format.

Returns:

• (Integer) —

  One of the constants of PackedLayout module.

# File 'video.c', line 2773

static VALUE PixelFormat_layout(VALUE self)
{
    return UINT2NUM(SDL_PIXELLAYOUT(NUM2UINT(rb_iv_get(self, "@format"))));
};

#name ⇒ String

Get the human readable name of the pixel format

Returns:

• (String)

# File 'video.c', line 2753

static VALUE PixelFormat_name(VALUE self)
{
    return utf8str_new_cstr(SDL_GetPixelFormatName(NUM2UINT(rb_iv_get(self, "@format"))));
};

#order ⇒ Integer

Get the ordering of channels or bits in the pixel format.

Returns:

• (Integer) —

  One of the constants of BitmapOrder module or PackedOrder module.

# File 'video.c', line 2763

static VALUE PixelFormat_order(VALUE self)
{
    return UINT2NUM(SDL_PIXELORDER(NUM2UINT(rb_iv_get(self, "@format"))));
};

#type ⇒ Integer

Get the type of the format.

Returns:

• (Integer) —

  One of the constants of Type module.

# File 'video.c', line 2739

static VALUE PixelFormat_type(VALUE self)
{
    return UINT2NUM(SDL_PIXELTYPE(NUM2UINT(rb_iv_get(self, "@format"))));
}