Module: Frusdl::SDL

Extended by:: Low::SDL

Includes:: Low::SDL

Defined in:: lib/frusdl/sdl.rb,
lib/frusdl/sdl/screen.rb,
lib/frusdl/sdl/videoinfo.rb,
lib/frusdl/sdl/pixelformat.rb

Defined Under Namespace

Classes: Error, PixelFormat, Screen, VideoInfo

Constant Summary collapse

INIT_TIMER =

SDL_INIT_TIMER

INIT_AUDIO =

SDL_INIT_AUDIO

INIT_VIDEO =

SDL_INIT_VIDEO

INIT_CDROM =

SDL_INIT_CDROM

INIT_JOYSTICK =

SDL_INIT_JOYSTICK

INIT_NOPARACHUTE =

SDL_INIT_NOPARACHUTE

INIT_EVENTTHREAD =

SDL_INIT_EVENTTHREAD

INIT_EVERYTHING =

SDL_INIT_EVERYTHING

SDL_SWSURFACE = And some for video functions

0x00000000

SDL_HWSURFACE =

0x00000001

SDL_ASYNCBLIT =

0x00000004

SDL_ANYFORMAT =

0x10000000

SDL_HWPALETTE =

0x20000000

SDL_DOUBLEBUF =

0x40000000

SDL_FULLSCREEN =

0x80000000

SDL_OPENGL =

0x00000002

SDL_OPENGLBLIT =

0x0000000A

SDL_RESIZABLE =

0x00000010

SDL_NOFRAME =

0x00000020

SDL_GRAB_QUERY = And some more for mouse grabbing

-1

SDL_GRAB_OFF =

SDL_GRAB_ON =

SDL_GRAB_FULLSCREEN =

SDL_LIL_ENDIAN =

:little_endian

SDL_BYTEORDER =

SDL_BIG_ENDIAN

AUDIO_U8 = Unsigned 8-bit samples

0x0008

AUDIO_S8 = Signed 8-bit samples

0x8008

AUDIO_U16LSB = Unsigned 16-bit samples

0x0010

AUDIO_S16LSB = Signed 16-bit samples

0x8010

AUDIO_U16MSB = As above, but big-endian byte order

0x1010

AUDIO_S16MSB = As above, but big-endian byte order

0x9010

AUDIO_U16 =

AUDIO_U16LSB

AUDIO_S16 =

AUDIO_S16LSB

AUDIO_U16SYS =

AUDIO_U16MSB

AUDIO_S16SYS =

AUDIO_S16MSB

SDL_AUDIO_STOPPED =

SDL_AUDIO_PLAYING =

SDL_AUDIO_PAUSED =

SDL_MIX_MAXVOLUME =

SDL_DEFAULT_REPEAT_DELAY =

SDL_DEFAULT_REPEAT_INTERVAL =

SDLK_UNKNOWN = SDL_keysym (lots of boring constants ahead :p )

SDLK_FIRST =

SDLK_BACKSPACE =

SDLK_TAB =

SDLK_CLEAR =

SDLK_RETURN =

SDLK_PAUSE =

SDLK_ESCAPE =

SDLK_SPACE =

SDLK_EXCLAIM =

SDLK_QUOTEDBL =

SDLK_HASH =

SDLK_DOLLAR =

SDLK_AMPERSAND =

SDLK_QUOTE =

SDLK_LEFTPAREN =

SDLK_RIGHTPAREN =

SDLK_ASTERISK =

SDLK_PLUS =

SDLK_COMMA =

SDLK_MINUS =

SDLK_PERIOD =

SDLK_SLASH =

SDLK_0 =

SDLK_1 =

SDLK_2 =

SDLK_3 =

SDLK_4 =

SDLK_5 =

SDLK_6 =

SDLK_7 =

SDLK_8 =

SDLK_9 =

SDLK_COLON =

SDLK_SEMICOLON =

SDLK_LESS =

SDLK_EQUALS =

