SDL_LockSurface – Lock a surface for directly access. Synopsis #include "SDL.h" int SDL_LockSurface(SDL_Surface *surface); Description SDL_LockSurface sets up a surface for directly accessing the pixels. Between calls to SDL_LockSurface and SDL_UnlockSurface, you can write to and read from surface->pixels, using the pixel format stored in surface->format. Once you are done accessing the surface, you should…
SDL_LockAudio – Lock out the callback function Synopsis #include "SDL.h" void SDL_LockAudio(void) Description The 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 Also SDL_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); Description SDL_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…
SDL_LoadBMP – Load a Windows BMP file into an SDL_Surface. Synopsis #include "SDL.h" SDL_Surface *SDL_LoadBMP(const char *file); Description Loads a surface from a named Windows BMP file. Return Value Returns the new surface, or NULL if there was an error. See Also SDL_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); Description Return 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…
SDL_KillThread – Gracelessly terminates the thread. Synopsis #include "SDL.h" #include "SDL_thread.h" void SDL_KillThread(SDL_Thread *thread); Description SDL_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 Also SDL_CreateThread, SDL_WaitThread
SDL_KeyboardEvent – Keyboard event structure Structure Definition typedef struct{ Uint8 type; Uint8 state; SDL_keysym keysym; } SDL_KeyboardEvent; Structure Data type SDL_KEYDOWN or SDL_KEYUP state SDL_PRESSED or SDL_RELEASED keysym Contains key press information Description SDL_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…
SDL_JoystickUpdate – Updates the state of all joysticks Synopsis #include "SDL.h" void SDL_JoystickUpdate(void); Description Updates 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 Also SDL_JoystickEventState
SDL_JoystickOpened – Determine if a joystick has been opened Synopsis #include "SDL.h" int SDL_JoystickOpened(int index); Description Determines whether a joystick has already been opened within the application. index refers to the N’th joystick on the system. Return Value Returns 1 if the joystick has been opened, or 0 if it has not. See Also SDL_JoystickOpen,…
SDL_JoystickOpen – Opens a joystick for use. Synopsis #include "SDL.h" SDL_Joystick *SDL_JoystickOpen(int index); Description Opens 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 Value Returns a SDL_Joystick structure on success. NULL on failure. Examples SDL_Joystick *joy;…
SDL_JoystickNumHats – Get the number of joystick hats Synopsis #include "SDL.h" int SDL_JoystickNumHats(SDL_Joystick *joystick); Description Return the number of hats available from a previously opened SDL_Joystick. Return Value Number of hats. See Also SDL_JoystickGetHat, SDL_JoystickOpen
SDL_JoystickNumButtons – Get the number of joysitck buttons Synopsis #include "SDL.h" int SDL_JoystickNumButtons(SDL_Joystick *joystick); Description Return the number of buttons available from a previously opened SDL_Joystick. Return Value Number of buttons. See Also SDL_JoystickGetButton, SDL_JoystickOpen
SDL_JoystickNumBalls – Get the number of joystick trackballs Synopsis #include "SDL.h" int SDL_JoystickNumBalls(SDL_Joystick *joystick); Description Return the number of trackballs available from a previously opened SDL_Joystick. Return Value Number of trackballs. See Also SDL_JoystickGetBall, SDL_JoystickOpen
SDL_JoystickNumAxes – Get the number of joystick axes Synopsis #include "SDL.h" int SDL_JoystickNumAxes(SDL_Joystick *joystick); Description Return the number of axes available from a previously opened SDL_Joystick. Return Value Number of axes. See Also SDL_JoystickGetAxis, SDL_JoystickOpen
SDL_JoystickName – Get joystick name. Synopsis #include "SDL.h" const char *SDL_JoystickName(int index); Description Get the implementation dependent name of joystick. The index parameter refers to the N’th joystick on the system. Return Value Returns a char pointer to the joystick name. Examples /* Print the names of all attached joysticks */ int num_joy, i; num_joy=SDL_NumJoysticks();…
SDL_JoystickIndex – Get the index of an SDL_Joystick. Synopsis #include "SDL.h" int SDL_JoystickIndex(SDL_Joystick *joystick); Description Returns the index of a given SDL_Joystick structure. Return Value Index number of the joystick. See Also SDL_JoystickOpen
SDL_JoystickGetHat – Get the current state of a joystick hat Synopsis #include "SDL.h" Uint8 SDL_JoystickGetHat(SDL_Joystick *joystick, int hat); Description SDL_JoystickGetHat returns the current state of the given hat on the given joystick. Return Value The current state is returned as a Uint8 which is defined as an OR’d combination of one or more of the…
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); Description SDL_JoystickGetButton returns the current state of the given button on the given joystick. Return Value 1 if the button is pressed. Otherwise, 0. See Also SDL_JoystickNumButtons
SDL_JoystickGetBall – Get relative trackball motion Synopsis #include "SDL.h" int SDL_JoystickGetBall(SDL_Joystick *joystick, int ball, int *dx, int *dy); Description Get 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 Value Returns 0 on success or -1 on failure…
SDL_JoystickGetAxis – Get the current state of an axis Synopsis #include "SDL.h" Sint16 SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis); Description SDL_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…