Section 3: library functions
SDL_LockAudio – Lock out the callback function Synopsis#include "SDL.h" void SDL_LockAudio(void) DescriptionThe lock manipulated by these functions protects the callback function. During a LockAudio period, you can be guaranteed that the callback function is not running. Do not call these from the callback function or you will cause deadlock. See AlsoSDL_OpenAudio
SDL_LoadWAV – Load a WAVE file Synopsis#include "SDL.h" SDL_AudioSpec *SDL_LoadWAV(const char *file, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len); DescriptionSDL_LoadWAV This function loads a WAVE file into memory. If this function succeeds, it returns the given SDL_AudioSpec, filled with the audio data format of the wave data, and sets audio_buf to a malloc‘d buffer containing the…
SDL_LoadBMP – Load a Windows BMP file into an SDL_Surface. Synopsis#include "SDL.h" SDL_Surface *SDL_LoadBMP(const char *file); DescriptionLoads a surface from a named Windows BMP file. Return ValueReturns the new surface, or NULL if there was an error. See AlsoSDL_SaveBMP
SDL_ListModes – Returns a pointer to an array of available screen dimensions for the given format and video flags Synopsis#include "SDL.h" SDL_Rect **SDL_ListModes(SDL_PixelFormat *format, Uint32 flags); DescriptionReturn a pointer to an array of available screen dimensions for the given format and video flags, sorted largest to smallest. Returns NULL if there are no dimensions available…
SDL_KillThread – Gracelessly terminates the thread. Synopsis#include "SDL.h" #include "SDL_thread.h" void SDL_KillThread(SDL_Thread *thread); DescriptionSDL_KillThread gracelessly terminates the thread associated with thread. If possible, you should use some other form of IPC to signal the thread to quit. See AlsoSDL_CreateThread, SDL_WaitThread
SDL_KeyboardEvent – Keyboard event structure Structure Definitiontypedef struct{ Uint8 type; Uint8 state; SDL_keysym keysym; } SDL_KeyboardEvent;Structure Datatype SDL_KEYDOWN or SDL_KEYUP state SDL_PRESSED or SDL_RELEASED keysym Contains key press informationDescriptionSDL_KeyboardEvent is a member of the SDL_Event union and is used when an event of type SDL_KEYDOWN or SDL_KEYUP is reported. The type and state actually report…
SDL_JoystickUpdate – Updates the state of all joysticks Synopsis#include "SDL.h" void SDL_JoystickUpdate(void); DescriptionUpdates the state(position, buttons, etc.) of all open joysticks. If joystick events have been enabled with SDL_JoystickEventState then this is called automatically in the event loop. See AlsoSDL_JoystickEventState
SDL_JoystickOpened – Determine if a joystick has been opened Synopsis#include "SDL.h" int SDL_JoystickOpened(int index); DescriptionDetermines whether a joystick has already been opened within the application. index refers to the N’th joystick on the system. Return ValueReturns 1 if the joystick has been opened, or 0 if it has not. See AlsoSDL_JoystickOpen, SDL_JoystickClose
SDL_JoystickOpen – Opens a joystick for use. Synopsis#include "SDL.h" SDL_Joystick *SDL_JoystickOpen(int index); DescriptionOpens a joystick for use within SDL. The index refers to the N’th joystick in the system. A joystick must be opened before it game be used. Return ValueReturns a SDL_Joystick structure on success. NULL on failure. ExamplesSDL_Joystick *joy; // Check for joystick…
SDL_JoystickNumHats – Get the number of joystick hats Synopsis#include "SDL.h" int SDL_JoystickNumHats(SDL_Joystick *joystick); DescriptionReturn the number of hats available from a previously opened SDL_Joystick. Return ValueNumber of hats. See AlsoSDL_JoystickGetHat, SDL_JoystickOpen
SDL_JoystickNumButtons – Get the number of joysitck buttons Synopsis#include "SDL.h" int SDL_JoystickNumButtons(SDL_Joystick *joystick); DescriptionReturn the number of buttons available from a previously opened SDL_Joystick. Return ValueNumber of buttons. See AlsoSDL_JoystickGetButton, SDL_JoystickOpen
SDL_JoystickNumBalls – Get the number of joystick trackballs Synopsis#include "SDL.h" int SDL_JoystickNumBalls(SDL_Joystick *joystick); DescriptionReturn the number of trackballs available from a previously opened SDL_Joystick. Return ValueNumber of trackballs. See AlsoSDL_JoystickGetBall, SDL_JoystickOpen
SDL_JoystickNumAxes – Get the number of joystick axes Synopsis#include "SDL.h" int SDL_JoystickNumAxes(SDL_Joystick *joystick); DescriptionReturn the number of axes available from a previously opened SDL_Joystick. Return ValueNumber of axes. See AlsoSDL_JoystickGetAxis, SDL_JoystickOpen
SDL_JoystickName – Get joystick name. Synopsis#include "SDL.h" const char *SDL_JoystickName(int index); DescriptionGet the implementation dependent name of joystick. The index parameter refers to the N’th joystick on the system. Return ValueReturns a char pointer to the joystick name. Examples/* Print the names of all attached joysticks */ int num_joy, i; num_joy=SDL_NumJoysticks(); printf("%d joysticks found ",…
SDL_JoystickIndex – Get the index of an SDL_Joystick. Synopsis#include "SDL.h" int SDL_JoystickIndex(SDL_Joystick *joystick); DescriptionReturns the index of a given SDL_Joystick structure. Return ValueIndex number of the joystick. See AlsoSDL_JoystickOpen
SDL_JoystickGetHat – Get the current state of a joystick hat Synopsis#include "SDL.h" Uint8 SDL_JoystickGetHat(SDL_Joystick *joystick, int hat); DescriptionSDL_JoystickGetHat returns the current state of the given hat on the given joystick. Return ValueThe current state is returned as a Uint8 which is defined as an OR’d combination of one or more of the following SDL_HAT_CENTERED SDL_HAT_UP…
SDL_JoystickGetButton – Get the current state of a given button on a given joystick Synopsis#include "SDL.h" Uint8 SDL_JoystickGetButton(SDL_Joystick *joystick, int button); DescriptionSDL_JoystickGetButton returns the current state of the given button on the given joystick. Return Value1 if the button is pressed. Otherwise, 0. See AlsoSDL_JoystickNumButtons
SDL_JoystickGetBall – Get relative trackball motion Synopsis#include "SDL.h" int SDL_JoystickGetBall(SDL_Joystick *joystick, int ball, int *dx, int *dy); DescriptionGet the ball axis change. Trackballs can only return relative motion since the last call to SDL_JoystickGetBall, these motion deltas a placed into dx and dy. Return ValueReturns 0 on success or -1 on failure Examplesint delta_x, delta_y;…
SDL_JoystickGetAxis – Get the current state of an axis Synopsis#include "SDL.h" Sint16 SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis); DescriptionSDL_JoystickGetAxis returns the current state of the given axis on the given joystick. On most modern joysticks the X axis is usually represented by axis 0 and the Y axis by axis 1. The value returned by SDL_JoystickGetAxis is…
SDL_JoystickEventState – Enable/disable joystick event polling Synopsis#include "SDL.h" int SDL_JoystickEventState(int state); DescriptionThis function is used to enable or disable joystick event processing. With joystick event processing disabled you will have to update joystick states with SDL_JoystickUpdate and read the joystick information manually. state is either SDL_QUERY, SDL_ENABLE or SDL_IGNORE. Note: Joystick event handling is prefered…