SDLK_GREATER =

SDLK_QUESTION =

SDLK_AT =

SDLK_LEFTBRACKET =

SDLK_BACKSLASH =

SDLK_RIGHTBRACKET =

SDLK_CARET =

SDLK_UNDERSCORE =

SDLK_BACKQUOTE =

SDLK_a =

SDLK_b =

SDLK_c =

SDLK_d =

SDLK_e =

SDLK_f =

SDLK_g =

SDLK_h =

SDLK_i =

SDLK_j =

SDLK_k =

SDLK_l =

SDLK_m =

SDLK_n =

SDLK_o =

SDLK_p =

SDLK_q =

SDLK_r =

SDLK_s =

SDLK_t =

SDLK_u =

SDLK_v =

SDLK_w =

SDLK_x =

SDLK_y =

SDLK_z =

SDLK_DELETE =

SDLK_WORLD_0 =

SDLK_WORLD_1 =

SDLK_WORLD_2 =

SDLK_WORLD_3 =

SDLK_WORLD_4 =

SDLK_WORLD_5 =

SDLK_WORLD_6 =

SDLK_WORLD_7 =

SDLK_WORLD_8 =

SDLK_WORLD_9 =

SDLK_WORLD_10 =

SDLK_WORLD_11 =

SDLK_WORLD_12 =

SDLK_WORLD_13 =

SDLK_WORLD_14 =

SDLK_WORLD_15 =

SDLK_WORLD_16 =

SDLK_WORLD_17 =

SDLK_WORLD_18 =

SDLK_WORLD_19 =

SDLK_WORLD_20 =

SDLK_WORLD_21 =

SDLK_WORLD_22 =

SDLK_WORLD_23 =

SDLK_WORLD_24 =

SDLK_WORLD_25 =

SDLK_WORLD_26 =

SDLK_WORLD_27 =

SDLK_WORLD_28 =

SDLK_WORLD_29 =

SDLK_WORLD_30 =

SDLK_WORLD_31 =

SDLK_WORLD_32 =

SDLK_WORLD_33 =

SDLK_WORLD_34 =

SDLK_WORLD_35 =

SDLK_WORLD_36 =

SDLK_WORLD_37 =

SDLK_WORLD_38 =

SDLK_WORLD_39 =

SDLK_WORLD_40 =

SDLK_WORLD_41 =

SDLK_WORLD_42 =

SDLK_WORLD_43 =

SDLK_WORLD_44 =

SDLK_WORLD_45 =

SDLK_WORLD_46 =

SDLK_WORLD_47 =

SDLK_WORLD_48 =

SDLK_WORLD_49 =

SDLK_WORLD_50 =

SDLK_WORLD_51 =

SDLK_WORLD_52 =

SDLK_WORLD_53 =

SDLK_WORLD_54 =

SDLK_WORLD_55 =

SDLK_WORLD_56 =

SDLK_WORLD_57 =

SDLK_WORLD_58 =

SDLK_WORLD_59 =

SDLK_WORLD_60 =

SDLK_WORLD_61 =

SDLK_WORLD_62 =

SDLK_WORLD_63 =

SDLK_WORLD_64 =

SDLK_WORLD_65 =

SDLK_WORLD_66 =

SDLK_WORLD_67 =

SDLK_WORLD_68 =

SDLK_WORLD_69 =

SDLK_WORLD_70 =

SDLK_WORLD_71 =

SDLK_WORLD_72 =

SDLK_WORLD_73 =

SDLK_WORLD_74 =

SDLK_WORLD_75 =

SDLK_WORLD_76 =

SDLK_WORLD_77 =

SDLK_WORLD_78 =

SDLK_WORLD_79 =

SDLK_WORLD_80 =

SDLK_WORLD_81 =

SDLK_WORLD_82 =

SDLK_WORLD_83 =

SDLK_WORLD_84 =

SDLK_WORLD_85 =

SDLK_WORLD_86 =

SDLK_WORLD_87 =

