Tao.Sdl SDK Documentation

Sdl Fields

The fields of the Sdl class are listed below. For a complete list of Sdl class members, see the Sdl Members topic.

Public Static (Shared) Fields

AUDIO_S16 Signed 16-bit little-endian samples
AUDIO_S16LSB Signed 16-bit little-endian samples
AUDIO_S16MSB Signed 16-bit big-endian samples
AUDIO_S8 Signed 8-bit samples.
AUDIO_U16 Unsigned 16-bit little-endian samples
AUDIO_U16LSB Unsigned 16-bit little-endian samples.
AUDIO_U16MSB Unsigned 16-bit big-endian samples
AUDIO_U8 Unsigned 8-bit samples.
CD_ERROR An error occured while getting the status.
CD_FPS Frames per second.
CD_PAUSED The CD has been paused.
CD_PLAYING The CD is playing.
CD_STOPPED The CD has stopped playing.
CD_TRAYEMPTY The CD tray is empty.
KMOD_ALT Both ALT keys.
KMOD_CAPS Capslock is down
KMOD_CTRL Both CTRL keys.
KMOD_LALT Left Alt is down
KMOD_LCTRL Left Control is down
KMOD_LMETA Left Meta is down
KMOD_LSHIFT Left Shift is down
KMOD_META Both META keys.
KMOD_MODE
KMOD_NONE No modifiers applicable
KMOD_NUM Numlock is down
KMOD_RALT Right Alt is down
KMOD_RCTRL Right Control is down
KMOD_RESERVED
KMOD_RMETA Right Meta is down
KMOD_RSHIFT Right Shift is down
KMOD_SHIFT Both SHIFT keys.
RW_SEEK_CUR Seek relative to current read point
RW_SEEK_END Seek relative to the end of data
RW_SEEK_SET Seek from the beginning of data
SDL_ACTIVEEVENT Application loses/gains visibility
SDL_ACTIVEEVENTMASK
SDL_ADDEVENT If 'action' is SDL_ADDEVENT, up to 'numevents' events will be added to the back of the event queue.
SDL_ALL_HOTKEYS This is the mask which refers to all hotkey bindings.
SDL_ALLEVENTS This is the mask which refers to all hotkey bindings.
SDL_ALPHA_OPAQUE Transparency definition of Opaque
SDL_ALPHA_TRANSPARENT Transparency definition of Transparent
SDL_ANYFORMAT Allow any video depth/pixel-format
SDL_APPACTIVE The application is active
SDL_APPINPUTFOCUS The app has input focus
SDL_APPMOUSEFOCUS The app has mouse coverage
SDL_ASYNCBLIT Use asynchronous blits if possible
SDL_AUDIO_PAUSED SDL_audiostatus. Get the current audio state
SDL_AUDIO_PLAYING SDL_audiostatus. Get the current audio state
SDL_AUDIO_STOPPED SDL_audiostatus. Get the current audio state
SDL_AUDIO_TRACK The types of CD-ROM track possible
SDL_BIG_ENDIAN Big Endian
SDL_BUTTON_LEFT Used as a mask when testing buttons in buttonstate Button 1: Left mouse button
SDL_BUTTON_LMASK
SDL_BUTTON_MIDDLE Button 2: Middle mouse button
SDL_BUTTON_MMASK
SDL_BUTTON_RIGHT Button 3: Right mouse button
SDL_BUTTON_RMASK
SDL_BUTTON_WHEELDOWN Button 5: Mouse wheel down (may also be a real button)
SDL_BUTTON_WHEELUP Button 4: Mouse wheel up (may also be a real button)
SDL_DATA_TRACK The types of CD-ROM track possible
SDL_DEFAULT_REPEAT_DELAY Enable/Disable keyboard repeat. Keyboard repeat defaults to off. 'delay' is the initial delay in ms between the time when a key is pressed, and keyboard repeat begins.
SDL_DEFAULT_REPEAT_INTERVAL Enable/Disable keyboard repeat. Keyboard repeat defaults to off. 'interval' is the time in ms between keyboard repeat events.
SDL_DISABLE
SDL_DOUBLEBUF Set up double-buffered video mode
SDL_ENABLE If 'state' is set to SDL_ENABLE, that event will be processed normally.
SDL_EVENT_RESERVED2 Reserved for future use..
SDL_EVENT_RESERVED3 Reserved for future use..
SDL_EVENT_RESERVED4 Reserved for future use..
SDL_EVENT_RESERVED5 Reserved for future use..
SDL_EVENT_RESERVED6 Reserved for future use..
SDL_EVENT_RESERVED7 Reserved for future use..
SDL_EVENT_RESERVEDA Reserved for future use..
SDL_EVENT_RESERVEDB Reserved for future use..
SDL_FALSE
SDL_FULLSCREEN Full screen display surface.
SDL_GETEVENT If 'action' is SDL_GETEVENT, up to 'numevents' events at the front of the event queue, matching 'mask', will be returned and will be removed from the queue.
SDL_GL_ACCELERATED_VISUAL Public enumeration for setting the OpenGL window Attributes
SDL_GL_ACCUM_ALPHA_SIZE Size of the accumulation buffer alpha component, in bits. Public enumeration for setting the OpenGL window Attributes
SDL_GL_ACCUM_BLUE_SIZE Size of the accumulation buffer blue component, in bits. Public enumeration for setting the OpenGL window Attributes
SDL_GL_ACCUM_GREEN_SIZE Size of the accumulation buffer green component, in bits. Public enumeration for setting the OpenGL window Attributes
SDL_GL_ACCUM_RED_SIZE Size of the accumulation buffer red component, in bits. Public enumeration for setting the OpenGL window Attributes
SDL_GL_ALPHA_SIZE Size of the framebuffer alpha component, in bits Public enumeration for setting the OpenGL window Attributes
SDL_GL_BLUE_SIZE Size of the framebuffer blue component, in bits Public enumeration for setting the OpenGL window Attributes
SDL_GL_BUFFER_SIZE Size of the framebuffer, in bits Public enumeration for setting the OpenGL window Attributes
SDL_GL_DEPTH_SIZE Size of the depth buffer, in bits Public enumeration for setting the OpenGL window Attributes
SDL_GL_DOUBLEBUFFER 0 or 1, enable or disable double buffering Public enumeration for setting the OpenGL window Attributes
SDL_GL_GREEN_SIZE Size of the framebuffer green component, in bits Public enumeration for setting the OpenGL window Attributes
SDL_GL_MULTISAMPLEBUFFERS Public enumeration for setting the OpenGL window Attributes
SDL_GL_MULTISAMPLESAMPLES Public enumeration for setting the OpenGL window Attributes
SDL_GL_RED_SIZE Size of the framebuffer red component, in bits Public enumeration for setting the OpenGL window Attributes
SDL_GL_STENCIL_SIZE Size of the stencil buffer, in bits. Public enumeration for setting the OpenGL window Attributes
SDL_GL_STEREO Public enumeration for setting the OpenGL window Attributes
SDL_GL_SWAP_CONTROL Public enumeration for setting the OpenGL window Attributes
SDL_GRAB_FULLSCREEN Input grab state.
SDL_GRAB_OFF Input grab state.
SDL_GRAB_ON Input grab state.
SDL_GRAB_QUERY Input grab state.
SDL_HAT_CENTERED Indicates which position a joystick hat is pressed in
SDL_HAT_DOWN
SDL_HAT_LEFT
SDL_HAT_LEFTDOWN
SDL_HAT_LEFTUP
SDL_HAT_RIGHT
SDL_HAT_RIGHTDOWN
SDL_HAT_RIGHTUP
SDL_HAT_UP
SDL_HWACCEL Blit uses hardware acceleration
SDL_HWPALETTE Surface has exclusive palette
SDL_HWSURFACE Surface is in video memory
SDL_IGNORE If 'state' is set to SDL_IGNORE, that event will be automatically dropped from the event queue and will not event be filtered.
SDL_INIT_AUDIO The audio subsystem.
SDL_INIT_CDROM The CD-ROM subsystem.
SDL_INIT_EVENTTHREAD Not supported on all OS's.
SDL_INIT_EVERYTHING All subsystems. These are the flags which may be passed to SDL_Init() -- you should specify the subsystems which you will be using in your application..
SDL_INIT_JOYSTICK The joystick subsystem.
SDL_INIT_NOPARACHUTE Prevents SDL from catching fatal signals.
SDL_INIT_TIMER The timer subsystem.
SDL_INIT_VIDEO The video subsystem.
SDL_IYUV_OVERLAY One of the most common video overlay formats. For an explanation of these pixel formats, see: http://www.webartz.com/fourcc/indexyuv.htm For information on the relationship between color spaces, see: http://www.neuro.sfc.keio.ac.jp/~aly/polygon/info/color-space-faq.html Planar mode: Y + U + V (3 planes)
SDL_JOYAXISMOTION Joystick axis motion
SDL_JOYAXISMOTIONMASK
SDL_JOYBALLMOTION Joystick trackball motion
SDL_JOYBALLMOTIONMASK
SDL_JOYBUTTONDOWN Joystick button pressed
SDL_JOYBUTTONDOWNMASK
SDL_JOYBUTTONUP Joystick button released
SDL_JOYBUTTONUPMASK
SDL_JOYEVENTMASK
SDL_JOYHATMOTION Joystick hat position change
SDL_JOYHATMOTIONMASK
SDL_KEYDOWN Keys pressed
SDL_KEYDOWNMASK
SDL_KEYEVENTMASK
SDL_KEYUP Keys released
SDL_KEYUPMASK
SDL_LIL_ENDIAN Little Endian
SDL_LOGPAL Flag for SDL_SetPalette() which represents a logical palette, which controls how blits are mapped to/from the surface.
SDL_MAJOR_VERSION Major Version
SDL_MAX_TRACKS The maximum number of CD-ROM tracks on a disk
SDL_MINOR_VERSION Minor Version
SDL_MIX_MAXVOLUME Full audio volume
SDL_MOUSEBUTTONDOWN Mouse button pressed
SDL_MOUSEBUTTONDOWNMASK
SDL_MOUSEBUTTONUP Mouse button released
SDL_MOUSEBUTTONUPMASK
SDL_MOUSEEVENTMASK
SDL_MOUSEMOTION Mouse moved
SDL_MOUSEMOTIONMASK
SDL_MUTEX_MAXWAIT This is the timeout value which corresponds to never time out
SDL_MUTEX_TIMEDOUT Synchronization functions which can time out return this value if they time out.
SDL_NOEVENT Unused (do not remove)
SDL_NOFRAME No window caption or edge frame
SDL_NUMEVENTS This last event is only for bounding internal arrays It is the number of bits in the event mask datatype -- Uint32
SDL_OPENGL Create an OpenGL rendering context
SDL_OPENGLBLIT Create an OpenGL rendering context and use it for blitting
SDL_PATCHLEVEL Patch Version
SDL_PEEKEVENT If 'action' is SDL_PEEKEVENT, up to 'numevents' events at the front of the event queue, matching 'mask', will be returned and will not be removed from the queue.
SDL_PHYSPAL Flag for SDL_SetPalette() which represents a physical palette, which controls how pixels look on the screen.
SDL_PREALLOC Surface uses preallocated memory
SDL_PRESSED Button in pressed state.
SDL_QUERY If 'state' is set to SDL_QUERY, SDL_EventState() will return the current processing state of the specified event.
SDL_QUIT User-requested quit
SDL_QUITMASK
SDL_RELEASED Button in released state.
SDL_RESIZABLE This video mode may be resized
SDL_RLEACCEL Surface is RLE encoded
SDL_RLEACCELOK Private flag
SDL_SRCALPHA Blit uses source alpha blending
SDL_SRCCOLORKEY Blit uses a source color key
SDL_SWSURFACE Surface is in system memory
SDL_SYSWM_X11
SDL_SYSWMEVENT System specific event
SDL_SYSWMEVENTMASK
SDL_TIMESLICE The OS scheduler timeslice, in milliseconds.
SDL_TRUE
SDL_USEREVENT Events SDL_USEREVENT through SDL_MAXEVENTS-1 are for your use.
SDL_UYVY_OVERLAY One of the most common video overlay formats. For an explanation of these pixel formats, see: http://www.webartz.com/fourcc/indexyuv.htm For information on the relationship between color spaces, see: http://www.neuro.sfc.keio.ac.jp/~aly/polygon/info/color-space-faq.html Packed mode: U0+Y0+V0+Y1 (1 plane)
SDL_VIDEOEXPOSE Screen needs to be redrawn
SDL_VIDEOEXPOSEMASK
SDL_VIDEORESIZE User resized video mode
SDL_VIDEORESIZEMASK
SDL_YUY2_OVERLAY One of the most common video overlay formats. For an explanation of these pixel formats, see: http://www.webartz.com/fourcc/indexyuv.htm For information on the relationship between color spaces, see: http://www.neuro.sfc.keio.ac.jp/~aly/polygon/info/color-space-faq.html Packed mode: Y0+U0+Y1+V0 (1 plane)
SDL_YV12_OVERLAY One of the most common video overlay formats. For an explanation of these pixel formats, see: http://www.webartz.com/fourcc/indexyuv.htm For information on the relationship between color spaces, see: http://www.neuro.sfc.keio.ac.jp/~aly/polygon/info/color-space-faq.html Planar mode: Y + V + U (3 planes)
SDL_YVYU_OVERLAY One of the most common video overlay formats. For an explanation of these pixel formats, see: http://www.webartz.com/fourcc/indexyuv.htm For information on the relationship between color spaces, see: http://www.neuro.sfc.keio.ac.jp/~aly/polygon/info/color-space-faq.html Packed mode: Y0+V0+Y1+U0 (1 plane)
SDLK_0 0
SDLK_1 1
SDLK_2 2
SDLK_3 3
SDLK_4 4
SDLK_5 5
SDLK_6 6
SDLK_7 7
SDLK_8 8
SDLK_9 9
SDLK_a a
SDLK_AMPERSAND ampersand. '&'
SDLK_ASTERISK asterisk. '*'
SDLK_AT at. '@'
SDLK_b b
SDLK_BACKQUOTE grave. '`'
SDLK_BACKSLASH backslash. '\'
SDLK_BACKSPACE backspace. '\b'
SDLK_BREAK break
SDLK_c c
SDLK_CAPSLOCK capslock
SDLK_CARET caret. '^'
SDLK_CLEAR clear
SDLK_COLON colon. ':'
SDLK_COMMA comma. ';'
SDLK_COMPOSE Multi-key compose key
SDLK_d d
SDLK_DELETE delete. '^?'
SDLK_DOLLAR dollar. '$'
SDLK_DOWN down arrow
SDLK_e e
SDLK_END end
SDLK_EQUALS equals sign. '='
SDLK_ESCAPE escape. '^['
SDLK_EURO Some european keyboards
SDLK_EXCLAIM exclaim. '!'
SDLK_f f
SDLK_F1 F1
SDLK_F10 F10
SDLK_F11 F11
SDLK_F12 F12
SDLK_F13 F13
SDLK_F14 F14
SDLK_F15 F15
SDLK_F2 F2
SDLK_F3 F3
SDLK_F4 F4
SDLK_F5 F5
SDLK_F6 F6
SDLK_F7 F7
SDLK_F8 F8
SDLK_F9 F9
SDLK_FIRST
SDLK_g g
SDLK_GREATER greater-than sign. '>'
SDLK_h h
SDLK_HASH hash. '#'
SDLK_HELP help
SDLK_HOME home
SDLK_i i
SDLK_INSERT insert
SDLK_j j
SDLK_k k
SDLK_KP_DIVIDE keypad divide. '/'
SDLK_KP_ENTER keypad enter. '\r'
SDLK_KP_EQUALS keypad equals. '='
SDLK_KP_MINUS keypad minus. '-'
SDLK_KP_MULTIPLY keypad multiply. '*'
SDLK_KP_PERIOD keypad period. '.'
SDLK_KP_PLUS keypad plus. '+'
SDLK_KP0 keypad 0
SDLK_KP1 keypad 1
SDLK_KP2 keypad 2
SDLK_KP3 keypad 3
SDLK_KP4 keypad 4
SDLK_KP5 keypad 5
SDLK_KP6 keypad 6
SDLK_KP7 keypad 7
SDLK_KP8 keypad 8
SDLK_KP9 keypad 9
SDLK_l l
SDLK_LALT left alt
SDLK_LAST
SDLK_LCTRL left ctrl
SDLK_LEFT left arrow
SDLK_LEFTBRACKET left bracket. '['
SDLK_LEFTPAREN left parenthesis. '('
SDLK_LESS less-than sign. '<'
SDLK_LMETA left meta
SDLK_LSHIFT left shift
SDLK_LSUPER Left "Windows" key
SDLK_m m
SDLK_MENU menu
SDLK_MINUS minus sign. '-'
SDLK_MODE "Alt Gr" key. Mode key
SDLK_n n
SDLK_NUMLOCK numlock
SDLK_o o
SDLK_p p
SDLK_PAGEDOWN page down
SDLK_PAGEUP page up
SDLK_PAUSE pause
SDLK_PERIOD period. '.'
SDLK_PLUS plus sign. '+'
SDLK_POWER Power Macintosh power key
SDLK_PRINT print-screen
SDLK_q q
SDLK_QUESTION question mark. '?'
SDLK_QUOTE quote. '''
SDLK_QUOTEDBL quotedbl. '"'
SDLK_r r
SDLK_RALT right alt
SDLK_RCTRL right ctrl
SDLK_RETURN return. '\r'
SDLK_RIGHT right arrow
SDLK_RIGHTBRACKET right bracket. ']'
SDLK_RIGHTPAREN right parenthesis. ')'
SDLK_RMETA right meta
SDLK_RSHIFT right shift
SDLK_RSUPER Right "Windows" key
SDLK_s s
SDLK_SCROLLOCK scrollock
SDLK_SEMICOLON semicolon. ';'
SDLK_SLASH forward slash. '/'
SDLK_SPACE space. ' '
SDLK_SYSREQ SysRq
SDLK_t t
SDLK_TAB tab. '\t'
SDLK_u u
SDLK_UNDERSCORE underscore.'_'
SDLK_UNDO Atari keyboard has Undo
SDLK_UNKNOWN
SDLK_UP up arrow
SDLK_v v
SDLK_w w
SDLK_WORLD_0 0xA0
SDLK_WORLD_1
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_2
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_3
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_4
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_5
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_6
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_7
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_8
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_9
SDLK_WORLD_90
SDLK_WORLD_91
SDLK_WORLD_92
SDLK_WORLD_93
SDLK_WORLD_94
SDLK_WORLD_95 0xFF
SDLK_x x
SDLK_y y
SDLK_z z
TIMER_RESOLUTION The maximum resolution of the SDL timer on all platforms.

See Also

Sdl Class | Tao.Sdl Namespace