Section 3: library functions
SDL_GLattr – SDL GL Attributes Attributes SDL_GL_RED_SIZE Size of the framebuffer red component, in bits SDL_GL_GREEN_SIZE Size of the framebuffer green component, in bits SDL_GL_BLUE_SIZE Size of the framebuffer blue component, in bits SDL_GL_ALPHA_SIZE Size of the framebuffer alpha component, in bits SDL_GL_DOUBLEBUFFER 0 or 1, enable or disable double buffering SDL_GL_BUFFER_SIZE Size of the…
SDL_GL_SwapBuffers – Swap OpenGL framebuffers/Update Display Synopsis #include "SDL.h" void SDL_GL_SwapBuffers(void ); Description Swap the OpenGL buffers, if double-buffering is supported. See Also SDL_SetVideoMode, SDL_GL_SetAttribute
SDL_GL_SetAttribute – Set a special SDL/OpenGL attribute Synopsis #include "SDL.h" int SDL_GL_SetAttribute(SDL_GLattr attr, int value); Description Sets the OpenGL attribute attr to value. The attributes you set don’t take effect until after a call to SDL_SetVideoMode. You should use SDL_GL_GetAttribute to check the values after a SDL_SetVideoMode call. Return Value Returns 0 on success, or…
SDL_GL_LoadLibrary – Specify an OpenGL library Synopsis #include "SDL.h" int SDL_GL_LoadLibrary(const char *path); Description If you wish, you may load the OpenGL library at runtime, this must be done before SDL_SetVideoMode is called. The path of the GL library is passed to SDL_GL_LoadLibrary and it returns 0 on success, or -1 on an error. You…
SDL_GL_GetProcAddress – Get the address of a GL function Synopsis #include "SDL.h" void *SDL_GL_GetProcAddress(const char* proc); Description Returns the address of the GL function proc, or NULL if the function is not found. If the GL library is loaded at runtime, with SDL_GL_LoadLibrary, then all GL functions must be retrieved this way. Usually this is…
SDL_GL_GetAttribute – Get the value of a special SDL/OpenGL attribute Synopsis #include "SDL.h" int SDL_GL_GetAttribute(SDLGLattr attr, int *value); Description Places the value of the SDL/OpenGL attribute attr into value. This is useful after a call to SDL_SetVideoMode to check whether your attributes have been set as you expected. Return Value Returns 0 on success, or…
SDL_FreeYUVOverlay – Free a YUV video overlay Synopsis #include "SDL.h" void SDL_FreeYUVOverlay(SDL_Overlay *overlay); Description Frees and overlay created by SDL_CreateYUVOverlay. See Also SDL_Overlay, SDL_DisplayYUVOverlay, SDL_FreeYUVOverlay
SDL_FreeWAV – Frees previously opened WAV data Synopsis #include "SDL.h" void SDL_FreeWAV(Uint8 *audio_buf); Description After a WAVE file has been opened with SDL_LoadWAV its data can eventually be freed with SDL_FreeWAV. audio_buf is a pointer to the buffer created by SDL_LoadWAV. See Also SDL_LoadWAV
SDL_FreeSurface – Frees (deletes) a SDL_Surface Synopsis #include "SDL.h" void SDL_FreeSurface(SDL_Surface *surface); Description Frees the resources used by a previously created SDL_Surface. If the surface was created using SDL_CreateRGBSurfaceFrom then the pixel data is not freed. See Also SDL_CreateRGBSurface SDL_CreateRGBSurfaceFrom
SDL_FreeCursor – Frees a cursor created with SDL_CreateCursor. Synopsis #include "SDL.h" void SDL_FreeCursor(SDL_Cursor *cursor); Description Frees a SDL_Cursor that was created using SDL_CreateCursor. See Also SDL_CreateCursor
SDL_Flip – Swaps screen buffers Synopsis #include "SDL.h" int SDL_Flip(SDL_Surface *screen); Description On hardware that supports double-buffering, this function sets up a flip and returns. The hardware will wait for vertical retrace, and then swap video buffers before the next video surface blit or lock will return. On hardware that doesn’t support double-buffering, this is…
SDL_FillRect – This function performs a fast fill of the given rectangle with some color Synopsis #include "SDL.h" int SDL_FillRect(SDL_Surface *dst, SDL_Rect *dstrect, Uint32 color); Description This function performs a fast fill of the given rectangle with color. If dstrect is NULL, the whole surface will be filled with color. The color should be a…
SDL_ExposeEvent – Quit requested event Structure Definition typedef struct{ Uint8 type } SDL_ExposeEvent; Structure Data type SDL_VIDEOEXPOSE Description SDL_ExposeEvent is a member of the SDL_Event union and is used whan an event of type SDL_VIDEOEXPOSE is reported. A VIDEOEXPOSE event is triggered when the screen has been modified outside of the application, usually by the…
SDL_EventState – This function allows you to set the state of processing certain events. Synopsis #include "SDL.h" Uint8 SDL_EventState(Uint8 type, int state); Description This function allows you to set the state of processing certain event type‘s. If state is set to SDL_IGNORE, that event type will be automatically dropped from the event queue and will…
SDL_Event – General event structure Structure Definition typedef union{ Uint8 type; SDL_ActiveEvent active; SDL_KeyboardEvent key; SDL_MouseMotionEvent motion; SDL_MouseButtonEvent button; SDL_JoyAxisEvent jaxis; SDL_JoyBallEvent jball; SDL_JoyHatEvent jhat; SDL_JoyButtonEvent jbutton; SDL_ResizeEvent resize; SDL_ExposeEvent expose; SDL_QuitEvent quit; SDL_UserEvent user; SDL_SysWMEvent syswm; } SDL_Event; Structure Data type The type of event active Activation event key Keyboard event motion Mouse motion…
SDL_EnableUNICODE – Enable UNICODE translation Synopsis #include "SDL.h" int SDL_EnableUNICODE(int enable); Description Enables/Disables Unicode keyboard translation. To obtain the character codes corresponding to received keyboard events, Unicode translation must first be turned on using this function. The translation incurs a slight overhead for each keyboard event and is therefore disabled by default. For each subsequently…
SDL_CreateThread – Creates a new thread of execution that shares its parent’s properties. Synopsis #include "SDL.h" #include "SDL_thread.h" SDL_Thread *SDL_CreateThread(int (*fn)(void *), void *data); Description SDL_CreateThread creates a new thread of execution that shares all of its parent’s global memory, signal handlers, file descriptors, etc, and runs the function fn passed the void pointer data…
SDL_CreateSemaphore – Creates a new semaphore and assigns an initial value to it. Synopsis #include "SDL.h" #include "SDL_thread.h" SDL_sem *SDL_CreateSemaphore(Uint32 initial_value); Description SDL_CreateSemaphore() creates a new semaphore and initializes it with the value initial_value. Each locking operation on the semaphore by SDL_SemWait, SDL_SemTryWait or SDL_SemWaitTimeout will atomically decrement the semaphore value. The locking operation will…
SDL_CreateRGBSurfaceFrom – Create an SDL_Surface from pixel data Synopsis #include "SDL.h" SDL_Surface *SDL_CreateRGBSurfaceFrom(void *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask); Description Creates an SDL_Surface from the provided pixel data. The data stored in pixels is assumed to be of the depth specified in the parameter…
SDL_CreateRGBSurface – Create an empty SDL_Surface Synopsis #include "SDL.h" SDL_Surface *SDL_CreateRGBSurface(Uint32 flags, int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask); Description Allocate an empty surface (must be called after SDL_SetVideoMode) If depth is 8 bits an empty palette is allocated for the surface, otherwise a ‘packed-pixel’ SDL_PixelFormat is created…