SDLK_WORLD_88 =

SDLK_WORLD_89 =

SDLK_WORLD_90 =

SDLK_WORLD_91 =

SDLK_WORLD_92 =

SDLK_WORLD_93 =

SDLK_WORLD_94 =

SDLK_WORLD_95 =

SDLK_KP0 =

SDLK_KP1 =

SDLK_KP2 =

SDLK_KP3 =

SDLK_KP4 =

SDLK_KP5 =

SDLK_KP6 =

SDLK_KP7 =

SDLK_KP8 =

SDLK_KP9 =

SDLK_KP_PERIOD =

SDLK_KP_DIVIDE =

SDLK_KP_MULTIPLY =

SDLK_KP_MINUS =

SDLK_KP_PLUS =

SDLK_KP_ENTER =

SDLK_KP_EQUALS =

SDLK_UP =

SDLK_DOWN =

SDLK_RIGHT =

SDLK_LEFT =

SDLK_INSERT =

SDLK_HOME =

SDLK_END =

SDLK_PAGEUP =

SDLK_PAGEDOWN =

SDLK_F1 =

SDLK_F2 =

SDLK_F3 =

SDLK_F4 =

SDLK_F5 =

SDLK_F6 =

SDLK_F7 =

SDLK_F8 =

SDLK_F9 =

SDLK_F10 =

SDLK_F11 =

SDLK_F12 =

SDLK_F13 =

SDLK_F14 =

SDLK_F15 =

SDLK_NUMLOCK =

SDLK_CAPSLOCK =

SDLK_SCROLLOCK =

SDLK_RSHIFT =

SDLK_LSHIFT =

SDLK_RCTRL =

SDLK_LCTRL =

SDLK_RALT =

SDLK_LALT =

SDLK_RMETA =

SDLK_LMETA =

SDLK_LSUPER =

SDLK_RSUPER =

SDLK_MODE =

SDLK_COMPOSE =

SDLK_HELP =

SDLK_PRINT =

SDLK_SYSREQ =

SDLK_BREAK =

SDLK_MENU =

SDLK_POWER =

SDLK_EURO =

SDLK_UNDO =

SDLK_LAST =

KMOD_NONE =

0x0000

KMOD_LSHIFT =

0x0001

KMOD_RSHIFT =

0x0002

KMOD_LCTRL =

0x0040

KMOD_RCTRL =

0x0080

KMOD_LALT =

0x0100

KMOD_RALT =

0x0200

KMOD_LMETA =

0x0400

KMOD_RMETA =

0x0800

KMOD_NUM =

0x1000

KMOD_CAPS =

0x2000

KMOD_MODE =

0x4000

KMOD_RESERVED =

0x8000

KMOD_CTRL =

(KMOD_LCTRL|KMOD_RCTRL)

KMOD_SHIFT =

(KMOD_LSHIFT|KMOD_RSHIFT)

KMOD_ALT =

(KMOD_LALT|KMOD_RALT)

KMOD_META =

(KMOD_LMETA|KMOD_RMETA)

RW_SEEK_SET = Phew, all done! ^_^

RW_SEEK_CUR =

RW_SEEK_END =

SDL_RELEASED = SDL_event

SDL_PRESSED =

SDL_NOEVENT =

SDL_ACTIVEEVENT =

SDL_KEYDOWN =

SDL_KEYUP =

SDL_MOUSEMOTION =

SDL_MOUSEBUTTONDOWN =

SDL_MOUSEBUTTONUP =

SDL_JOYAXISMOTION =

SDL_JOYBALLMOTION =

SDL_JOYHATMOTION =

SDL_JOYBUTTONDOWN =

SDL_JOYBUTTONUP =

SDL_QUIT =

SDL_SYSWMEVENT =

SDL_EVENT_RESERVEDA =

SDL_EVENT_RESERVEDB =

SDL_VIDEORESIZE =

SDL_VIDEOEXPOSE =

SDL_EVENT_RESERVED2 =

