Section 3: library functions
SDL_WM_IconifyWindow – Iconify/Minimise the window Synopsis #include "SDL.h" int SDL_WM_IconifyWindow(void); Description If 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 Value Returns non-zero on success or 0 if iconification is not support or was refused by…
SDL_WM_GrabInput – Grabs mouse and keyboard input. Synopsis #include "SDL.h" SDL_GrabMode SDL_WM_GrabInput(SDL_GrabMode mode); Description Grabbing 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,…
SDL_WM_GetCaption – Gets the window title and icon name. Synopsis #include "SDL.h" void SDL_WM_GetCaption(char **title, char **icon); Description Set pointers to the window title and icon name. See Also SDL_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); Description SDL_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…
SDL_VideoInfo – Video Target information Structure Definition typedef 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 Data hw_available Is it possible to create hardware surfaces? wm_available Is there a window manager available blit_hw Are hardware to hardware…
SDL_VideoDriverName – Obtain the name of the video driver Synopsis #include "SDL.h" char *SDL_VideoDriverName(char *namebuf, int maxlen); Description The 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…
SDL_UserEvent – A user-defined event type Structure Definition typedef struct{ Uint8 type; int code; void *data1; void *data2; } SDL_UserEvent; Structure Data type SDL_USEREVENT through to SDL_NUMEVENTS-1 code User defined event code data1 User defined data pointer data2 User defined data pointer Description SDL_UserEvent is in the user member of the structure SDL_Event. This event…
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); Description Makes 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…
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); Description Makes 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‘,…
SDL_UnlockYUVOverlay – Unlock an overlay Synopsis #include "SDL.h" void SDL_UnlockYUVOverlay(SDL_Overlay *overlay); Description The opposite to SDL_LockYUVOverlay. Unlocks a previously locked overlay. An overlay must be unlocked before it can be displayed. See Also SDL_UnlockYUVOverlay, SDL_CreateYUVOverlay, SDL_Overlay
SDL_UnlockSurface – Unlocks a previously locked surface. Synopsis #include "SDL.h" void SDL_UnlockSurface(SDL_Surface *surface); Description Surfaces 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 Also SDL_LockSurface
SDL_UnlockAudio – Unlock the callback function Synopsis #include "SDL.h" void SDL_UnlockAudio(void) Description Unlocks a previous SDL_LockAudio call. See Also SDL_OpenAudio
SDL_ThreadID – Get the 32-bit thread identifier for the current thread. Synopsis #include "SDL.h" #include "SDL_thread.h" Uint32 SDL_ThreadID(void) Description Get the 32-bit thread identifier for the current thread.
SDL_SysWMEvent – Platform-dependent window manager event. Description The system window manager event contains a pointer to system-specific information about unknown window manager events. If you enable this event using SDL_EventState(), it will be generated whenever unhandled events are received from the window manager. This can be used, for example, to implement cut-and-paste in your application….
SDL_Surface – Graphical Surface Structure Structure Definition typedef struct SDL_Surface { Uint32 flags; /* Read-only */ SDL_PixelFormat *format; /* Read-only */ int w, h; /* Read-only */ Uint16 pitch; /* Read-only */ void *pixels; /* Read-write */ /* clipping information */ SDL_Rect clip_rect; /* Read-only */ /* Reference count — used when freeing surface */…
SDL_ShowCursor – Toggle whether or not the cursor is shown on the screen. Synopsis #include "SDL.h" int SDL_ShowCursor(int toggle); Description Toggle whether or not the cursor is shown on the screen. Passing SDL_ENABLE displays the cursor and passing SDL_DISABLE hides it. The current state of the mouse cursor can be queried by passing SDL_QUERY, either…
SDL_SetVideoMode – Set up a video mode with the specified width, height and bits-per-pixel. Synopsis #include "SDL.h" SDL_Surface *SDL_SetVideoMode(int width, int height, int bpp, Uint32 flags); Description Set up a video mode with the specified width, height and bits-per-pixel. If bpp is 0, it is treated as the current display bits per pixel. The flags…
SDL_SetTimer – Set a callback to run after the specified number of milliseconds has elapsed. Synopsis #include "SDL.h" int SDL_SetTimer(Uint32 interval, SDL_TimerCallback callback); Callback /* Function prototype for the timer callback function */ typedef Uint32 (*SDL_TimerCallback)(Uint32 interval); Description Set a callback to run after the specified number of milliseconds has elapsed. The callback function is…
SDL_SetPalette – Sets the colors in the palette of an 8-bit surface. Synopsis #include "SDL.h" int SDL_SetPalette(SDL_Surface *surface, int flags, SDL_Color *colors, int firstcolor, int ncolors); Description Sets a portion of the palette for the given 8-bit surface. Palettized (8-bit) screen surfaces with the SDL_HWPALETTE flag have two palettes, a logical palette that is used…
SDL_SetModState – Set the current key modifier state Synopsis #include "SDL.h" void SDL_SetModState(SDLMod modstate); Description The inverse of SDL_GetModState, SDL_SetModState allows you to impose modifier key states on your application. Simply pass your desired modifier states into modstate. This value my be a logical OR’d combination of the following: typedef enum { KMOD_NONE = 0x0000,…