From 3eab7a5d32317188eadeb8c78df2696f12384f1b Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Tue, 10 Feb 2004 15:15:40 +0000 Subject: [PATCH] Updated SDL HTML documentation --- docs/html/audio.html | 40 +- docs/html/cdrom.html | 40 +- docs/html/event.html | 22 +- docs/html/eventfunctions.html | 52 +- docs/html/eventstructures.html | 46 +- docs/html/general.html | 31 +- docs/html/guide.html | 9 +- docs/html/guideaboutsdldoc.html | 14 +- docs/html/guideaudioexamples.html | 22 +- docs/html/guidebasicsinit.html | 16 +- docs/html/guidecdromexamples.html | 30 +- docs/html/guidecredits.html | 14 +- docs/html/guideeventexamples.html | 18 +- docs/html/guideexamples.html | 18 +- docs/html/guideinput.html | 40 +- docs/html/guideinputkeyboard.html | 53 +- docs/html/guidepreface.html | 18 +- docs/html/guidethebasics.html | 18 +- docs/html/guidetimeexamples.html | 18 +- docs/html/guidevideo.html | 34 +- docs/html/guidevideoexamples.html | 473 --------- docs/html/guidevideoopengl.html | 27 +- docs/html/index.html | 289 +++--- docs/html/joystick.html | 49 +- docs/html/reference.html | 9 +- docs/html/sdlactiveevent.html | 26 +- docs/html/sdladdtimer.html | 28 +- docs/html/sdlaudiocvt.html | 26 +- docs/html/sdlaudiospec.html | 28 +- docs/html/sdlblitsurface.html | 67 +- docs/html/sdlbuildaudiocvt.html | 28 +- docs/html/sdlcd.html | 28 +- docs/html/sdlcdclose.html | 24 +- docs/html/sdlcdeject.html | 26 +- docs/html/sdlcdname.html | 26 +- docs/html/sdlcdnumdrives.html | 24 +- docs/html/sdlcdopen.html | 26 +- docs/html/sdlcdpause.html | 26 +- docs/html/sdlcdplay.html | 26 +- docs/html/sdlcdplaytracks.html | 28 +- docs/html/sdlcdresume.html | 26 +- docs/html/sdlcdstatus.html | 26 +- docs/html/sdlcdstop.html | 26 +- docs/html/sdlcdtrack.html | 26 +- docs/html/sdlcloseaudio.html | 24 +- docs/html/sdlcolor.html | 26 +- docs/html/sdlcondbroadcast.html | 24 +- docs/html/sdlcondsignal.html | 24 +- docs/html/sdlcondwait.html | 24 +- docs/html/sdlcondwaittimeout.html | 24 +- docs/html/sdlconvertaudio.html | 34 +- docs/html/sdlconvertsurface.html | 26 +- docs/html/sdlcreatecond.html | 26 +- docs/html/sdlcreatecursor.html | 30 +- docs/html/sdlcreatemutex.html | 26 +- docs/html/sdlcreatergbsurface.html | 30 +- docs/html/sdlcreatergbsurfacefrom.html | 26 +- docs/html/sdlcreatesemaphore.html | 28 +- docs/html/sdlcreatethread.html | 24 +- docs/html/sdlcreateyuvoverlay.html | 24 +- docs/html/sdldelay.html | 34 +- docs/html/sdldestroycond.html | 24 +- docs/html/sdldestroymutex.html | 24 +- docs/html/sdldestroysemaphore.html | 26 +- docs/html/sdldisplayformat.html | 26 +- docs/html/sdldisplayformatalpha.html | 26 +- docs/html/sdldisplayyuvoverlay.html | 26 +- docs/html/sdlenablekeyrepeat.html | 24 +- docs/html/sdlenableunicode.html | 26 +- docs/html/sdlenvvars.html | 1212 +++++++++++++++++++++++ docs/html/sdlevent.html | 40 +- docs/html/sdleventstate.html | 24 +- docs/html/sdlexposeevent.html | 26 +- docs/html/sdlfillrect.html | 26 +- docs/html/sdlflip.html | 26 +- docs/html/sdlfreecursor.html | 24 +- docs/html/sdlfreesurface.html | 24 +- docs/html/sdlfreewav.html | 24 +- docs/html/sdlfreeyuvoverlay.html | 24 +- docs/html/sdlgetappstate.html | 26 +- docs/html/sdlgetaudiostatus.html | 24 +- docs/html/sdlgetcliprect.html | 24 +- docs/html/sdlgetcursor.html | 24 +- docs/html/sdlgeterror.html | 24 +- docs/html/sdlgeteventfilter.html | 26 +- docs/html/sdlgetgammaramp.html | 26 +- docs/html/sdlgetkeyname.html | 24 +- docs/html/sdlgetkeystate.html | 26 +- docs/html/sdlgetmodstate.html | 30 +- docs/html/sdlgetmousestate.html | 26 +- docs/html/sdlgetrelativemousestate.html | 24 +- docs/html/sdlgetrgb.html | 24 +- docs/html/sdlgetrgba.html | 24 +- docs/html/sdlgetthreadid.html | 24 +- docs/html/sdlgetticks.html | 24 +- docs/html/sdlgetvideoinfo.html | 24 +- docs/html/sdlgetvideosurface.html | 24 +- docs/html/sdlglattr.html | 29 +- docs/html/sdlglgetattribute.html | 26 +- docs/html/sdlglgetprocaddress.html | 31 +- docs/html/sdlglloadlibrary.html | 24 +- docs/html/sdlglsetattribute.html | 28 +- docs/html/sdlglswapbuffers.html | 24 +- docs/html/sdlinit.html | 14 +- docs/html/sdlinitsubsystem.html | 14 +- docs/html/sdljoyaxisevent.html | 26 +- docs/html/sdljoyballevent.html | 26 +- docs/html/sdljoybuttonevent.html | 26 +- docs/html/sdljoyhatevent.html | 26 +- docs/html/sdljoystickclose.html | 24 +- docs/html/sdljoystickeventstate.html | 26 +- docs/html/sdljoystickgetaxis.html | 28 +- docs/html/sdljoystickgetball.html | 28 +- docs/html/sdljoystickgetbutton.html | 26 +- docs/html/sdljoystickgethat.html | 26 +- docs/html/sdljoystickindex.html | 26 +- docs/html/sdljoystickname.html | 28 +- docs/html/sdljoysticknumaxes.html | 26 +- docs/html/sdljoysticknumballs.html | 26 +- docs/html/sdljoysticknumbuttons.html | 26 +- docs/html/sdljoysticknumhats.html | 26 +- docs/html/sdljoystickopen.html | 28 +- docs/html/sdljoystickopened.html | 26 +- docs/html/sdljoystickupdate.html | 24 +- docs/html/sdlkey.html | 20 +- docs/html/sdlkeyboardevent.html | 26 +- docs/html/sdlkeysym.html | 26 +- docs/html/sdlkillthread.html | 24 +- docs/html/sdllistmodes.html | 28 +- docs/html/sdlloadbmp.html | 26 +- docs/html/sdlloadwav.html | 26 +- docs/html/sdllockaudio.html | 24 +- docs/html/sdllocksurface.html | 26 +- docs/html/sdllockyuvoverlay.html | 26 +- docs/html/sdlmaprgb.html | 26 +- docs/html/sdlmaprgba.html | 26 +- docs/html/sdlmixaudio.html | 24 +- docs/html/sdlmousebuttonevent.html | 26 +- docs/html/sdlmousemotionevent.html | 26 +- docs/html/sdlmutexp.html | 24 +- docs/html/sdlmutexv.html | 24 +- docs/html/sdlnumjoysticks.html | 26 +- docs/html/sdlopenaudio.html | 32 +- docs/html/sdloverlay.html | 26 +- docs/html/sdlpalette.html | 26 +- docs/html/sdlpauseaudio.html | 24 +- docs/html/sdlpeepevents.html | 43 +- docs/html/sdlpixelformat.html | 26 +- docs/html/sdlpollevent.html | 26 +- docs/html/sdlpumpevents.html | 26 +- docs/html/sdlpushevent.html | 28 +- docs/html/sdlquit.html | 14 +- docs/html/sdlquitevent.html | 26 +- docs/html/sdlquitsubsystem.html | 14 +- docs/html/sdlrect.html | 26 +- docs/html/sdlremovetimer.html | 28 +- docs/html/sdlresizeevent.html | 26 +- docs/html/sdlsavebmp.html | 26 +- docs/html/sdlsempost.html | 28 +- docs/html/sdlsemtrywait.html | 34 +- docs/html/sdlsemvalue.html | 28 +- docs/html/sdlsemwait.html | 28 +- docs/html/sdlsemwaittimeout.html | 32 +- docs/html/sdlsetalpha.html | 28 +- docs/html/sdlsetcliprect.html | 24 +- docs/html/sdlsetcolorkey.html | 26 +- docs/html/sdlsetcolors.html | 28 +- docs/html/sdlsetcursor.html | 24 +- docs/html/sdlseteventfilter.html | 27 +- docs/html/sdlsetgamma.html | 26 +- docs/html/sdlsetgammaramp.html | 26 +- docs/html/sdlsetmodstate.html | 24 +- docs/html/sdlsetpalette.html | 28 +- docs/html/sdlsettimer.html | 24 +- docs/html/sdlsetvideomode.html | 38 +- docs/html/sdlshowcursor.html | 26 +- docs/html/sdlsurface.html | 28 +- docs/html/sdlsyswmevent.html | 25 +- docs/html/sdlthreadid.html | 22 +- docs/html/sdlunlockaudio.html | 24 +- docs/html/sdlunlocksurface.html | 24 +- docs/html/sdlunlockyuvoverlay.html | 24 +- docs/html/sdlupdaterect.html | 24 +- docs/html/sdlupdaterects.html | 24 +- docs/html/sdluserevent.html | 28 +- docs/html/sdlvideodrivername.html | 26 +- docs/html/sdlvideoinfo.html | 26 +- docs/html/sdlvideomodeok.html | 26 +- docs/html/sdlwaitevent.html | 24 +- docs/html/sdlwaitthread.html | 26 +- docs/html/sdlwarpmouse.html | 24 +- docs/html/sdlwasinit.html | 14 +- docs/html/sdlwmgetcaption.html | 24 +- docs/html/sdlwmgrabinput.html | 24 +- docs/html/sdlwmiconifywindow.html | 24 +- docs/html/sdlwmsetcaption.html | 24 +- docs/html/sdlwmseticon.html | 52 +- docs/html/sdlwmtogglefullscreen.html | 24 +- docs/html/thread.html | 58 +- docs/html/time.html | 24 +- docs/html/video.html | 140 +-- docs/html/wm.html | 26 +- 202 files changed, 4882 insertions(+), 2480 deletions(-) delete mode 100644 docs/html/guidevideoexamples.html create mode 100644 docs/html/sdlenvvars.html diff --git a/docs/html/audio.html b/docs/html/audio.html index ed70e21d6..94075e2cb 100644 --- a/docs/html/audio.html +++ b/docs/html/audio.html @@ -4,7 +4,7 @@ >Audio
Prev

Chapter 10. Audio

Chapter 10. Audio
SDL_AudioSpec — Audio Specification Structure -- Audio Specification Structure
SDL_OpenAudio — Opens the audio device with the desired parameters.
 -- Opens the audio device with the desired parameters.
SDL_PauseAudio — Pauses and unpauses the audio callback processing
 -- Pauses and unpauses the audio callback processing
SDL_GetAudioStatus — Get the current audio state
 -- Get the current audio state