SDL_EVENT_RESERVED3 =

SDL_EVENT_RESERVED4 =

SDL_EVENT_RESERVED5 =

SDL_EVENT_RESERVED6 =

SDL_EVENT_RESERVED7 =

SDL_USEREVENT =

SDL_NUMEVENTS =

SDL_HAT_CENTERED =

0x00

SDL_HAT_UP =

0x01

SDL_HAT_RIGHT =

0x02

SDL_HAT_DOWN =

0x04

SDL_HAT_LEFT =

0x08

SDL_HAT_RIGHTUP =

(SDL_HAT_RIGHT|SDL_HAT_UP)

SDL_HAT_RIGHTDOWN =

(SDL_HAT_RIGHT|SDL_HAT_DOWN)

SDL_HAT_LEFTUP =

(SDL_HAT_LEFT|SDL_HAT_UP)

SDL_HAT_LEFTDOWN =

(SDL_HAT_LEFT|SDL_HAT_DOWN)

Constants included from Low::SDL

Class Method Summary collapse

.getenv(s) ⇒ Object
.init(what = INIT_EVERYTHING) ⇒ Object

Initializes SDL.
.inited_system(flags) ⇒ Object

This method allows you to see which SDL subsytems have been initialized.
.putenv(s) ⇒ Object
.quit ⇒ Object

This method shuts down all SDL subsystems and frees the resources allocated to them.

Instance Method Summary collapse

#raise_error ⇒ Object

Helper function to raise an error message from SDL_GetError .

Methods included from Low::SDL

SDL_BlitSurface, SDL_LoadBMP, SDL_LoadWAV, SDL_RWclose, SDL_RWread, SDL_RWseek, SDL_RWtell, SDL_RWwrite, SDL_SaveBMP

Class Method Details

.getenv(s) ⇒ `Object`



55
56
57

# File 'lib/frusdl/sdl.rb', line 55

def self.getenv(s)
  return SDL_getenv(s)
end

.init(what = INIT_EVERYTHING) ⇒ `Object`

Initializes SDL. This should be called before all other Frusdl methods. The flags parameter specifies what part(s) of SDL to initialize. SDL::INIT_AUDIO : Initialize audio subsystems. SDL::INIT_VIDEO : Initialize SDL::Video subsystem. SDL::INIT_CDROM : Initialize SDL::CDROM subsystem. SDL::INIT_JOYSTICK : Initialize SDL::Joystick subsystem. SDL::INIT_EVERYTHING : Initialize all of the above. Raises SDL::Error on failure

# File 'lib/frusdl/sdl.rb', line 33

def self.init(what= INIT_EVERYTHING)
  res = SDL_Init(what)
  raise_error if res < 0
  at_exit { SDL_Quit() }    
end

.inited_system(flags) ⇒ `Object`

This method allows you to see which SDL subsytems have been initialized. flags is a bitwise OR’d combination of the subsystems you wish to check (see SDL.init for a list of subsystem flags). Returns a bitwised OR’d combination of the initialized subsystems.



50
51
52

# File 'lib/frusdl/sdl.rb', line 50

def self.inited_system(flags)
  return SDL_WasInit(flags)
end

.putenv(s) ⇒ `Object`



59
60
61

# File 'lib/frusdl/sdl.rb', line 59

def self.putenv(s)
  return SDL_putenv(s)
end

.quit ⇒ `Object`

This method shuts down all SDL subsystems and frees the resources allocated to them. This method is automatically called when ruby stops, so normally you don’t have to call this function.



42
43
44

# File 'lib/frusdl/sdl.rb', line 42

def self.quit()
  SDL_Quit()
end

Instance Method Details

#raise_error ⇒ `Object`

Helper function to raise an error message from SDL_GetError .

Raises:

(SDL::Error)

# File 'lib/frusdl/sdl.rb', line 20

def raise_error()
    message = SDL_GetError();
    raise SDL::Error.new(message)
end