Section 3: library functions
SDL_keysym – Keysym structure Structure Definitiontypedef struct{ Uint8 scancode; SDLKey sym; SDLMod mod; Uint16 unicode; } SDL_keysym;Structure Datascancode Hardware specific scancode sym SDL virtual keysym mod Current key modifiers unicode Translated characterDescriptionThe SDL_keysym structure is used by reporting key presses and releases since it is a part of the SDL_KeyboardEvent. The scancode field should generally…
SDL_WasInit – Check which subsystems are initialized Synopsis#include "SDL.h" Uint32 SDL_WasInit(Uint32 flags); DescriptionSDL_WasInit 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). Return ValueSDL_WasInit returns a bitwised OR’d combination of the initialized subsystems….
SDL_WarpMouse – Set the position of the mouse cursor. Synopsis#include "SDL.h" void SDL_WarpMouse(Uint16 x, Uint16 y); DescriptionSet the position of the mouse cursor (generates a mouse motion event). See AlsoSDL_MouseMotionEvent
SDL_WaitThread – Wait for a thread to finish. Synopsis#include "SDL.h" #include "SDL_thread.h" void SDL_WaitThread(SDL_Thread *thread, int *status); DescriptionWait for a thread to finish (timeouts are not supported). Return ValueThe return code for the thread function is placed in the area pointed to by status, if status is not NULL. See AlsoSDL_CreateThread
SDL_WaitEvent – Waits indefinitely for the next available event. Synopsis#include "SDL.h" int SDL_WaitEvent(SDL_Event *event); DescriptionWaits indefinitely for the next available event, returning 1, or 0 if there was an error while waiting for events. If event is not NULL, the next event is removed from the queue and stored in that area. See AlsoSDL_Event, SDL_PollEvent
SDL_WM_ToggleFullScreen – Toggles fullscreen mode Synopsis#include "SDL.h" int SDL_WM_ToggleFullScreen(SDL_Surface *surface); DescriptionToggles the application between windowed and fullscreen mode, if supported. (X11 is the only target currently supported, BeOS support is experimental). Return ValueReturns 0 on failure or 1 on success.
SDL_WM_SetIcon – Sets the icon for the display window. Synopsis#include "SDL.h" void SDL_WM_SetIcon(SDL_Surface *icon, Uint8 *mask); DescriptionSets the icon for the display window. Win32 icons must be 32×32. This function must be called before the first call to SDL_SetVideoMode. It takes an icon surface, and a mask in MSB format. If mask is NULL, the…
SDL_WM_SetCaption – Sets the window tile and icon name. Synopsis#include "SDL.h" void SDL_WM_SetCaption(const char *title, const char *icon); DescriptionSets the title-bar and icon name of the display window. See AlsoSDL_WM_GetCaption, SDL_WM_SetIcon
SDL_WM_IconifyWindow – Iconify/Minimise the window Synopsis#include "SDL.h" int SDL_WM_IconifyWindow(void); DescriptionIf the application is running in a window managed environment SDL attempts to iconify/minimise it. If SDL_WM_IconifyWindow is successful, the application will receive a SDL_APPACTIVE loss event. Return ValueReturns non-zero on success or 0 if iconification is not support or was refused by the window manager.
SDL_WM_GrabInput – Grabs mouse and keyboard input. Synopsis#include "SDL.h" SDL_GrabMode SDL_WM_GrabInput(SDL_GrabMode mode); DescriptionGrabbing means that the mouse is confined to the application window, and nearly all keyboard input is passed directly to the application, and not interpreted by a window manager, if any. When mode is SDL_GRAB_QUERY the grab mode is not changed, but the…
SDL_WM_GetCaption – Gets the window title and icon name. Synopsis#include "SDL.h" void SDL_WM_GetCaption(char **title, char **icon); DescriptionSet pointers to the window title and icon name. See AlsoSDL_WM_SetCaption, SDL_WM_SetIcon
SDL_VideoModeOK – Check to see if a particular video mode is supported. Synopsis#include "SDL.h" int SDL_VideoModeOK(int width, int height, int bpp, Uint32 flags); DescriptionSDL_VideoModeOK returns 0 if the requested mode is not supported under any bit depth, or returns the bits-per-pixel of the closest available mode with the given width, height and requested surface flags…
SDL_VideoInfo – Video Target information Structure Definitiontypedef struct{ Uint32 hw_available:1; Uint32 wm_available:1; Uint32 blit_hw:1; Uint32 blit_hw_CC:1; Uint32 blit_hw_A:1; Uint32 blit_sw:1; Uint32 blit_sw_CC:1; Uint32 blit_sw_A:1; Uint32 blit_fill; Uint32 video_mem; SDL_PixelFormat *vfmt; } SDL_VideoInfo;Structure Datahw_available Is it possible to create hardware surfaces? wm_available Is there a window manager available blit_hw Are hardware to hardware blits accelerated? blit_hw_CC…
SDL_VideoDriverName – Obtain the name of the video driver Synopsis#include "SDL.h" char *SDL_VideoDriverName(char *namebuf, int maxlen); DescriptionThe buffer pointed to by namebuf is filled up to a maximum of maxlen characters (include the NULL terminator) with the name of the initialised video driver. The driver name is a simple one word identifier like "x11" or…
SDL_UserEvent – A user-defined event type Structure Definitiontypedef struct{ Uint8 type; int code; void *data1; void *data2; } SDL_UserEvent;Structure Datatype SDL_USEREVENT through to SDL_NUMEVENTS-1 code User defined event code data1 User defined data pointer data2 User defined data pointerDescriptionSDL_UserEvent is in the user member of the structure SDL_Event. This event is unique, it is never…
SDL_UpdateRects – Makes sure the given list of rectangles is updated on the given screen. Synopsis#include "SDL.h" void SDL_UpdateRects(SDL_Surface *screen, int numrects, SDL_Rect *rects); DescriptionMakes sure the given list of rectangles is updated on the given screen. The rectangles must all be confined within the screen boundaries (no clipping is done). This function should not…
SDL_UpdateRect – Makes sure the given area is updated on the given screen. Synopsis#include "SDL.h" void SDL_UpdateRect(SDL_Surface *screen, Sint32 x, Sint32 y, Sint32 w, Sint32 h); DescriptionMakes sure the given area is updated on the given screen. The rectangle must be confined within the screen boundaries (no clipping is done). If ‘x‘, ‘y‘, ‘w‘ and…
SDL_UnlockYUVOverlay – Unlock an overlay Synopsis#include "SDL.h" void SDL_UnlockYUVOverlay(SDL_Overlay *overlay); DescriptionThe opposite to SDL_LockYUVOverlay. Unlocks a previously locked overlay. An overlay must be unlocked before it can be displayed. See AlsoSDL_UnlockYUVOverlay, SDL_CreateYUVOverlay, SDL_Overlay
SDL_UnlockSurface – Unlocks a previously locked surface. Synopsis#include "SDL.h" void SDL_UnlockSurface(SDL_Surface *surface); DescriptionSurfaces that were previously locked using SDL_LockSurface must be unlocked with SDL_UnlockSurface. Surfaces should be unlocked as soon as possible. It should be noted that since 1.1.8, surface locks are recursive. See SDL_LockSurface. See AlsoSDL_LockSurface
SDL_UnlockAudio – Unlock the callback function Synopsis#include "SDL.h" void SDL_UnlockAudio(void) DescriptionUnlocks a previous SDL_LockAudio call. See AlsoSDL_OpenAudio