SDL_LoadWAV — Load a WAVE file
 -- Load a WAVE file
SDL_FreeWAV — Frees previously opened WAV data
 -- Frees previously opened WAV data
SDL_AudioCVT — Audio Conversion Structure
 -- Audio Conversion Structure
SDL_BuildAudioCVT — Initializes a SDL_AudioCVT structure for conversion
 -- Initializes a SDL_AudioCVT structure for conversion
SDL_ConvertAudio — Convert audio data to a desired audio format.
 -- Convert audio data to a desired audio format.
SDL_MixAudio — Mix audio data
 -- Mix audio data
SDL_LockAudio — Lock out the callback function
 -- Lock out the callback function
SDL_UnlockAudio — Unlock the callback function
 -- Unlock the callback function
SDL_CloseAudio — Shuts down audio processing and closes the audio device.
 -- Shuts down audio processing and closes the audio device.

Next
PrevUp
HomeNext
CD-ROM
Prev

Chapter 11. CD-ROM

Chapter 11. CD-ROM
SDL_CDNumDrives — Returns the number of CD-ROM drives on the system. -- Returns the number of CD-ROM drives on the system.
SDL_CDName — Returns a human-readable, system-dependent identifier for the CD-ROM.
 -- Returns a human-readable, system-dependent identifier for the CD-ROM.
SDL_CDOpen — Opens a CD-ROM drive for access.
 -- Opens a CD-ROM drive for access.
SDL_CDStatus — Returns the current status of the given drive.
 -- Returns the current status of the given drive.
SDL_CDPlay — Play a CD
 -- Play a CD
SDL_CDPlayTracks — Play the given CD track(s)
 -- Play the given CD track(s)
SDL_CDPause — Pauses a CDROM
 -- Pauses a CDROM
SDL_CDResume — Resumes a CDROM
 -- Resumes a CDROM
SDL_CDStop — Stops a CDROM
 -- Stops a CDROM
SDL_CDEject — Ejects a CDROM
 -- Ejects a CDROM
SDL_CDClose — Closes a SDL_CD handle
 -- Closes a SDL_CD handle
SDL_CD — CDROM Drive Information
 -- CDROM Drive Information
SDL_CDtrack — CD Track Information Structure
 -- CD Track Information Structure

Next
PrevUp
HomeNext
Events
Prev

Chapter 8. Events

Chapter 8. Events
Introduction

Introduction

Introduction

Event handling allows your application to receive input from the user. Event handling is initalised (along with video) with a call to:

Next
PrevUp
HomeNext
Event Functions.
PrevEvent Functions.Event Functions.
SDL_PumpEvents — Pumps the event loop, gathering events from the input devices. -- Pumps the event loop, gathering events from the input devices.
SDL_PeepEvents — Checks the event queue for messages and optionally returns them.
 -- Checks the event queue for messages and optionally returns them.
SDL_PollEvent — Polls for currently pending events.
 -- Polls for currently pending events.
SDL_WaitEvent — Waits indefinitely for the next available event.
 -- Waits indefinitely for the next available event.
SDL_PushEvent — Pushes an event onto the event queue
 -- Pushes an event onto the event queue
SDL_SetEventFilter — Sets up a filter to process all events before they are posted +> -- Sets up a filter to process all events before they are posted to the event queue.
SDL_GetEventFilter — Retrieves a pointer to he event filter
 -- Retrieves a pointer to he event filter
SDL_EventState — This function allows you to set the state of processing certain events.
 -- This function allows you to set the state of processing certain events.
SDL_GetKeyState — Get a snapshot of the current keyboard state
 -- Get a snapshot of the current keyboard state
SDL_GetModState — Get the state of modifier keys.
 -- Get the state of modifier keys.
SDL_SetModState — Set the current key modifier state
 -- Set the current key modifier state
SDL_GetKeyName — Get the name of an SDL virtual keysym
 -- Get the name of an SDL virtual keysym
SDL_EnableUNICODE — Enable UNICODE translation
 -- Enable UNICODE translation
SDL_EnableKeyRepeat — Set keyboard repeat rate.
 -- Set keyboard repeat rate.
SDL_GetMouseState — Retrieve the current state of the mouse
 -- Retrieve the current state of the mouse
SDL_GetRelativeMouseState — Retrieve the current state of the mouse
 -- Retrieve the current state of the mouse
SDL_GetAppState — Get the state of the application
 -- Get the state of the application
SDL_JoystickEventState — Enable/disable joystick event polling
 -- Enable/disable joystick event polling

Next
PrevUp
HomeNext
SDL Event Structures.
PrevSDL Event Structures.SDL Event Structures.
SDL_Event — General event structure -- General event structure
SDL_ActiveEvent — Application visibility event structure
 -- Application visibility event structure
SDL_KeyboardEvent — Keyboard event structure
 -- Keyboard event structure
SDL_MouseMotionEvent — Mouse motion event structure
 -- Mouse motion event structure
SDL_MouseButtonEvent — Mouse button event structure
 -- Mouse button event structure
SDL_JoyAxisEvent — Joystick axis motion event structure
 -- Joystick axis motion event structure
SDL_JoyButtonEvent — Joystick button event structure
 -- Joystick button event structure
SDL_JoyHatEvent — Joystick hat position change event structure
 -- Joystick hat position change event structure
SDL_JoyBallEvent — Joystick trackball motion event structure
 -- Joystick trackball motion event structure
SDL_ResizeEvent — Window resize event structure
 -- Window resize event structure
SDL_ExposeEvent — Quit requested event
 -- Quit requested event
SDL_SysWMEvent — Platform-dependent window manager event.
 -- Platform-dependent window manager event.
SDL_UserEvent — A user-defined event type
 -- A user-defined event type
SDL_QuitEvent — Quit requested event
 -- Quit requested event
SDL_keysym — Keysym structure
 -- Keysym structure
SDLKey — Keysym definitions.
 -- Keysym definitions.
Next
PrevUp
HomeNext
General
Prev

Chapter 5. General

Chapter 5. General
SDL_Init — Initializes SDL -- Initializes SDL
SDL_InitSubSystem — Initialize subsystems
 -- Initialize subsystems
SDL_QuitSubSystem — Shut down a subsystem
 -- Shut down a subsystem
SDL_Quit — Shut down SDL
 -- Shut down SDL
SDL_WasInit — Check which subsystems are initialized
 -- Check which subsystems are initialized
SDL_GetError — Get SDL error string
 -- Get SDL error string
SDL_envvars -- SDL environment variables

Next
PrevUp
HomeNext
SDL Guide
Prev
Next
PrevAbout SDLdoc
HomeNext
PrevAbout SDLdocAbout SDLdoc

SDLdoc (The SDL Documentation Project) was formed to completely rewrite the SDL documentation and to keep it continually up to date. The team consists completely of volunteers ranging from people working with SDL in their spare time to people who use SDL in their everyday working lives.

Next
PrevUp
HomeNext
Audio Examples
PrevAudio ExamplesAudio Examples

Opening the audio deviceOpening the audio device

Playing audioPlaying audio
Next
PrevUp
HomeNext
Initializing SDL
PrevInitializing SDLInitializing SDL

SDL is composed of eight subsystems - Audio, CDROM, Event Handling, File I/O, Joystick Handling, Threading, Timers and Video. Before you can use any of these subsystems they must be initialized by calling #include "SDL.h" /* All SDL App's need this */ #include <stdio.h> -int main() { +int main(int argc, char *argv[]) { printf("Initializing SDL.\n"); @@ -175,6 +178,7 @@ >

Next
PrevUp
HomeNext
CDROM Examples
PrevCDROM ExamplesCDROM Examples

Listing CD-ROM drivesListing CD-ROM drives

Opening the default driveOpening the default drive
Listing the tracks on a CDListing the tracks on a CD
Play an entire CDPlay an entire CD
Next
PrevUp
HomeNext
Credits
PrevCreditsCredits

Next
PrevUp
HomeNext
Event Examples
PrevEvent ExamplesEvent Examples

Filtering and Handling EventsFiltering and Handling Events

Next
PrevUp
HomeNext
Examples
Prev

Chapter 4. Examples

Chapter 4. Examples
IntroductionIntroduction

For the moment these examples are taken directly from the old SDL documentation. By the 1.2 release these examples should hopefully deal with most common SDL programming problems.

Next
PrevUp
HomeNext
Input handling
Prev

Chapter 3. Input handling

Chapter 3. Input handling
Handling JoysticksHandling Joysticks

Initialization

Initialization

The first step in using a joystick in a SDL program is to initialize the Joystick subsystems of SDL. This done by passing the QueryingQuerying

If we have reached this point then we can safely assume that the SDL library has been initialized and that the Joystick subsystem is active. We can now call some video and/or sound functions to get things going before we need the joystick. Eventually we have to make sure that there is actually a joystick to work with. It's wise to always check even if you know a joystick will be present on the system because it can also help detect when the joystick is unplugged. The function used to check for joysticks is Opening a Joystick and Receiving Joystick EventsOpening a Joystick and Receiving Joystick Events

SDL's event driven architecture makes working with joysticks a snap. Joysticks can trigger 4 different types of events:

Advanced Joystick FunctionsAdvanced Joystick Functions

That takes care of the controls that you can count on being on every joystick under the sun, but there are a few extra things that SDL can support. Joyballs are next on our list, they are alot like axis with a few minor differences. Joyballs store relative changes unlike the the absolute postion stored in a axis event. Also one trackball event contains both the change in x and they change in y. Our case for it is as follows:

    case SDL_JOYHATMOTION:  /* Handle Hat Motion */
-    if ( event.jhat.hat & SDL_HAT_UP )
+    if ( event.jhat.value & SDL_HAT_UP )
     {
         /* Do up stuff here */
     }
 
-    if ( event.jhat.hat & SDL_HAT_LEFT )
+    if ( event.jhat.value & SDL_HAT_LEFT )
     {
         /* Do left stuff here */
     }
 
-    if ( event.jhat.hat & SDL_HAT_RIGHTDOWN )
+    if ( event.jhat.value & SDL_HAT_RIGHTDOWN )
     {
         /* Do right and down together stuff here */
     }
@@ -674,6 +677,7 @@
 >
Next
PrevUp
HomeNext
Handling the Keyboard
PrevHandling the KeyboardHandling the Keyboard

Keyboard Related Structures

Keyboard Related Structures

It should make it a lot easier to understand this tutorial is you are familiar with the data types involved in keyboard access, so I'll explain them first.

SDLKeySDLKey

SDLModSDLMod

SDLMod is an enumerated type, similar to SDL_keysymSDL_keysym

typedef struct{
@@ -216,8 +219,8 @@
 CLASS="SECT3"
 >SDL_KeyboardEventSDL_KeyboardEvent
typedef struct{
@@ -284,8 +287,8 @@
 CLASS="SECT2"
 >Reading Keyboard EventsReading Keyboard Events
Reading keybaord events from the event queue is quite simple (the event queue and using it is described A More Detailed LookA More Detailed Look
Before we can read events SDL must be initialised with Game-type InputGame-type Input
I have found that people using keyboard events for games and other interactive applications don't always understand one fundemental point.
Keyboard events Keyboard events only take place when a keys state changes from being unpressed to pressed, and vice versa.
Imagine you have an image of an alien that you wish to move around using the cursor keys - when you pressed the left arrow key you want him to slide over to the left, when you press the down key you want him to slide down the screen. Examine the following code, it highlights and error that many people have made.
+>Imagine you have an image of an alien that you wish to move around using the cursor keys: when you pressed the left arrow key you want him to slide over to the left, and when you press the down key you want him to slide down the screen. Examine the following code; it highlights an error that many people have made.
 
    /* Alien screen coordinates */
@@ -678,6 +684,7 @@
 >
Next
PrevUp
HomeNext
Preface
Prev

Preface

Preface
About SDLAbout SDL

The SDL library is designed to make it easy to write games that run on Linux, *BSD, MacOS, Win32 and BeOS using the various native high-performance media interfaces, (for video, audio, etc) and presenting a single source-code level API to your application. SDL is a fairly low level API, but using it, completely portable applications can be written with a great deal of flexibility.

Next
PrevUp
HomeNext
The Basics
Prev

Chapter 1. The Basics

Chapter 1. The Basics
IntroductionIntroduction

The SDL Guide section is pretty incomplete. If you feel you have anything to add mail akawaka@skynet.ie or visit http://akawaka.csn.ul.ie/tne/.

Next
PrevUp
HomeNext
Time Examples
PrevTime ExamplesTime Examples

Time based game loopTime based game loop

Next
PrevUp
HomeNext
Graphics and Video
Prev

Chapter 2. Graphics and Video

Chapter 2. Graphics and Video
Introduction to SDL VideoIntroduction to SDL Video

Video is probably the most common thing that SDL is used for, and so it has the most complete subsystem. Here are a few @@ -109,8 +112,8 @@ CLASS="SECT2" >Initializing the Video DisplayInitializing the Video Display

This is what almost all SDL programs have to do in one way or another.

Initializing the Best Video ModeInitializing the Best Video Mode

If you have a preference for a certain pixel depth but will accept any other, use SDL_SetVideoMode with SDL_ANYFORMAT as below. You can also @@ -190,8 +193,8 @@ CLASS="SECT2" >Loading and Displaying a BMP FileLoading and Displaying a BMP File

The following function loads and displays a BMP file given as argument, once SDL is initialised and a video mode has been set.

Drawing Directly to the DisplayDrawing Directly to the Display

The following two functions can be used to get and set single pixels of a surface. They are carefully written to work with any depth @@ -398,6 +401,7 @@ >

Next
PrevUp
HomeNext
Video Examples
SDL Library Documentation
PrevChapter 4. ExamplesNext

Video Examples

Initializing the video display

    SDL_Surface *screen;
-
-    /* Initialize the SDL library */
-    if( SDL_Init(SDL_INIT_VIDEO) < 0 ) {
-        fprintf(stderr,
-                "Couldn't initialize SDL: %s\n", SDL_GetError());
-        exit(1);
-    }
-
-    /* Clean up on exit */
-    atexit(SDL_Quit);
-
-    /* Initialize the display in a 640x480 8-bit palettized mode */
-    screen = SDL_SetVideoMode(640, 480, 8, SDL_SWSURFACE);
-    if ( screen == NULL ) {
-        fprintf(stderr, "Couldn't set 640x480x8 video mode: %s\n",
-                        SDL_GetError());
-        exit(1);
-    }

Initializing the best video mode

    /* Have a preference for 8-bit, but accept any depth */
-    screen = SDL_SetVideoMode(640, 480, 8, SDL_SWSURFACE|SDL_ANYFORMAT);
-    if ( screen == NULL ) {
-        fprintf(stderr, "Couldn't set 640x480x8 video mode: %s\n",
-                        SDL_GetError());
-        exit(1);
-    }
-    printf("Set 640x480 at %d bits-per-pixel mode\n",
-           screen->format->BitsPerPixel);

Loading and displaying a BMP file

    SDL_Surface *image;
-    SDL_Rect dest;
-    int ncolors, i;
-    SDL_Color *colors;
-
-    /* Load the BMP file into a surface */
-    image = SDL_LoadBMP("sample.bmp");
-    if ( image == NULL ) {
-        fprintf(stderr, "Couldn't load sample.bmp: %s\n",
-                        SDL_GetError());
-        return;
-    }
-
-    /* Set the display colors -- SDL_SetColors() only does something on
-       palettized displays, but it doesn't hurt anything on HiColor or
-       TrueColor displays.
-       If the display colors have already been set, this step can be
-       skipped, and the library will automatically map the image to
-       the current display colors.
-    */
-    if ( image->format->palette ) {
-        ncolors = image->format->palette->ncolors;
-        colors  = (SDL_Color *)malloc(ncolors*sizeof(SDL_Color));
-        memcpy(colors, image->format->palette->colors, ncolors);
-    } 
-    else {
-        int r, g, b;
-
-        /* Allocate 256 color palette */
-        ncolors = 256;
-        colors  = (SDL_Color *)malloc(ncolors*sizeof(SDL_Color));
-
-        /* Set a 3,3,2 color cube */
-        for ( r=0; r<8; ++r ) {
-            for ( g=0; g<8; ++g ) {
-                for ( b=0; b<4; ++b ) {
-                    i = ((r<<5)|(g<<2)|b);
-                    colors[i].r = r<<5;
-                    colors[i].g = g<<5;
-                    colors[i].b = b<<6;
-                }
-            }
-        }
-        /* Note: A better way of allocating the palette might be
-           to calculate the frequency of colors in the image
-           and create a palette based on that information.
-        */
-    }
-    /* Set colormap, try for all the colors, but don't worry about it */
-    SDL_SetColors(screen, colors, 0, ncolors);
-    free(colors);
-
-    /* Blit onto the screen surface */
-    dest.x = 0;
-    dest.y = 0;
-    dest.w = image->w;
-    dest.h = image->h;
-    SDL_BlitSurface(image, NULL, screen, &dest);
-
-    SDL_UpdateRects(screen, 1, &dest);
-
-    /* Free the allocated BMP surface */
-    SDL_FreeSurface(image);
-    return;

Drawing directly to the display

    /* Code to set a yellow pixel at the center of the screen */
-
-    Sint32   X, Y;
-    Uint32   pixel;
-    Uint8   *bits, bpp;
-
-    /* Map the color yellow to this display (R=0xFF, G=0xFF, B=0x00)
-       Note:  If the display is palettized, you must set the palette first.
-    */
-    pixel = SDL_MapRGB(screen->format, 0xFF, 0xFF, 0x00);
-
-    /* Calculate the framebuffer offset of the center of the screen */
-    if ( SDL_MUSTLOCK(screen) ) {
-        if ( SDL_LockSurface(screen) < 0 )
-            return;
-    }
-    bpp = screen->format->BytesPerPixel;
-    X = screen->w/2;
-    Y = screen->h/2;
-    bits = ((Uint8 *)screen->pixels)+Y*screen->pitch+X*bpp;
-
-    /* Set the pixel */
-    switch(bpp) {
-        case 1:
-            *((Uint8 *)(bits)) = (Uint8)pixel;
-            break;
-        case 2:
-            *((Uint16 *)(bits)) = (Uint16)pixel;
-            break;
-        case 3: { /* Format/endian independent */
-            Uint8 r, g, b;
-
-            r = (pixel>>screen->format->Rshift)&0xFF;
-            g = (pixel>>screen->format->Gshift)&0xFF;
-            b = (pixel>>screen->format->Bshift)&0xFF;
-            *((bits)+screen->format->Rshift/8) = r; 
-            *((bits)+screen->format->Gshift/8) = g;
-            *((bits)+screen->format->Bshift/8) = b;
-            }
-            break;
-        case 4:
-            *((Uint32 *)(bits)) = (Uint32)pixel;
-            break;
-    }
-
-    /* Update the display */
-    if ( SDL_MUSTLOCK(screen) ) {
-        SDL_UnlockSurface(screen);
-    }
-    SDL_UpdateRect(screen, X, Y, 1, 1);
-
-    return;

Fastest possible surface blit

There are three different ways you can draw an image to the screen: -

1.Create a surface and use SDL_BlitSurface to blit it to the screen
2.Create the video surface in system memory and call SDL_UpdateRect
3.Create the video surface in video memory and call SDL_LockSurface

-The best way to do this is to combine methods: -
#include <stdio.h>
-#include <stdlib.h>
-#include "SDL.h"
-#include "SDL_timer.h"
-
-void ComplainAndExit(void)
-{
-    fprintf(stderr, "Problem: %s\n", SDL_GetError());
-    exit(1);
-}
-
-int main(int argc, char *argv[])
-{
-    SDL_PixelFormat fmt;
-    SDL_Surface *screen, *locked;
-    SDL_Surface *imagebmp, *image;
-    SDL_Rect dstrect;
-    int i;
-    Uint8 *buffer;
-
-    /* Initialize SDL */
-    if ( SDL_Init(SDL_INIT_VIDEO) < 0 ) {
-        ComplainAndExit();
-    }
-    atexit(SDL_Quit);
-
-    /* Load a BMP image into a surface */
-    imagebmp = SDL_LoadBMP("image.bmp");
-    if ( imagebmp == NULL ) {
-        ComplainAndExit();
-    }
-
-    /* Set the video mode (640x480 at native depth) */
-    screen = SDL_SetVideoMode(640, 480, 0, SDL_HWSURFACE|SDL_FULLSCREEN);
-    if ( screen == NULL ) {
-        ComplainAndExit();
-    }
-
-    /* Set the video colormap */
-    if ( imagebmp->format->palette != NULL ) {
-        SDL_SetColors(screen,
-                      imagebmp->format->palette->colors, 0,
-                      imagebmp->format->palette->ncolors);
-    }
-
-    /* Convert the image to the video format (maps colors) */
-    image = SDL_DisplayFormat(imagebmp);
-    SDL_FreeSurface(imagebmp);
-    if ( image == NULL ) {
-        ComplainAndExit();
-    }
-
-    /* Draw bands of color on the raw surface */
-    if ( SDL_MUSTLOCK(screen) ) {
-        if ( SDL_LockSurface(screen) < 0 )
-            ComplainAndExit();
-    }
-    buffer=(Uint8 *)screen->pixels;
-    for ( i=0; i<screen->h; ++i ) {
-        memset(buffer,(i*255)/screen->h,
-               screen->w*screen->format->BytesPerPixel);
-               buffer += screen->pitch;
-    }
-    if ( SDL_MUSTLOCK(screen) ) {
-        SDL_UnlockSurface(screen);
-    }
-
-    /* Blit the image to the center of the screen */
-    dstrect.x = (screen->w-image->w)/2;
-    dstrect.y = (screen->h-image->h)/2;
-    dstrect.w = image->w;
-    dstrect.h = image->h;
-    if ( SDL_BlitSurface(image, NULL, screen, &dstrect) < 0 ) {
-        SDL_FreeSurface(image);
-        ComplainAndExit();
-    }
-    SDL_FreeSurface(image);
-
-    /* Update the screen */
-    SDL_UpdateRects(screen, 1, &dstrect);
-
-    SDL_Delay(5000);        /* Wait 5 seconds */
-    exit(0);
-}

PrevHomeNext
ExamplesUpEvent Examples
\ No newline at end of file diff --git a/docs/html/guidevideoopengl.html b/docs/html/guidevideoopengl.html index 76be8e2a2..c3d464bb4 100644 --- a/docs/html/guidevideoopengl.html +++ b/docs/html/guidevideoopengl.html @@ -4,7 +4,7 @@ >Using OpenGL With SDL
PrevUsing OpenGL With SDLUsing OpenGL With SDL

SDL has the ability to create and use OpenGL contexts on several platforms(Linux/X11, Win32, BeOS, MacOS Classic/Toolbox, MacOS X, FreeBSD/X11 and Solaris/X11). This allows you to use SDL's audio, event handling, threads and times in your OpenGL applications (a function often performed by GLUT).

InitialisationInitialisation

Initialising SDL to use OpenGL is not very different to initialising SDL normally. There are three differences; you must pass SDL_GL_SetAttribute and finally, if you wish to use double buffering you must specify it as a GL attribute, and finally, if you wish to use double buffering you must specify it as a GL attribute, not by passing the SDL_DOUBLEBUFDrawingDrawing

Apart from initialisation, using OpenGL within SDL is the same as using OpenGL with any other API, e.g. GLUT. You still use all the same function calls and @@ -662,6 +668,7 @@ >

Next
PrevUp
HomeNext
SDL_Init — Initializes SDL -- Initializes SDL
SDL_InitSubSystem — Initialize subsystems
 -- Initialize subsystems
SDL_QuitSubSystem — Shut down a subsystem
 -- Shut down a subsystem
SDL_Quit — Shut down SDL
 -- Shut down SDL
SDL_WasInit — Check which subsystems are initialized
 -- Check which subsystems are initialized
SDL_GetError — Get SDL error string
 -- Get SDL error string
SDL_envvars -- SDL environment variables
SDL_GetVideoSurface — returns a pointer to the current display surface
 -- returns a pointer to the current display surface
SDL_GetVideoInfo — returns a pointer to information about the video hardware
 -- returns a pointer to information about the video hardware
SDL_VideoDriverName — Obtain the name of the video driver
 -- Obtain the name of the video driver
SDL_ListModes — Returns a pointer to an array of available screen dimensions for +> -- Returns a pointer to an array of available screen dimensions for the given format and video flags
SDL_VideoModeOK — Check to see if a particular video mode is supported.
 -- Check to see if a particular video mode is supported.
SDL_SetVideoMode — Set up a video mode with the specified width, height and bits-per-pixel.
 -- Set up a video mode with the specified width, height and bits-per-pixel.
SDL_UpdateRect — Makes sure the given area is updated on the given screen.
 -- Makes sure the given area is updated on the given screen.
SDL_UpdateRects — Makes sure the given list of rectangles is updated on the given screen.
 -- Makes sure the given list of rectangles is updated on the given screen.
SDL_Flip — Swaps screen buffers
 -- Swaps screen buffers
SDL_SetColors — Sets a portion of the colormap for the given 8-bit surface.
 -- Sets a portion of the colormap for the given 8-bit surface.
SDL_SetPalette — Sets the colors in the palette of an 8-bit surface.
 -- Sets the colors in the palette of an 8-bit surface.
SDL_SetGamma — Sets the color gamma function for the display
 -- Sets the color gamma function for the display
SDL_GetGammaRamp — Gets the color gamma lookup tables for the display
 -- Gets the color gamma lookup tables for the display
SDL_SetGammaRamp — Sets the color gamma lookup tables for the display
 -- Sets the color gamma lookup tables for the display
SDL_MapRGB — Map a RGB color value to a pixel format.
 -- Map a RGB color value to a pixel format.
SDL_MapRGBA — Map a RGBA color value to a pixel format.
 -- Map a RGBA color value to a pixel format.
SDL_GetRGB — Get RGB values from a pixel in the specified pixel format.
 -- Get RGB values from a pixel in the specified pixel format.
SDL_GetRGBA — Get RGBA values from a pixel in the specified pixel format.
 -- Get RGBA values from a pixel in the specified pixel format.
SDL_CreateRGBSurface — Create an empty SDL_Surface
 -- Create an empty SDL_Surface
SDL_CreateRGBSurfaceFrom — Create an SDL_Surface from pixel data
 -- Create an SDL_Surface from pixel data
SDL_FreeSurface — Frees (deletes) a SDL_Surface
 -- Frees (deletes) a SDL_Surface
SDL_LockSurface — Lock a surface for directly access.
 -- Lock a surface for directly access.
SDL_UnlockSurface — Unlocks a previously locked surface.
 -- Unlocks a previously locked surface.
SDL_LoadBMP — Load a Windows BMP file into an SDL_Surface.
 -- Load a Windows BMP file into an SDL_Surface.
SDL_SaveBMP — Save an SDL_Surface as a Windows BMP file.
 -- Save an SDL_Surface as a Windows BMP file.
SDL_SetColorKey — Sets the color key (transparent pixel) in a blittable surface and +> -- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration.
SDL_SetAlpha — Adjust the alpha properties of a surface
 -- Adjust the alpha properties of a surface
SDL_SetClipRect — Sets the clipping rectangle for a surface.
 -- Sets the clipping rectangle for a surface.
SDL_GetClipRect — Gets the clipping rectangle for a surface.
 -- Gets the clipping rectangle for a surface.
SDL_ConvertSurface — Converts a surface to the same format as another surface.
 -- Converts a surface to the same format as another surface.
SDL_BlitSurface — This performs a fast blit from the source surface to the destination surface.
 -- This performs a fast blit from the source surface to the destination surface.
SDL_FillRect — This function performs a fast fill of the given rectangle with some color
 -- This function performs a fast fill of the given rectangle with some color
SDL_DisplayFormat — Convert a surface to the display format
 -- Convert a surface to the display format
SDL_DisplayFormatAlpha — Convert a surface to the display format
 -- Convert a surface to the display format
SDL_WarpMouse — Set the position of the mouse cursor.
 -- Set the position of the mouse cursor.
SDL_CreateCursor — Creates a new mouse cursor.
 -- Creates a new mouse cursor.
SDL_FreeCursor — Frees a cursor created with SDL_CreateCursor.
 -- Frees a cursor created with SDL_CreateCursor.
SDL_SetCursor — Set the currently active mouse cursor.
 -- Set the currently active mouse cursor.
SDL_GetCursor — Get the currently active mouse cursor.
 -- Get the currently active mouse cursor.
SDL_ShowCursor — Toggle whether or not the cursor is shown on the screen.
 -- Toggle whether or not the cursor is shown on the screen.
SDL_GL_LoadLibrary — Specify an OpenGL library
 -- Specify an OpenGL library
SDL_GL_GetProcAddress — Get the address of a GL function
 -- Get the address of a GL function
SDL_GL_GetAttribute — Get the value of a special SDL/OpenGL attribute
 -- Get the value of a special SDL/OpenGL attribute
SDL_GL_SetAttribute — Set a special SDL/OpenGL attribute
 -- Set a special SDL/OpenGL attribute
SDL_GL_SwapBuffers — Swap OpenGL framebuffers/Update Display
 -- Swap OpenGL framebuffers/Update Display
SDL_CreateYUVOverlay — Create a YUV video overlay
 -- Create a YUV video overlay
SDL_LockYUVOverlay — Lock an overlay
 -- Lock an overlay
SDL_UnlockYUVOverlay — Unlock an overlay
 -- Unlock an overlay
SDL_DisplayYUVOverlay — Blit the overlay to the display
 -- Blit the overlay to the display
SDL_FreeYUVOverlay — Free a YUV video overlay
 -- Free a YUV video overlay
SDL_GLattr — SDL GL Attributes
 -- SDL GL Attributes
SDL_Rect — Defines a rectangular area
 -- Defines a rectangular area
SDL_Color — Format independent color description
 -- Format independent color description
SDL_Palette — Color palette for 8-bit pixel formats
 -- Color palette for 8-bit pixel formats
SDL_PixelFormat — Stores surface format information
 -- Stores surface format information
SDL_Surface — Graphical Surface Structure
 -- Graphical Surface Structure
SDL_VideoInfo — Video Target information
 -- Video Target information
SDL_Overlay — YUV video overlay
 -- YUV video overlay
SDL_WM_SetCaption — Sets the window tile and icon name.
 -- Sets the window tile and icon name.
SDL_WM_GetCaption — Gets the window title and icon name.
 -- Gets the window title and icon name.
SDL_WM_SetIcon — Sets the icon for the display window.
 -- Sets the icon for the display window.
SDL_WM_IconifyWindow — Iconify/Minimise the window
 -- Iconify/Minimise the window
SDL_WM_ToggleFullScreen — Toggles fullscreen mode
 -- Toggles fullscreen mode
SDL_WM_GrabInput — Grabs mouse and keyboard input.
 -- Grabs mouse and keyboard input.
Introduction
SDL_NumJoysticks — Count available joysticks.
 -- Count available joysticks.
SDL_JoystickName — Get joystick name.
 -- Get joystick name.
SDL_JoystickOpen — Opens a joystick for use.
 -- Opens a joystick for use.
SDL_JoystickOpened — Determine if a joystick has been opened
 -- Determine if a joystick has been opened
SDL_JoystickIndex — Get the index of an SDL_Joystick.
 -- Get the index of an SDL_Joystick.
SDL_JoystickNumAxes — Get the number of joystick axes
 -- Get the number of joystick axes
SDL_JoystickNumBalls — Get the number of joystick trackballs
 -- Get the number of joystick trackballs
SDL_JoystickNumHats — Get the number of joystick hats
 -- Get the number of joystick hats
SDL_JoystickNumButtons — Get the number of joysitck buttons
 -- Get the number of joysitck buttons
SDL_JoystickUpdate — Updates the state of all joysticks
 -- Updates the state of all joysticks
SDL_JoystickGetAxis — Get the current state of an axis
 -- Get the current state of an axis
SDL_JoystickGetHat — Get the current state of a joystick hat
 -- Get the current state of a joystick hat
SDL_JoystickGetButton — Get the current state of a given button on a given joystick
 -- Get the current state of a given button on a given joystick
SDL_JoystickGetBall — Get relative trackball motion
 -- Get relative trackball motion
SDL_JoystickClose — Closes a previously opened joystick
 -- Closes a previously opened joystick
SDL_AudioSpec — Audio Specification Structure
 -- Audio Specification Structure
SDL_OpenAudio — Opens the audio device with the desired parameters.
 -- Opens the audio device with the desired parameters.
SDL_PauseAudio — Pauses and unpauses the audio callback processing
 -- Pauses and unpauses the audio callback processing
SDL_GetAudioStatus — Get the current audio state
 -- Get the current audio state
SDL_LoadWAV — Load a WAVE file
 -- Load a WAVE file
SDL_FreeWAV — Frees previously opened WAV data
 -- Frees previously opened WAV data
SDL_AudioCVT — Audio Conversion Structure
 -- Audio Conversion Structure
SDL_BuildAudioCVT — Initializes a SDL_AudioCVT structure for conversion
 -- Initializes a SDL_AudioCVT structure for conversion
SDL_ConvertAudio — Convert audio data to a desired audio format.
 -- Convert audio data to a desired audio format.
SDL_MixAudio — Mix audio data
 -- Mix audio data
SDL_LockAudio — Lock out the callback function
 -- Lock out the callback function
SDL_UnlockAudio — Unlock the callback function
 -- Unlock the callback function
SDL_CloseAudio — Shuts down audio processing and closes the audio device.
 -- Shuts down audio processing and closes the audio device.
SDL_CDNumDrives — Returns the number of CD-ROM drives on the system.
 -- Returns the number of CD-ROM drives on the system.
SDL_CDName — Returns a human-readable, system-dependent identifier for the CD-ROM.
 -- Returns a human-readable, system-dependent identifier for the CD-ROM.
SDL_CDOpen — Opens a CD-ROM drive for access.
 -- Opens a CD-ROM drive for access.
SDL_CDStatus — Returns the current status of the given drive.
 -- Returns the current status of the given drive.
SDL_CDPlay — Play a CD
 -- Play a CD
SDL_CDPlayTracks — Play the given CD track(s)
 -- Play the given CD track(s)
SDL_CDPause — Pauses a CDROM
 -- Pauses a CDROM
SDL_CDResume — Resumes a CDROM
 -- Resumes a CDROM
SDL_CDStop — Stops a CDROM
 -- Stops a CDROM
SDL_CDEject — Ejects a CDROM
 -- Ejects a CDROM
SDL_CDClose — Closes a SDL_CD handle
 -- Closes a SDL_CD handle
SDL_CD — CDROM Drive Information
 -- CDROM Drive Information
SDL_CDtrack — CD Track Information Structure
 -- CD Track Information Structure
SDL_CreateThread — Creates a new thread of execution that shares its parent's properties.
 -- Creates a new thread of execution that shares its parent's properties.
SDL_ThreadID — Get the 32-bit thread identifier for the current thread.
 -- Get the 32-bit thread identifier for the current thread.
SDL_GetThreadID — Get the SDL thread ID of a SDL_Thread
 -- Get the SDL thread ID of a SDL_Thread
SDL_WaitThread — Wait for a thread to finish.
 -- Wait for a thread to finish.
SDL_KillThread — Gracelessly terminates the thread.
 -- Gracelessly terminates the thread.
SDL_CreateMutex — Create a mutex
 -- Create a mutex
SDL_DestroyMutex — Destroy a mutex
 -- Destroy a mutex
SDL_mutexP — Lock a mutex
 -- Lock a mutex
SDL_mutexV — Unlock a mutex
 -- Unlock a mutex
SDL_CreateSemaphore — Creates a new semaphore and assigns an initial value to it.
 -- Creates a new semaphore and assigns an initial value to it.
SDL_DestroySemaphore — Destroys a semaphore that was created by  -- Destroys a semaphore that was created by SDL_CreateSemaphore.
SDL_SemWait — Lock a semaphore and suspend the thread if the semaphore value is zero. -- Lock a semaphore and suspend the thread if the semaphore value is zero.
SDL_SemTryWait — Attempt to lock a semaphore but don't suspend the thread.
 -- Attempt to lock a semaphore but don't suspend the thread.
SDL_SemWaitTimeout — Lock a semaphore, but only wait up to a specified maximum time.
 -- Lock a semaphore, but only wait up to a specified maximum time.
SDL_SemPost — Unlock a semaphore.
 -- Unlock a semaphore.
SDL_SemValue — Return the current value of a semaphore.
 -- Return the current value of a semaphore.
SDL_CreateCond — Create a condition variable
 -- Create a condition variable
SDL_DestroyCond — Destroy a condition variable
 -- Destroy a condition variable
SDL_CondSignal — Restart a thread wait on a condition variable
 -- Restart a thread wait on a condition variable
SDL_CondBroadcast — Restart all threads waiting on a condition variable
 -- Restart all threads waiting on a condition variable
SDL_CondWait — Wait on a condition variable
 -- Wait on a condition variable
SDL_CondWaitTimeout — Wait on a condition variable, with timeout
 -- Wait on a condition variable, with timeout
SDL_GetTicks — Get the number of milliseconds since the SDL library initialization.
 -- Get the number of milliseconds since the SDL library initialization.
SDL_Delay — Wait a specified number of milliseconds before returning.
 -- Wait a specified number of milliseconds before returning.
SDL_AddTimer — Add a timer which will call a callback after the specified number of milliseconds has +> -- Add a timer which will call a callback after the specified number of milliseconds has elapsed.
SDL_RemoveTimer — Remove a timer which was added with +> -- Remove a timer which was added with SDL_AddTimerSDL_SetTimer — Set a callback to run after the specified number of milliseconds has +> -- Set a callback to run after the specified number of milliseconds has elapsed.
8-1. SDL Keysym definitions
NextJoystick
Prev

Chapter 9. Joystick

Chapter 9. Joystick
SDL_NumJoysticks — Count available joysticks. -- Count available joysticks.
SDL_JoystickName — Get joystick name.
 -- Get joystick name.
SDL_JoystickOpen — Opens a joystick for use.
 -- Opens a joystick for use.
SDL_JoystickOpened — Determine if a joystick has been opened
 -- Determine if a joystick has been opened
SDL_JoystickIndex — Get the index of an SDL_Joystick.
 -- Get the index of an SDL_Joystick.
SDL_JoystickNumAxes — Get the number of joystick axes
 -- Get the number of joystick axes
SDL_JoystickNumBalls — Get the number of joystick trackballs
 -- Get the number of joystick trackballs
SDL_JoystickNumHats — Get the number of joystick hats
 -- Get the number of joystick hats
SDL_JoystickNumButtons — Get the number of joysitck buttons
 -- Get the number of joysitck buttons
SDL_JoystickUpdate — Updates the state of all joysticks
 -- Updates the state of all joysticks
SDL_JoystickGetAxis — Get the current state of an axis
 -- Get the current state of an axis
SDL_JoystickGetHat — Get the current state of a joystick hat
 -- Get the current state of a joystick hat
SDL_JoystickGetButton — Get the current state of a given button on a given joystick
 -- Get the current state of a given button on a given joystick
SDL_JoystickGetBall — Get relative trackball motion
 -- Get relative trackball motion
SDL_JoystickClose — Closes a previously opened joystick
 -- Closes a previously opened joystick

Note: If you are If you are not handling the joystick via the event queue then you must explicitly request a joystick update by calling

Next
PrevUp
HomeNext
SDL Reference
Prev
Next
PrevSDL_ActiveEvent
HomeNext
Prev

SDL_ActiveEvent

SDL_ActiveEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_AddTimer
Prev

SDL_AddTimer

SDL_AddTimer

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_AudioCVT
Prev

SDL_AudioCVT

SDL_AudioCVT

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_AudioSpec
Prev

SDL_AudioSpec

SDL_AudioSpec

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_BlitSurface
Prev

SDL_BlitSurface

SDL_BlitSurface

Name

Synopsis

Description

This performs a fast blit from the source surface to the destination surface.

Only the position is used in the dstrect (the -width and height are ignored).

If either The width and height in srcrect or +> determine the +size of the copied rectangle. Only the position is used in the dstrect are NULL, the entire -surface ( (the width and height are ignored).

If srcsrcrect or is NULL, the +entire surface is copied. If dstdstrect) is -copied.

is +NULL, then the destination position (upper left +corner) is (0, 0).

The final blit rectangle is saved in

Return Value

while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) { while ( SDL_LockSurface(image)) < 0 ) - Sleep(10); + SDL_Delay(10); -- Write image pixels to image->pixels -- SDL_UnlockSurface(image); }

See Also

Next
PrevUp
HomeNext
SDL_BuildAudioCVT
Prev

SDL_BuildAudioCVT

SDL_BuildAudioCVT

Name

Synopsis

Description

Return Values

Examples

See Also

Next
PrevUp
HomeNext
SDL_CD
Prev

SDL_CD

SDL_CD

Name

Structure Definition

Structure Data

Description

Examples

See Also

Next
PrevUp
HomeNext
SDL_CDClose
Prev

SDL_CDClose

SDL_CDClose

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_CDEject
Prev

SDL_CDEject

SDL_CDEject

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_CDName
Prev

SDL_CDName

SDL_CDName

Name

Synopsis

Description

Examples

See Also

Next
PrevUp
HomeNext
SDL_CDNumDrives
Prev

SDL_CDNumDrives

SDL_CDNumDrives

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_CDOpen
Prev

SDL_CDOpen

SDL_CDOpen

Name

Synopsis

Description

Examples

See Also

Next
PrevUp
HomeNext
SDL_CDPause
Prev

SDL_CDPause

SDL_CDPause

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_CDPlay
Prev

SDL_CDPlay

SDL_CDPlay

Name

Synopsis

Description

Return Values

See Also

Next
PrevUp
HomeNext
SDL_CDPlayTracks
Prev

SDL_CDPlayTracks

SDL_CDPlayTracks

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_CDResume
Prev

SDL_CDResume

SDL_CDResume

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_CDStatus
Prev

SDL_CDStatus

SDL_CDStatus

Name

Synopsis

Description

Example

See Also

Next
PrevUp
HomeNext
SDL_CDStop
Prev

SDL_CDStop

SDL_CDStop

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_CDtrack
Prev

SDL_CDtrack

SDL_CDtrack

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_CloseAudio
Prev

SDL_CloseAudio

SDL_CloseAudio

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_Color
Prev

SDL_Color

SDL_Color

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_CondBroadcast
Prev

SDL_CondBroadcast

SDL_CondBroadcast

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_CondSignal
Prev

SDL_CondSignal

SDL_CondSignal

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_CondWait
Prev

SDL_CondWait

SDL_CondWait

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_CondWaitTimeout
Prev

SDL_CondWaitTimeout

SDL_CondWaitTimeout

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_ConvertAudio
Prev

SDL_ConvertAudio

SDL_ConvertAudio

Name

Synopsis

Description

Examples

See Also

Next
PrevUp
HomeNext
SDL_ConvertSurface
Prev

SDL_ConvertSurface

SDL_ConvertSurface

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_CreateCond
Prev

SDL_CreateCond

SDL_CreateCond

Name

Synopsis

Description

Examples

See Also

Next
PrevUp
HomeNext
SDL_CreateCursor
Prev

SDL_CreateCursor

SDL_CreateCursor

Name

Synopsis

Description

Example

See Also

Next
PrevUp
HomeNext
SDL_CreateMutex
Prev

SDL_CreateMutex

SDL_CreateMutex

Name

Synopsis

Description

Examples

See Also

Next
PrevUp
HomeNext
SDL_CreateRGBSurface
Prev

SDL_CreateRGBSurface

SDL_CreateRGBSurface

Name

Synopsis

Description

Return Value

Example

See Also

Next
PrevUp
HomeNext
SDL_CreateRGBSurfaceFrom
Prev

SDL_CreateRGBSurfaceFrom

SDL_CreateRGBSurfaceFrom

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_CreateSemaphore
Prev

SDL_CreateSemaphore

SDL_CreateSemaphore

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_CreateThread
Prev

SDL_CreateThread

SDL_CreateThread

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_CreateYUVOverlay
Prev

SDL_CreateYUVOverlay

SDL_CreateYUVOverlay

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_Delay
Prev

SDL_Delay

SDL_Delay

Name

Synopsis

Description

Wait a specified number of milliseconds before returning. SDL_Delay will wait at will wait at least the specified time, but possible longer due to OS scheduling.

Note: Count on a delay granularity of Count on a delay granularity of at least 10 ms. Some platforms have shorter clock ticks but this is the most common.

See Also

Next
PrevUp
HomeNext
SDL_DestroyCond
Prev

SDL_DestroyCond

SDL_DestroyCond

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_DestroyMutex
Prev

SDL_DestroyMutex

SDL_DestroyMutex

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_DestroySemaphore
Prev

SDL_DestroySemaphore

SDL_DestroySemaphore

Name

Synopsis

Description

Examples

See Also

Next
PrevUp
HomeNext
SDL_DisplayFormat
Prev

SDL_DisplayFormat

SDL_DisplayFormat

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_DisplayFormatAlpha
Prev

SDL_DisplayFormatAlpha

SDL_DisplayFormatAlpha

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_DisplayYUVOverlay
Prev

SDL_DisplayYUVOverlay

SDL_DisplayYUVOverlay

Name

Synopsis

Description

Return Values

See Also

Next
PrevUp
HomeNext
SDL_EnableKeyRepeat
Prev

SDL_EnableKeyRepeat

SDL_EnableKeyRepeat

Name

Synopsis

Description

Return Value

Next
PrevUp
HomeNext
SDL_EnableUNICODE
Prev

SDL_EnableUNICODE

SDL_EnableUNICODE

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_envvars
SDL Library Documentation
PrevNext

SDL_envvars

Name

SDL_envvars -- SDL environment variables

Description

Not a function, set using setenv()

Several environment variables are available to modify the +behaviour of SDL. Using these variables isn't recommened and the names +and presence of these variables aren't guaranteed from one release to +the next. However, they can be very useful for debugging +purposes.

Video

SDL_FBACCEL

If set to 0, disable hardware acceleration in the linux fbcon driver.

SDL_FBDEV

Frame buffer device to use in the linux fbcon driver, instead of /dev/fb0

SDL_FULLSCREEN_UPDATE

In the ps2gs driver, sets the SDL_ASYNCBLIT flag on the +display surface.

SDL_VIDEODRIVER

Selectes the video driver for SDL to use. Possible values, in the +order they are tried if this variable is not set:

x11

dga

(the XFree86 DGA2)

nanox

(Linux)

fbcon

(Linux)

directfb

(Linux)

ps2gs

(Playstation 2)

ggi

vgl

(BSD)

svgalib

(Linux)

aalib

directx

(Win32)

windib

(Win32)

bwindow

(BeOS)

toolbox

(MacOS Classic)

DSp

(MacOS Classic)

Quartz

(MacOS X)

CGX

(Amiga)

photon

(QNX)

epoc

(Epoc)

dummy

SDL_VIDEO_CENTERED

If set, tries to center the SDL window when running in X11 windowed +mode, or using the CyberGrafix driver.

SDL_VIDEO_GL_DRIVER

The openGL driver (shared library) to use for X11. Default is libGL.so.1

SDL_VIDEO_X11_DGAMOUSE

With XFree86, enables use of DGA mouse if set.

SDL_VIDEO_X11_MOUSEACCEL

For X11, sets the mouse acceleration. The value should be a string +on the form:

"n/d/t"

where n and d are the +acceleration numerator/denumerators (so mouse movement is accelerated by +n/d), and +t is the threshold above which acceleration applies +(counted as number of pixels the mouse moves at once).

SDL_VIDEO_X11_NODIRECTCOLOR

If set, don't attempt to use DirectColor visuals even if they are +present. (SDL will use them otherwise for gamma correction). +This is needed with older X servers when using the XVideo extension.

SDL_VIDEO_X11_VISUALID

ID of an X11 visual to use, overriding SDL's default visual selection +algorithm. It can be in decimal or in hex (prefixed by 0x).

SDL_VIDEO_YUV_DIRECT

If set, display YUV overlay directly on the video surface if possible, +instead of on the surface passed to +SDL_CreateYUVOverlay.

SDL_VIDEO_YUV_HWACCEL

If not set or set to a nonzero value, SDL will attempt to use +hardware YUV acceleration for video playback.

SDL_WINDOWID

For X11 or Win32, contains the ID number of the window to be used by +SDL instead of creating its own window. Either in decimal or +in hex (prefixed by 0x).

Events/Input

SDL_MOUSE_RELATIVE

If set to 0, do not use mouse relative mode in X11. The default is +to use it if the mouse is hidden and input is grabbed.

SDL_MOUSEDEV

The mouse device to use for the linux fbcon driver. If not set, +SDL first tries to use GPM in repeater mode, then various other +devices (/dev/pcaux, /dev/adbmouse, /dev/mouse etc).

SDL_MOUSEDEV_IMPS2

If set, SDL will not try to auto-detect the IMPS/2 protocol of +a PS/2 mouse but use it right away. For the fbcon and ps2gs drivers.

SDL_MOUSEDRV

For the linux fbcon driver: if set to ELO, use the ELO touchscreen +controller as a pointer device

SDL_NO_RAWKBD

For the libvga driver: If set, do not attempt to put the keyboard in raw mode.

SDL_NOMOUSE

If set, the linux fbcon driver will not use a mouse at all.

Audio

AUDIODEV

The audio device to use, if SDL_PATH_DSP isn't set.

SDL_AUDIODRIVER

Selects the audio driver for SDL to use. Possible values, in the +order they are tried if this variable is not set:

openbsd

(OpenBSD)

dsp

(OSS /dev/dsp: Linux, Solaris, BSD etc)

alsa

(Linux)

audio

(Unix style /dev/audio: SunOS, Solaris etc)

AL

(Irix)

artsc

(ARTS audio daemon)

esd

(esound audio daemon)

nas

(NAS audio daemon)

dma

(OSS /dev/dsp, using DMA)

dsound

(Win32 DirectX)

waveout

(Win32 WaveOut)

baudio

(BeOS)

sndmgr

(MacOS SoundManager)

paud

(AIX)

AHI

(Amiga)

disk

(all; output to file)

SDL_DISKAUDIOFILE

The name of the output file for the "disk" audio driver. If not +set, the name sdlaudio.raw is used.

SDL_DISKAUDIODELAY

For the "disk" audio driver, how long to wait (in ms) before writing +a full sound buffer. The default is 150 ms.

SDL_DSP_NOSELECT

For some audio drivers (alsa, paud, dma and dsp), don't use select() +but a timed method instead. May cure some audio problems, or cause +others.

SDL_PATH_DSP

The audio device to use. If not set, SDL tries AUDIODEV and then +a platform-dependent default value (/dev/audio on Solaris, +/dev/dsp on Linux etc).

CD-ROM

SDL_CDROM

A colon-separated list of CD-ROM devices to use, in addition to +the standard devices (typically /dev/cdrom, platform-dependent).

Debugging

SDL_DEBUG

If set, causes every call to SDL_SetError (that +is, every time SDL signals an error) to also print an error message on +stderr.

Joystick

SDL_JOYSTICK_DEVICE

Joystick device to use in the linux joystick driver, in addition +to the usual: /dev/js*, /dev/input/event*, /dev/input/js*

SDL_LINUX_JOYSTICK

Special joystick configuration string for linux. The format is

"name numaxes numhats numballs"

where name is the name string of the joystick +(possibly in single quotes), and the rest are the number of axes, hats +and balls respectively.

PrevHomeNext
SDL_GetErrorUpVideo
\ No newline at end of file diff --git a/docs/html/sdlevent.html b/docs/html/sdlevent.html index 5e91d532e..6817dff6a 100644 --- a/docs/html/sdlevent.html +++ b/docs/html/sdlevent.html @@ -4,7 +4,7 @@ >SDL_Event
Prev

SDL_Event

SDL_Event

Name

Structure Definition

Structure Data

Description

Use

removes an event from the queue then the event information will be placed in our test_event structure, but we also know that the structure, but we also know that the type of event will be placed in the switch(test_event.type) { -We need to know what kind of events we're looking for and the event

See Also

Next
PrevUp
HomeNext
SDL_EventState
Prev

SDL_EventState

SDL_EventState

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_ExposeEvent
Prev

SDL_ExposeEvent

SDL_ExposeEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_FillRect
Prev

SDL_FillRect

SDL_FillRect

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_Flip
Prev

SDL_Flip

SDL_Flip

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_FreeCursor
Prev

SDL_FreeCursor

SDL_FreeCursor

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_FreeSurface
Prev

SDL_FreeSurface

SDL_FreeSurface

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_FreeWAV
Prev

SDL_FreeWAV

SDL_FreeWAV

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_FreeYUVOverlay
Prev

SDL_FreeYUVOverlay

SDL_FreeYUVOverlay

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetAppState
Prev

SDL_GetAppState

SDL_GetAppState

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetAudioStatus
Prev

SDL_GetAudioStatus

SDL_GetAudioStatus

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetClipRect
Prev

SDL_GetClipRect

SDL_GetClipRect

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetCursor
Prev

SDL_GetCursor

SDL_GetCursor

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetError
Prev

SDL_GetError

SDL_GetError
Next
PrevUpSDL_envvars
HomeNext
Video
SDL_GetEventFilter
Prev

SDL_GetEventFilter

SDL_GetEventFilter

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_GetGammaRamp
Prev

SDL_GetGammaRamp

SDL_GetGammaRamp

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_GetKeyName
Prev

SDL_GetKeyName

SDL_GetKeyName

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetKeyState
Prev

SDL_GetKeyState

SDL_GetKeyState

Name

Synopsis

Description

Example

See Also

Next
PrevUp
HomeNext
SDL_GetModState
Prev

SDL_GetModState

SDL_GetModState

Name

Synopsis

Description

Return Value

The return value can be an OR'd combination of the SDLMod enum.

SDL also defines the following symbols for convenience:

See Also

Next
PrevUp
HomeNext
SDL_GetMouseState
Prev

SDL_GetMouseState

SDL_GetMouseState

Name

Synopsis

Description

Example

See Also

Next
PrevUp
HomeNext
SDL_GetRelativeMouseState
Prev

SDL_GetRelativeMouseState

SDL_GetRelativeMouseState

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetRGB
Prev

SDL_GetRGB

SDL_GetRGB

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetRGBA
Prev

SDL_GetRGBA

SDL_GetRGBA

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetThreadID
Prev

SDL_GetThreadID

SDL_GetThreadID

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetTicks
Prev

SDL_GetTicks

SDL_GetTicks

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetVideoInfo
Prev

SDL_GetVideoInfo

SDL_GetVideoInfo

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GetVideoSurface
Prev

SDL_GetVideoSurface

SDL_GetVideoSurface

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GLattr
Prev

SDL_GLattr

SDL_GLattr

Name

Attributes

Description

While you can set most OpenGL attributes normally, the attributes list above must be known While you can set most OpenGL attributes normally, the attributes list above must be known before SDL sets the video mode. These attributes a set and read with

See Also

Next
PrevUp
HomeNext
SDL_GL_GetAttribute
Prev

SDL_GL_GetAttribute

SDL_GL_GetAttribute

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_GL_GetProcAddress
Prev

SDL_GL_GetProcAddress

SDL_GL_GetProcAddress

Name

Synopsis

Description

SDL_GL_LoadLibrary, then , then all GL functions must be retrieved this way. Usually this is used to retrieve function pointers to OpenGL extensions.

Example

See Also

Next
PrevUp
HomeNext
SDL_GL_LoadLibrary
Prev

SDL_GL_LoadLibrary

SDL_GL_LoadLibrary

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_GL_SetAttribute
Prev

SDL_GL_SetAttribute

SDL_GL_SetAttribute

Name

Synopsis

Description

Return Value

Example

See Also

Next
PrevUp
HomeNext
SDL_GL_SwapBuffers
Prev

SDL_GL_SwapBuffers

SDL_GL_SwapBuffers

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_Init
Prev

SDL_Init

SDL_Init
Next
PrevUp
HomeNext
SDL_InitSubSystem
Prev

SDL_InitSubSystem

SDL_InitSubSystem
Next
PrevUp
HomeNext
SDL_JoyAxisEvent
Prev

SDL_JoyAxisEvent

SDL_JoyAxisEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_JoyBallEvent
Prev

SDL_JoyBallEvent

SDL_JoyBallEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_JoyButtonEvent
Prev

SDL_JoyButtonEvent

SDL_JoyButtonEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_JoyHatEvent
Prev

SDL_JoyHatEvent

SDL_JoyHatEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_JoystickClose
Prev

SDL_JoystickClose

SDL_JoystickClose

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_JoystickEventState
Prev

SDL_JoystickEventState

SDL_JoystickEventState

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_JoystickGetAxis
Prev

SDL_JoystickGetAxis

SDL_JoystickGetAxis

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_JoystickGetBall
Prev

SDL_JoystickGetBall

SDL_JoystickGetBall

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_JoystickGetButton
Prev

SDL_JoystickGetButton

SDL_JoystickGetButton

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_JoystickGetHat
Prev

SDL_JoystickGetHat

SDL_JoystickGetHat

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_JoystickIndex
Prev

SDL_JoystickIndex

SDL_JoystickIndex

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_JoystickName
Prev

SDL_JoystickName

SDL_JoystickName

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_JoystickNumAxes
Prev

SDL_JoystickNumAxes

SDL_JoystickNumAxes

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_JoystickNumBalls
Prev

SDL_JoystickNumBalls

SDL_JoystickNumBalls

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_JoystickNumButtons
Prev

SDL_JoystickNumButtons

SDL_JoystickNumButtons

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_JoystickNumHats
Prev

SDL_JoystickNumHats

SDL_JoystickNumHats

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_JoystickOpen
Prev

SDL_JoystickOpen

SDL_JoystickOpen

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_JoystickOpened
Prev

SDL_JoystickOpened

SDL_JoystickOpened

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_JoystickUpdate
Prev

SDL_JoystickUpdate

SDL_JoystickUpdate

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDLKey
Prev

SDLKey

SDLKey

Name

Description

Next
PrevUp
HomeNext
SDL_KeyboardEvent
Prev

SDL_KeyboardEvent

SDL_KeyboardEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_keysym
Prev

SDL_keysym

SDL_keysym

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_KillThread
Prev

SDL_KillThread

SDL_KillThread

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_ListModes
Prev

SDL_ListModes

SDL_ListModes

Name

Synopsis

Description

Example

See Also

Next
PrevUp
HomeNext
SDL_LoadBMP
Prev

SDL_LoadBMP

SDL_LoadBMP

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_LoadWAV
Prev

SDL_LoadWAV

SDL_LoadWAV

Name

Synopsis

Description

Example

See Also

Next
PrevUp
HomeNext
SDL_LockAudio
Prev

SDL_LockAudio

SDL_LockAudio

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_LockSurface
Prev

SDL_LockSurface

SDL_LockSurface

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_LockYUVOverlay
Prev

SDL_LockYUVOverlay

SDL_LockYUVOverlay

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_MapRGB
Prev

SDL_MapRGB

SDL_MapRGB

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_MapRGBA
Prev

SDL_MapRGBA

SDL_MapRGBA

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_MixAudio
Prev

SDL_MixAudio

SDL_MixAudio

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_MouseButtonEvent
Prev

SDL_MouseButtonEvent

SDL_MouseButtonEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_MouseMotionEvent
Prev

SDL_MouseMotionEvent

SDL_MouseMotionEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_mutexP
Prev

SDL_mutexP

SDL_mutexP

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_mutexV
Prev

SDL_mutexV

SDL_mutexV

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_NumJoysticks
Prev

SDL_NumJoysticks

SDL_NumJoysticks

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_OpenAudio
Prev

SDL_OpenAudio

SDL_OpenAudio

Name

Synopsis

Description

SDL_AudioSpec *desired; . . -desired=(SDL_AudioSpec *)malloc(sizeof(SDL_AudioSpec)); You must then fill this structure with your desired audio specifications.

Examples

See Also

Next
PrevUp
HomeNext
SDL_Overlay
Prev

SDL_Overlay

SDL_Overlay

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_Palette
Prev

SDL_Palette

SDL_Palette

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_PauseAudio
Prev

SDL_PauseAudio

SDL_PauseAudio

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_PeepEvents
Prev

SDL_PeepEvents

SDL_PeepEvents

Name

Synopsis

Description

, will be returned and will be removed from the queue.

The mask parameter is an bitwise OR of +SDL_EVENTMASK(event_type), for all +event types you are interested in.

This function is thread-safe.

Return Value

See Also

Next
PrevUp
HomeNext
SDL_PixelFormat
Prev

SDL_PixelFormat

SDL_PixelFormat

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_PollEvent
Prev

SDL_PollEvent

SDL_PollEvent

Name

Synopsis

Description

Examples

See Also

Next
PrevUp
HomeNext
SDL_PumpEvents
Prev

SDL_PumpEvents

SDL_PumpEvents

Name

Synopsis

Description

implicitly call SDL_PumpEvents. However, if you are not polling or waiting for events (e.g. your filtering them), then you must call . However, if you are not polling or waiting for events (e.g. you are filtering them), then you must call SDL_PumpEvents to force an event queue update.

See Also

Next
PrevUp
HomeNext
SDL_PushEvent
Prev

SDL_PushEvent

SDL_PushEvent

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_Quit
Prev

SDL_Quit

SDL_Quit
Next
PrevUp
HomeNext
SDL_QuitEvent
Prev

SDL_QuitEvent

SDL_QuitEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_QuitSubSystem
Prev

SDL_QuitSubSystem

SDL_QuitSubSystem
Next
PrevUp
HomeNext
SDL_Rect
Prev

SDL_Rect

SDL_Rect

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_RemoveTimer
Prev

SDL_RemoveTimer

SDL_RemoveTimer

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_ResizeEvent
Prev

SDL_ResizeEvent

SDL_ResizeEvent

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_SaveBMP
Prev

SDL_SaveBMP

SDL_SaveBMP

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_SemPost
Prev

SDL_SemPost

SDL_SemPost

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_SemTryWait
Prev

SDL_SemTryWait

SDL_SemTryWait

Name

Synopsis

Description

SDL_MUTEX_TIMEOUTSDL_MUTEX_TIMEDOUT instead of suspending the thread.

After

Return Value

if the semaphore was successfully locked or either SDL_MUTEX_TIMEOUTSDL_MUTEX_TIMEDOUT or -1

Examples

res = SDL_SemTryWait(my_sem); -if (res == SDL_MUTEX_TIMEOUT) { +if (res == SDL_MUTEX_TIMEDOUT) { return TRY_AGAIN; } if (res == -1) { @@ -201,7 +204,7 @@ >

See Also

Next
PrevUp
HomeNext
SDL_SemValue
Prev

SDL_SemValue

SDL_SemValue

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_SemWait
Prev

SDL_SemWait

SDL_SemWait

Name

Synopsis

Description

Return Value

Examples

See Also

Next
PrevUp
HomeNext
SDL_SemWaitTimeout
Prev

SDL_SemWaitTimeout

SDL_SemWaitTimeout

Name

Synopsis

Description

Return Value

if the semaphore was successfully locked or either SDL_MUTEX_TIMEOUTSDL_MUTEX_TIMEDOUT or -1

Examples

res = SDL_SemWaitTimeout(my_sem, WAIT_TIMEOUT_MILLISEC); -if (res == SDL_MUTEX_TIMEOUT) { +if (res == SDL_MUTEX_TIMEDOUT) { return TRY_AGAIN; } if (res == -1) { @@ -204,7 +207,7 @@ >

See Also

Next
PrevUp
HomeNext
SDL_SetAlpha
Prev

SDL_SetAlpha

SDL_SetAlpha

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_SetClipRect
Prev

SDL_SetClipRect

SDL_SetClipRect

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_SetColorKey
Prev

SDL_SetColorKey

SDL_SetColorKey

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_SetColors
Prev

SDL_SetColors

SDL_SetColors

Name

Synopsis

Description

Return Value

Example

See Also

Next
PrevUp
HomeNext
SDL_SetCursor
Prev

SDL_SetCursor

SDL_SetCursor

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_SetEventFilter
Prev

SDL_SetEventFilter

SDL_SetEventFilter

Name

Synopsis

Description

Note: Be Careful! The event filter function may run in a different thread so be careful what you do within it.

See Also

Next
PrevUp
HomeNext
SDL_SetGamma
Prev

SDL_SetGamma

SDL_SetGamma

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_SetGammaRamp
Prev

SDL_SetGammaRamp

SDL_SetGammaRamp

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_SetModState
Prev

SDL_SetModState

SDL_SetModState

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_SetPalette
Prev

SDL_SetPalette

SDL_SetPalette

Name

Synopsis

Description

Return Value

Example

See Also

Next
PrevUp
HomeNext
SDL_SetTimer
Prev

SDL_SetTimer

SDL_SetTimer

Name

Synopsis

Description

Examples

See Also

Prev
HomeUpSDL_SetVideoMode
Prev

SDL_SetVideoMode

SDL_SetVideoMode

Name

Synopsis

Description

SDL_UpdateRects -must be used for updating changes to the screen surface.not recommended for +new code.
Next

Return Value

See Also

PrevUp
HomeNext
SDL_ShowCursor
Prev

SDL_ShowCursor

SDL_ShowCursor

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_Surface
Prev

SDL_Surface

SDL_Surface

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_SysWMEvent
Prev

SDL_SysWMEvent

SDL_SysWMEvent

Name

Description

typedef struct { - Uint8 type; /* Always SDL_SysWM */ + Uint8 type; /* Always SDL_SYSWMEVENT */ + SDL_SysWMmsg *msg; } SDL_SysWMEvent; @@ -127,7 +131,7 @@

See Also

Next
PrevUp
HomeNext
SDL_ThreadID
Prev

SDL_ThreadID

SDL_ThreadID

Name

Synopsis

Description

Next
PrevUp
HomeNext
SDL_UnlockAudio
Prev

SDL_UnlockAudio

SDL_UnlockAudio

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_UnlockSurface
Prev

SDL_UnlockSurface

SDL_UnlockSurface

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_UnlockYUVOverlay
Prev

SDL_UnlockYUVOverlay

SDL_UnlockYUVOverlay

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_UpdateRect
Prev

SDL_UpdateRect

SDL_UpdateRect

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_UpdateRects
Prev

SDL_UpdateRects

SDL_UpdateRects

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_UserEvent
Prev

SDL_UserEvent

SDL_UserEvent

Name

Structure Definition

Structure Data

Description

Examples

See Also

Next
PrevUp
HomeNext
SDL_VideoDriverName
Prev

SDL_VideoDriverName

SDL_VideoDriverName

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_VideoInfo
Prev

SDL_VideoInfo

SDL_VideoInfo

Name

Structure Definition

Structure Data

Description

See Also

Next
PrevUp
HomeNext
SDL_VideoModeOK
Prev

SDL_VideoModeOK

SDL_VideoModeOK

Name

Synopsis

Description

Example

See Also

Next
PrevUp
HomeNext
SDL_WaitEvent
Prev

SDL_WaitEvent

SDL_WaitEvent

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_WaitThread
Prev

SDL_WaitThread

SDL_WaitThread

Name

Synopsis

Description

Return Value

See Also

Next
PrevUp
HomeNext
SDL_WarpMouse
Prev

SDL_WarpMouse

SDL_WarpMouse

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_WasInit
Prev

SDL_WasInit

SDL_WasInit
Next
PrevUp
HomeNext
SDL_WM_GetCaption
Prev

SDL_WM_GetCaption

SDL_WM_GetCaption

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_WM_GrabInput
Prev

SDL_WM_GrabInput

SDL_WM_GrabInput

Name

Synopsis

Description

Return Value

Next
PrevUp
HomeNext
SDL_WM_IconifyWindow
Prev

SDL_WM_IconifyWindow

SDL_WM_IconifyWindow

Name

Synopsis

Description

Return Value

Next
PrevUp
HomeNext
SDL_WM_SetCaption
Prev

SDL_WM_SetCaption

SDL_WM_SetCaption

Name

Synopsis

Description

See Also

Next
PrevUp
HomeNext
SDL_WM_SetIcon
Prev

SDL_WM_SetIcon

SDL_WM_SetIcon

Name

Synopsis

Description

SDL_SetVideoMode.

It takes an The iconmask surface, and a is a bitmask that describes the shape of the +icon. If mask in MSB format.

is NULL, then the shape is determined by +the colorkey of icon, if any, or makes the icon +rectangular (no transparency) otherwise.

If mask is NULL, the entire -icon surface will be used as the icon.

is non-NULL, it points to a bitmap with bits set +where the corresponding pixel should be visible. The format of the bitmap is as +follows: Scanlines come in the usual top-down order. Each scanline consists of +(width / 8) bytes, rounded up. The most significant bit of each byte represents +the leftmost pixel.

Example

See Also

Next
PrevUp
HomeNext
SDL_WM_ToggleFullScreen
Prev

SDL_WM_ToggleFullScreen

SDL_WM_ToggleFullScreen

Name

Synopsis

Description

Return Value

Next
PrevUp
HomeNext
Multi-threaded Programming
Prev

Chapter 12. Multi-threaded Programming

Chapter 12. Multi-threaded Programming
SDL_CreateThread — Creates a new thread of execution that shares its parent's properties. -- Creates a new thread of execution that shares its parent's properties.
SDL_ThreadID — Get the 32-bit thread identifier for the current thread.
 -- Get the 32-bit thread identifier for the current thread.
SDL_GetThreadID — Get the SDL thread ID of a SDL_Thread
 -- Get the SDL thread ID of a SDL_Thread
SDL_WaitThread — Wait for a thread to finish.
 -- Wait for a thread to finish.
SDL_KillThread — Gracelessly terminates the thread.
 -- Gracelessly terminates the thread.
SDL_CreateMutex — Create a mutex
 -- Create a mutex
SDL_DestroyMutex — Destroy a mutex
 -- Destroy a mutex
SDL_mutexP — Lock a mutex
 -- Lock a mutex
SDL_mutexV — Unlock a mutex
 -- Unlock a mutex
SDL_CreateSemaphore — Creates a new semaphore and assigns an initial value to it.
 -- Creates a new semaphore and assigns an initial value to it.
SDL_DestroySemaphore — Destroys a semaphore that was created by  -- Destroys a semaphore that was created by SDL_CreateSemaphore.
SDL_SemWait — Lock a semaphore and suspend the thread if the semaphore value is zero. -- Lock a semaphore and suspend the thread if the semaphore value is zero.
SDL_SemTryWait — Attempt to lock a semaphore but don't suspend the thread.
 -- Attempt to lock a semaphore but don't suspend the thread.
SDL_SemWaitTimeout — Lock a semaphore, but only wait up to a specified maximum time.
 -- Lock a semaphore, but only wait up to a specified maximum time.
SDL_SemPost — Unlock a semaphore.
 -- Unlock a semaphore.
SDL_SemValue — Return the current value of a semaphore.
 -- Return the current value of a semaphore.
SDL_CreateCond — Create a condition variable
 -- Create a condition variable
SDL_DestroyCond — Destroy a condition variable
 -- Destroy a condition variable
SDL_CondSignal — Restart a thread wait on a condition variable
 -- Restart a thread wait on a condition variable
SDL_CondBroadcast — Restart all threads waiting on a condition variable
 -- Restart all threads waiting on a condition variable
SDL_CondWait — Wait on a condition variable
 -- Wait on a condition variable
SDL_CondWaitTimeout — Wait on a condition variable, with timeout
 -- Wait on a condition variable, with timeout

Next
PrevUp
HomeNext
Time
Prev

Chapter 13. Time

Chapter 13. Time
SDL_GetTicks — Get the number of milliseconds since the SDL library initialization. -- Get the number of milliseconds since the SDL library initialization.
SDL_Delay — Wait a specified number of milliseconds before returning.
 -- Wait a specified number of milliseconds before returning.
SDL_AddTimer — Add a timer which will call a callback after the specified number of milliseconds has +> -- Add a timer which will call a callback after the specified number of milliseconds has elapsed.
SDL_RemoveTimer — Remove a timer which was added with +> -- Remove a timer which was added with SDL_AddTimerSDL_SetTimer — Set a callback to run after the specified number of milliseconds has +> -- Set a callback to run after the specified number of milliseconds has elapsed.
Next
PrevUp
HomeNext
Video
Prev

Chapter 6. Video

Chapter 6. Video
SDL_GetVideoSurface — returns a pointer to the current display surface -- returns a pointer to the current display surface
SDL_GetVideoInfo — returns a pointer to information about the video hardware
 -- returns a pointer to information about the video hardware
SDL_VideoDriverName — Obtain the name of the video driver
 -- Obtain the name of the video driver
SDL_ListModes — Returns a pointer to an array of available screen dimensions for +> -- Returns a pointer to an array of available screen dimensions for the given format and video flags
SDL_VideoModeOK — Check to see if a particular video mode is supported.
 -- Check to see if a particular video mode is supported.
SDL_SetVideoMode — Set up a video mode with the specified width, height and bits-per-pixel.
 -- Set up a video mode with the specified width, height and bits-per-pixel.
SDL_UpdateRect — Makes sure the given area is updated on the given screen.
 -- Makes sure the given area is updated on the given screen.
SDL_UpdateRects — Makes sure the given list of rectangles is updated on the given screen.
 -- Makes sure the given list of rectangles is updated on the given screen.
SDL_Flip — Swaps screen buffers
 -- Swaps screen buffers
SDL_SetColors — Sets a portion of the colormap for the given 8-bit surface.
 -- Sets a portion of the colormap for the given 8-bit surface.
SDL_SetPalette — Sets the colors in the palette of an 8-bit surface.
 -- Sets the colors in the palette of an 8-bit surface.
SDL_SetGamma — Sets the color gamma function for the display
 -- Sets the color gamma function for the display
SDL_GetGammaRamp — Gets the color gamma lookup tables for the display
 -- Gets the color gamma lookup tables for the display
SDL_SetGammaRamp — Sets the color gamma lookup tables for the display
 -- Sets the color gamma lookup tables for the display
SDL_MapRGB — Map a RGB color value to a pixel format.
 -- Map a RGB color value to a pixel format.
SDL_MapRGBA — Map a RGBA color value to a pixel format.
 -- Map a RGBA color value to a pixel format.
SDL_GetRGB — Get RGB values from a pixel in the specified pixel format.
 -- Get RGB values from a pixel in the specified pixel format.
SDL_GetRGBA — Get RGBA values from a pixel in the specified pixel format.
 -- Get RGBA values from a pixel in the specified pixel format.
SDL_CreateRGBSurface — Create an empty SDL_Surface
 -- Create an empty SDL_Surface
SDL_CreateRGBSurfaceFrom — Create an SDL_Surface from pixel data
 -- Create an SDL_Surface from pixel data
SDL_FreeSurface — Frees (deletes) a SDL_Surface
 -- Frees (deletes) a SDL_Surface
SDL_LockSurface — Lock a surface for directly access.
 -- Lock a surface for directly access.
SDL_UnlockSurface — Unlocks a previously locked surface.
 -- Unlocks a previously locked surface.
SDL_LoadBMP — Load a Windows BMP file into an SDL_Surface.
 -- Load a Windows BMP file into an SDL_Surface.
SDL_SaveBMP — Save an SDL_Surface as a Windows BMP file.
 -- Save an SDL_Surface as a Windows BMP file.
SDL_SetColorKey — Sets the color key (transparent pixel) in a blittable surface and +> -- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration.
SDL_SetAlpha — Adjust the alpha properties of a surface
 -- Adjust the alpha properties of a surface
SDL_SetClipRect — Sets the clipping rectangle for a surface.
 -- Sets the clipping rectangle for a surface.
SDL_GetClipRect — Gets the clipping rectangle for a surface.
 -- Gets the clipping rectangle for a surface.
SDL_ConvertSurface — Converts a surface to the same format as another surface.
 -- Converts a surface to the same format as another surface.
SDL_BlitSurface — This performs a fast blit from the source surface to the destination surface.
 -- This performs a fast blit from the source surface to the destination surface.
SDL_FillRect — This function performs a fast fill of the given rectangle with some color
 -- This function performs a fast fill of the given rectangle with some color
SDL_DisplayFormat — Convert a surface to the display format
 -- Convert a surface to the display format
SDL_DisplayFormatAlpha — Convert a surface to the display format
 -- Convert a surface to the display format
SDL_WarpMouse — Set the position of the mouse cursor.
 -- Set the position of the mouse cursor.
SDL_CreateCursor — Creates a new mouse cursor.
 -- Creates a new mouse cursor.
SDL_FreeCursor — Frees a cursor created with SDL_CreateCursor.
 -- Frees a cursor created with SDL_CreateCursor.
SDL_SetCursor — Set the currently active mouse cursor.
 -- Set the currently active mouse cursor.
SDL_GetCursor — Get the currently active mouse cursor.
 -- Get the currently active mouse cursor.
SDL_ShowCursor — Toggle whether or not the cursor is shown on the screen.
 -- Toggle whether or not the cursor is shown on the screen.
SDL_GL_LoadLibrary — Specify an OpenGL library
 -- Specify an OpenGL library
SDL_GL_GetProcAddress — Get the address of a GL function
 -- Get the address of a GL function
SDL_GL_GetAttribute — Get the value of a special SDL/OpenGL attribute
 -- Get the value of a special SDL/OpenGL attribute
SDL_GL_SetAttribute — Set a special SDL/OpenGL attribute
 -- Set a special SDL/OpenGL attribute
SDL_GL_SwapBuffers — Swap OpenGL framebuffers/Update Display
 -- Swap OpenGL framebuffers/Update Display
SDL_CreateYUVOverlay — Create a YUV video overlay
 -- Create a YUV video overlay
SDL_LockYUVOverlay — Lock an overlay
 -- Lock an overlay
SDL_UnlockYUVOverlay — Unlock an overlay
 -- Unlock an overlay
SDL_DisplayYUVOverlay — Blit the overlay to the display
 -- Blit the overlay to the display
SDL_FreeYUVOverlay — Free a YUV video overlay
 -- Free a YUV video overlay
SDL_GLattr — SDL GL Attributes
 -- SDL GL Attributes
SDL_Rect — Defines a rectangular area
 -- Defines a rectangular area
SDL_Color — Format independent color description
 -- Format independent color description
SDL_Palette — Color palette for 8-bit pixel formats
 -- Color palette for 8-bit pixel formats
SDL_PixelFormat — Stores surface format information
 -- Stores surface format information
SDL_Surface — Graphical Surface Structure
 -- Graphical Surface Structure
SDL_VideoInfo — Video Target information
 -- Video Target information
SDL_Overlay — YUV video overlay
 -- YUV video overlay

Next
PrevSDL_GetErrorSDL_envvars
HomeNext
UpWindow Management
Prev

Chapter 7. Window Management

Chapter 7. Window Management
SDL_WM_SetCaption — Sets the window tile and icon name. -- Sets the window tile and icon name.
SDL_WM_GetCaption — Gets the window title and icon name.
 -- Gets the window title and icon name.
SDL_WM_SetIcon — Sets the icon for the display window.
 -- Sets the icon for the display window.
SDL_WM_IconifyWindow — Iconify/Minimise the window
 -- Iconify/Minimise the window
SDL_WM_ToggleFullScreen — Toggles fullscreen mode
 -- Toggles fullscreen mode
SDL_WM_GrabInput — Grabs mouse and keyboard input.
 -- Grabs mouse and keyboard input.

Next
PrevUp
HomeNext