# HG changeset patch # User Sam Lantinga # Date 1254925799 0 # Node ID 6dc250ebdd80a7880711791174dfb2be112c01f0 # Parent 8e0182c236d816b1d9471ae462b29311640f2457 The SDL 1.3 documentation will be primarily online wiki based: http://wiki.libsdl.org/ Please contact Lauren MacDonell laleh_aziz cox.net who is coordinating it. diff -r 8e0182c236d8 -r 6dc250ebdd80 Makefile.in --- a/Makefile.in Wed Oct 07 06:11:53 2009 +0000 +++ b/Makefile.in Wed Oct 07 14:29:59 2009 +0000 @@ -10,7 +10,6 @@ includedir = @includedir@ datarootdir = @datarootdir@ datadir = @datadir@ -mandir = @mandir@ auxdir = @ac_aux_dir@ distpath = $(srcdir)/.. distdir = SDL-@SDL_VERSION@ @@ -72,7 +71,7 @@ update-revision: $(SHELL) $(auxdir)/updaterev.sh -.PHONY: all update-revision install install-bin install-hdrs install-lib install-data install-man uninstall uninstall-bin uninstall-hdrs uninstall-lib uninstall-data uninstall-man clean distclean dist +.PHONY: all update-revision install install-bin install-hdrs install-lib install-data uninstall uninstall-bin uninstall-hdrs uninstall-lib uninstall-data clean distclean dist -include $(OBJECTS:.lo=.d) @DEPENDS@ @@ -86,7 +85,7 @@ $(AR) cru $@ $(SDLMAIN_OBJECTS) $(RANLIB) $@ -install: all install-bin install-hdrs install-lib install-data install-man +install: all install-bin install-hdrs install-lib install-data install-bin: $(SHELL) $(auxdir)/mkinstalldirs $(DESTDIR)$(bindir) $(INSTALL) -m 755 sdl-config $(DESTDIR)$(bindir)/sdl-config @@ -106,14 +105,8 @@ $(INSTALL) -m 644 $(srcdir)/sdl.m4 $(DESTDIR)$(datadir)/aclocal/sdl.m4 $(SHELL) $(auxdir)/mkinstalldirs $(DESTDIR)$(libdir)/pkgconfig $(INSTALL) -m 644 sdl.pc $(DESTDIR)$(libdir)/pkgconfig -install-man: - $(SHELL) $(auxdir)/mkinstalldirs $(DESTDIR)$(mandir)/man3 - for src in $(srcdir)/docs/man3/*.3; do \ - file=`echo $$src | sed -e 's|^.*/||'`; \ - $(INSTALL) -m 644 $$src $(DESTDIR)$(mandir)/man3/$$file; \ - done -uninstall: uninstall-bin uninstall-hdrs uninstall-lib uninstall-data uninstall-man +uninstall: uninstall-bin uninstall-hdrs uninstall-lib uninstall-data uninstall-bin: rm -f $(DESTDIR)$(bindir)/sdl-config uninstall-hdrs: @@ -127,11 +120,6 @@ rm -f $(DESTDIR)$(libdir)/$(SDLMAIN_TARGET) uninstall-data: rm -f $(DESTDIR)$(datadir)/aclocal/sdl.m4 -uninstall-man: - for src in $(srcdir)/docs/man3/*.3; do \ - file=`echo $$src | sed -e 's|^.*/||'`; \ - rm -f $(DESTDIR)$(mandir)/man3/$$file; \ - done clean: rm -rf $(objects) diff -r 8e0182c236d8 -r 6dc250ebdd80 docs.html --- a/docs.html Wed Oct 07 06:11:53 2009 +0000 +++ b/docs.html Wed Oct 07 14:29:59 2009 +0000 @@ -12,7 +12,7 @@ SDL website.

API Documentation

Online Documentation

SDL 1.2.10 Release Notes

diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/audio.html --- a/docs/html/audio.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,242 +0,0 @@ -Audio

SDL Library Documentation
Prev		Next

Chapter 10. Audio

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

Sound on the computer is translated from waves that you hear into a series of -values, or samples, each representing the amplitude of the wave. When these -samples are sent in a stream to a sound card, an approximation of the original -wave can be recreated. The more bits used to represent the amplitude, and the -greater frequency these samples are gathered, the closer the approximated -sound is to the original, and the better the quality of sound.

This library supports both 8 and 16 bit signed and unsigned sound samples, -at frequencies ranging from 11025 Hz to 44100 Hz, depending on the -underlying hardware. If the hardware doesn't support the desired audio -format or frequency, it can be emulated if desired (See -SDL_OpenAudio())

A commonly supported audio format is 16 bits per sample at 22050 Hz.

Prev	Home	Next
SDL_JoystickClose	Up	SDL_AudioSpec

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/cdrom.html --- a/docs/html/cdrom.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,260 +0,0 @@ -CD-ROM

SDL Library Documentation
Prev		Next

Chapter 11. CD-ROM

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

SDL supports audio control of up to 32 local CD-ROM drives at once.

You use this API to perform all the basic functions of a CD player, -including listing the tracks, playing, stopping, and ejecting the CD-ROM. -(Currently, multi-changer CD drives are not supported.)

Before you call any of the SDL CD-ROM functions, you must first call -"SDL_Init(SDL_INIT_CDROM)", which scans the system for -CD-ROM drives, and sets the program up for audio control. Check the -return code, which should be 0, to see if there -were any errors in starting up.

After you have initialized the library, you can find out how many drives -are available using the SDL_CDNumDrives() function. -The first drive listed is the system default CD-ROM drive. After you have -chosen a drive, and have opened it with SDL_CDOpen(), -you can check the status and start playing if there's a CD in the drive.

A CD-ROM is organized into one or more tracks, each consisting of a certain -number of "frames". Each frame is ~2K in size, and at normal playing speed, -a CD plays 75 frames per second. SDL works with the number of frames on a -CD, but this can easily be converted to the more familiar minutes/seconds -format by using the FRAMES_TO_MSF() macro.

Prev	Home	Next
SDL_CloseAudio	Up	SDL_CDNumDrives

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/event.html --- a/docs/html/event.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,216 +0,0 @@ -Events

SDL Library Documentation
Prev		Next

Chapter 8. Events

Table of Contents
Introduction
SDL Event Structures.
Event Functions.

Introduction

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

SDL_Init(SDL_INIT_VIDEO);

-Internally, SDL stores all the events waiting to be handled in an event queue. Using functions like SDL_PollEvent and SDL_PeepEvents you can observe and handle waiting input events.

The key to event handling in SDL is the SDL_Event union. The event queue itself is composed of a series of SDL_Event unions, one for each waiting event. SDL_Event unions are read from the queue with the SDL_PollEvent function and it is then up to the application to process the information stored with them.

Prev	Home	Next
SDL_WM_GrabInput	Up	SDL Event Structures.

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/eventfunctions.html --- a/docs/html/eventfunctions.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,481 +0,0 @@ -Event Functions.

SDL Library Documentation
Prev	Chapter 8. Events	Next

Event Functions.

Table of Contents
SDL_PumpEvents -- Pumps the event loop, gathering events from the input devices.
SDL_PeepEvents -- Checks the event queue for messages and optionally returns them.
SDL_PollEvent -- Polls for currently pending events.
SDL_WaitEvent -- Waits indefinitely for the next available event.
SDL_PushEvent -- Pushes an event onto the event queue
SDL_SetEventFilter -- 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
SDL_EventState -- This function allows you to set the state of processing certain events.
SDL_GetKeyState -- Get a snapshot of the current keyboard state
SDL_GetModState -- Get the state of modifier keys.
SDL_SetModState -- Set the current key modifier state
SDL_GetKeyName -- Get the name of an SDL virtual keysym
SDL_EnableUNICODE -- Enable UNICODE translation
SDL_EnableKeyRepeat -- Set keyboard repeat rate.
SDL_GetMouseState -- Retrieve the current state of the mouse
SDL_GetRelativeMouseState -- Retrieve the current state of the mouse
SDL_GetAppState -- Get the state of the application
SDL_JoystickEventState -- Enable/disable joystick event polling

SDL_PumpEvents	Pumps the event loop, gathering events from the input devices
SDL_PeepEvents	Checks the event queue for messages and optionally returns them
SDL_PollEvent	Polls for currently pending events
SDL_WaitEvent	Waits indefinitely for the next available event
SDL_PushEvent	Pushes an event onto the event queue
SDL_SetEventFilter	Sets up a filter to process all events
SDL_EventState	Allows you to set the state of processing certain events
SDL_GetKeyState	Get a snapshot of the current keyboard state
SDL_GetModState	Get the state of modifier keys
SDL_SetModState	Set the state of modifier keys
SDL_GetKeyName	Get the name of an SDL virtual keysym
SDL_EnableUNICODE	Enable UNICODE translation
SDL_EnableKeyRepeat	Set keyboard repeat rate
SDL_GetMouseState	Retrieve the current state of the mouse
SDL_GetRelativeMouseState	Retrieve the current state of the mouse
SDL_GetAppState	Get the state of the application
SDL_JoystickEventState	Enable/disable joystick event polling

Prev	Home	Next
SDLKey	Up	SDL_PumpEvents

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/eventstructures.html --- a/docs/html/eventstructures.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,233 +0,0 @@ -SDL Event Structures.

SDL Library Documentation
Prev	Chapter 8. Events	Next

SDL Event Structures.

Table of Contents
SDL_Event -- General event structure
SDL_ActiveEvent -- Application visibility event structure
SDL_KeyboardEvent -- Keyboard event structure
SDL_MouseMotionEvent -- Mouse motion event structure
SDL_MouseButtonEvent -- Mouse button event structure
SDL_JoyAxisEvent -- Joystick axis motion event structure
SDL_JoyButtonEvent -- Joystick button event structure
SDL_JoyHatEvent -- Joystick hat position change event structure
SDL_JoyBallEvent -- Joystick trackball motion event structure
SDL_ResizeEvent -- Window resize event structure
SDL_ExposeEvent -- Quit requested event
SDL_SysWMEvent -- Platform-dependent window manager event.
SDL_UserEvent -- A user-defined event type
SDL_QuitEvent -- Quit requested event
SDL_keysym -- Keysym structure
SDLKey -- Keysym definitions.

Prev	Home	Next
Events	Up	SDL_Event

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/general.html --- a/docs/html/general.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,225 +0,0 @@ -General

SDL Library Documentation
Prev		Next

Chapter 5. General

Table of Contents
SDL_Init -- Initializes SDL
SDL_InitSubSystem -- Initialize subsystems
SDL_QuitSubSystem -- Shut down a subsystem
SDL_Quit -- Shut down SDL
SDL_WasInit -- Check which subsystems are initialized
SDL_GetError -- Get SDL error string
SDL_envvars -- SDL environment variables

Before SDL can be used in a program it must be initialized with SDL_Init. SDL_Init initializes all the subsystems that the user requests (video, audio, joystick, timers and/or cdrom). Once SDL is initialized with SDL_Init subsystems can be shut down and initialized as needed using SDL_InitSubSystem and SDL_QuitSubSystem.

SDL must also be shut down before the program exits to make sure it cleans up correctly. Calling SDL_Quit shuts down all subsystems and frees any resources allocated to SDL.

Prev	Home	Next
SDL Reference	Up	SDL_Init

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guide.html --- a/docs/html/guide.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,174 +0,0 @@ -SDL Guide

SDL Library Documentation
Prev		Next

I. SDL Guide

Table of Contents
Preface
1. The Basics
2. Graphics and Video
3. Input handling
4. Examples

Prev	Home	Next
SDL Library Documentation		Preface

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guideaboutsdldoc.html --- a/docs/html/guideaboutsdldoc.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,148 +0,0 @@ -About SDLdoc

SDL Library Documentation
Prev	Preface	Next

About 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.

The latest version of this documentation can always be found here: http://sdldoc.csn.ul.ie Downloadable PS, man pages and html tarballs are available at http://sdldoc.csn.ul.ie/pub/

Prev	Home	Next
Preface	Up	Credits

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guideaudioexamples.html --- a/docs/html/guideaudioexamples.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,228 +0,0 @@ -Audio Examples

SDL Library Documentation
Prev	Chapter 4. Examples	Next

Audio Examples

Opening the audio device

    SDL_AudioSpec wanted;
-    extern void fill_audio(void *udata, Uint8 *stream, int len);
-
-    /* Set the audio format */
-    wanted.freq = 22050;
-    wanted.format = AUDIO_S16;
-    wanted.channels = 2;    /* 1 = mono, 2 = stereo */
-    wanted.samples = 1024;  /* Good low-latency value for callback */
-    wanted.callback = fill_audio;
-    wanted.userdata = NULL;
-
-    /* Open the audio device, forcing the desired format */
-    if ( SDL_OpenAudio(&wanted, NULL) < 0 ) {
-        fprintf(stderr, "Couldn't open audio: %s\n", SDL_GetError());
-        return(-1);
-    }
-    return(0);

Playing audio

    static Uint8 *audio_chunk;
-    static Uint32 audio_len;
-    static Uint8 *audio_pos;
-
-    /* The audio function callback takes the following parameters:
-       stream:  A pointer to the audio buffer to be filled
-       len:     The length (in bytes) of the audio buffer
-    */
-    void fill_audio(void *udata, Uint8 *stream, int len)
-    {
-        /* Only play if we have data left */
-        if ( audio_len == 0 )
-            return;
-
-        /* Mix as much data as possible */
-        len = ( len > audio_len ? audio_len : len );
-        SDL_MixAudio(stream, audio_pos, len, SDL_MIX_MAXVOLUME);
-        audio_pos += len;
-        audio_len -= len;
-    }
-
-    /* Load the audio data ... */
-
-    ;;;;;
-
-    audio_pos = audio_chunk;
-
-    /* Let the callback function play the audio chunk */
-    SDL_PauseAudio(0);
-
-    /* Do some processing */
-
-    ;;;;;
-
-    /* Wait for sound to complete */
-    while ( audio_len > 0 ) {
-        SDL_Delay(100);         /* Sleep 1/10 second */
-    }
-    SDL_CloseAudio();

Prev	Home	Next
Event Examples	Up	CDROM Examples

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guidebasicsinit.html --- a/docs/html/guidebasicsinit.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,240 +0,0 @@ -Initializing SDL

SDL Library Documentation
Prev	Chapter 1. The Basics	Next

Initializing 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 SDL_Init (or SDL_InitSubSystem). SDL_Init must be called before any other SDL function. It automatically initializes the Event Handling, File I/O and Threading subsystems and it takes a parameter specifying which other subsystems to initialize. So, to initialize the default subsystems and the Video subsystems you would call: -

    SDL_Init ( SDL_INIT_VIDEO );

-To initialize the default subsystems, the Video subsystem and the Timers subsystem you would call: -

    SDL_Init ( SDL_INIT_VIDEO | SDL_INIT_TIMER );

SDL_Init is complemented by SDL_Quit (and SDL_QuitSubSystem). SDL_Quit shuts down all subsystems, including the default ones. It should always be called before a SDL application exits.

With SDL_Init and SDL_Quit firmly embedded in your programmers toolkit you can write your first and most basic SDL application. However, we must be prepare to handle errors. Many SDL functions return a value and indicates whether the function has succeeded or failed, SDL_Init, for instance, returns -1 if it could not initialize a subsystem. SDL provides a useful facility that allows you to determine exactly what the problem was, every time an error occurs within SDL an error message is stored which can be retrieved using SDL_GetError. Use this often, you can never know too much about an error.

Example 1-1. Initializing SDL

#include "SDL.h"   /* All SDL App's need this */
-#include <stdio.h>
-
-int main(int argc, char *argv[]) {
-    
-    printf("Initializing SDL.\n");
-    
-    /* Initialize defaults, Video and Audio */
-    if((SDL_Init(SDL_INIT_VIDEO|SDL_INIT_AUDIO)==-1)) { 
-        printf("Could not initialize SDL: %s.\n", SDL_GetError());
-        exit(-1);
-    }
-
-    printf("SDL initialized.\n");
-
-    printf("Quiting SDL.\n");
-    
-    /* Shutdown all subsystems */
-    SDL_Quit();
-    
-    printf("Quiting....\n");
-
-    exit(0);
-}

Prev	Home	Next
The Basics	Up	Graphics and Video

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guidecdromexamples.html --- a/docs/html/guidecdromexamples.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,275 +0,0 @@ -CDROM Examples

SDL Library Documentation
Prev	Chapter 4. Examples	Next

CDROM Examples

Listing CD-ROM drives

    #include "SDL.h"
-
-    /* Initialize SDL first */
-    if ( SDL_Init(SDL_INIT_CDROM) < 0 ) {
-        fprintf(stderr, "Couldn't initialize SDL: %s\n",SDL_GetError());
-        exit(1);
-    }
-    atexit(SDL_Quit);
-
-    /* Find out how many CD-ROM drives are connected to the system */
-    printf("Drives available: %d\n", SDL_CDNumDrives());
-    for ( i=0; i<SDL_CDNumDrives(); ++i ) {
-        printf("Drive %d:  \"%s\"\n", i, SDL_CDName(i));
-    }

Opening the default drive

    SDL_CD *cdrom;
-    CDstatus status;
-    char *status_str;
-
-    cdrom = SDL_CDOpen(0);
-    if ( cdrom == NULL ) {
-        fprintf(stderr, "Couldn't open default CD-ROM drive: %s\n",
-                        SDL_GetError());
-        exit(2);
-    }
-
-    status = SDL_CDStatus(cdrom);
-    switch (status) {
-        case CD_TRAYEMPTY:
-            status_str = "tray empty";
-            break;
-        case CD_STOPPED:
-            status_str = "stopped";
-            break;
-        case CD_PLAYING:
-            status_str = "playing";
-            break;
-        case CD_PAUSED:
-            status_str = "paused";
-            break;
-        case CD_ERROR:
-            status_str = "error state";
-            break;
-    }
-    printf("Drive status: %s\n", status_str);
-    if ( status >= CD_PLAYING ) {
-        int m, s, f;
-        FRAMES_TO_MSF(cdrom->cur_frame, &m, &s, &f);
-        printf("Currently playing track %d, %d:%2.2d\n",
-        cdrom->track[cdrom->cur_track].id, m, s);
-    }

Listing the tracks on a CD

    SDL_CD *cdrom;          /* Assuming this has already been set.. */
-    int i;
-    int m, s, f;
-
-    SDL_CDStatus(cdrom);
-    printf("Drive tracks: %d\n", cdrom->numtracks);
-    for ( i=0; i<cdrom->numtracks; ++i ) {
-        FRAMES_TO_MSF(cdrom->track[i].length, &m, &s, &f);
-        if ( f > 0 )
-            ++s;
-        printf("\tTrack (index %d) %d: %d:%2.2d\n", i,
-        cdrom->track[i].id, m, s);
-    }

Play an entire CD

    SDL_CD *cdrom;          /* Assuming this has already been set.. */
-
-    // Play entire CD:
-    if ( CD_INDRIVE(SDL_CDStatus(cdrom)) )
-        SDL_CDPlayTracks(cdrom, 0, 0, 0, 0);
-
-        // Play last track:
-        if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) {
-            SDL_CDPlayTracks(cdrom, cdrom->numtracks-1, 0, 0, 0);
-        }
-
-        // Play first and second track and 10 seconds of third track:
-        if ( CD_INDRIVE(SDL_CDStatus(cdrom)) )
-            SDL_CDPlayTracks(cdrom, 0, 0, 2, CD_FPS * 10);

Prev	Home	Next
Audio Examples	Up	Time Examples

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guidecredits.html --- a/docs/html/guidecredits.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,195 +0,0 @@ -Credits

SDL Library Documentation
Prev	Preface	Next

Credits

Sam Lantinga, slouken@libsdl.org

Martin Donlon, akawaka@skynet.ie

Mattias Engdeg�rd

Julian Peterson

Ken Jordan

Maxim Sobolev

Wesley Poole

Michael Vance

Andreas Umbach

Andreas Hofmeister

Prev	Home	Next
About SDLdoc	Up	The Basics

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guideeventexamples.html --- a/docs/html/guideeventexamples.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,247 +0,0 @@ -Event Examples

SDL Library Documentation
Prev	Chapter 4. Examples	Next

Event Examples

Filtering and Handling Events

#include <stdio.h>
-#include <stdlib.h>
-
-#include "SDL.h"
-
-/* This function may run in a separate event thread */
-int FilterEvents(const SDL_Event *event) {
-    static int boycott = 1;
-
-    /* This quit event signals the closing of the window */
-    if ( (event->type == SDL_QUIT) && boycott ) {
-        printf("Quit event filtered out -- try again.\n");
-        boycott = 0;
-        return(0);
-    }
-    if ( event->type == SDL_MOUSEMOTION ) {
-        printf("Mouse moved to (%d,%d)\n",
-                event->motion.x, event->motion.y);
-        return(0);    /* Drop it, we've handled it */
-    }
-    return(1);
-}
-
-int main(int argc, char *argv[])
-{
-    SDL_Event event;
-
-    /* Initialize the SDL library (starts the event loop) */
-    if ( SDL_Init(SDL_INIT_VIDEO) < 0 ) {
-        fprintf(stderr,
-                "Couldn't initialize SDL: %s\n", SDL_GetError());
-        exit(1);
-    }
-
-    /* Clean up on exit, exit on window close and interrupt */
-    atexit(SDL_Quit);
-
-    /* Ignore key events */
-    SDL_EventState(SDL_KEYDOWN, SDL_IGNORE);
-    SDL_EventState(SDL_KEYUP, SDL_IGNORE);
-
-    /* Filter quit and mouse motion events */
-    SDL_SetEventFilter(FilterEvents);
-
-    /* The mouse isn't much use unless we have a display for reference */
-    if ( SDL_SetVideoMode(640, 480, 8, 0) == NULL ) {
-        fprintf(stderr, "Couldn't set 640x480x8 video mode: %s\n",
-                        SDL_GetError());
-        exit(1);
-    }
-
-    /* Loop waiting for ESC+Mouse_Button */
-    while ( SDL_WaitEvent(&event) >= 0 ) {
-        switch (event.type) {
-            case SDL_ACTIVEEVENT: {
-                if ( event.active.state & SDL_APPACTIVE ) {
-                    if ( event.active.gain ) {
-                        printf("App activated\n");
-                    } else {
-                        printf("App iconified\n");
-                    }
-                }
-            }
-            break;
-                    
-            case SDL_MOUSEBUTTONDOWN: {
-                Uint8 *keys;
-
-                keys = SDL_GetKeyState(NULL);
-                if ( keys[SDLK_ESCAPE] == SDL_PRESSED ) {
-                    printf("Bye bye...\n");
-                    exit(0);
-                }
-                printf("Mouse button pressed\n");
-            }
-            break;
-
-            case SDL_QUIT: {
-                printf("Quit requested, quitting.\n");
-                exit(0);
-            }
-            break;
-        }
-    }
-    /* This should never happen */
-    printf("SDL_WaitEvent error: %s\n", SDL_GetError());
-    exit(1);
-}

Prev	Home	Next
Examples	Up	Audio Examples

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guideexamples.html --- a/docs/html/guideexamples.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,188 +0,0 @@ -Examples

SDL Library Documentation
Prev		Next

Chapter 4. Examples

Table of Contents
Introduction
Event Examples
Audio Examples
CDROM Examples
Time Examples

Introduction

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.

Prev	Home	Next
Handling the Keyboard	Up	Event Examples

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guideinput.html --- a/docs/html/guideinput.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,739 +0,0 @@ -Input handling

SDL Library Documentation
Prev		Next

Chapter 3. Input handling

Table of Contents
Handling Joysticks
Handling the Keyboard

Handling Joysticks

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 SDL_INIT_JOYSTICK flag to SDL_Init. The joystick flag will usually be used in conjunction with other flags (like the video flag) because the joystick is usually used to control something.

Example 3-1. Initializing SDL with Joystick Support

    if (SDL_Init( SDL_INIT_VIDEO | SDL_INIT_JOYSTICK ) < 0)
-    {
-        fprintf(stderr, "Couldn't initialize SDL: %s\n", SDL_GetError());
-        exit(1);
-    }

This will attempt to start SDL with both the video and the joystick subsystems activated.

Querying

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 SDL_NumJoysticks.

This function simply returns the number of joysticks available on the system. If it is at least one then we are in good shape. The next step is to determine which joystick the user wants to use. If the number of joysticks available is only one then it is safe to assume that one joystick is the one the user wants to use. SDL has a function to get the name of the joysticks as assigned by the operations system and that function is SDL_JoystickName. The joystick is specified by an index where 0 is the first joystick and the last joystick is the number returned by SDL_NumJoysticks - 1. In the demonstration a list of all available joysticks is printed to stdout.

Example 3-2. Querying the Number of Available Joysticks

    printf("%i joysticks were found.\n\n", SDL_NumJoysticks() );
-    printf("The names of the joysticks are:\n");
-		
-    for( i=0; i < SDL_NumJoysticks(); i++ ) 
-    {
-        printf("    %s\n", SDL_JoystickName(i));
-    }

Opening 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: -

SDL_JoyAxisEvent	Occurs when an axis changes
SDL_JoyBallEvent	Occurs when a joystick trackball's position changes
SDL_JoyHatEvent	Occurs when a hat's position changes
SDL_JoyButtonEvent	Occurs when a button is pressed or released

Events are received from all joysticks opened. The first thing that needs to be done in order to receive joystick events is to call SDL_JoystickEventState with the SDL_ENABLE flag. Next you must open the joysticks that you want to receive envents from. This is done with the SDL_JoystickOpen function. For the example we are only interested in events from the first joystick on the system, regardless of what it may be. To receive events from it we would do this:

Example 3-3. Opening a Joystick

    SDL_Joystick *joystick;
-
-    SDL_JoystickEventState(SDL_ENABLE);
-    joystick = SDL_JoystickOpen(0);

If we wanted to receive events for other joysticks we would open them with calls to SDL_JoystickOpen just like we opened joystick 0, except we would store the SDL_Joystick structure they return in a different pointer. We only need the joystick pointer when we are querying the joysticks or when we are closing the joystick.

Up to this point all the code we have is used just to initialize the joysticks in order to read values at run time. All we need now is an event loop, which is something that all SDL programs should have anyway to receive the systems quit events. We must now add code to check the event loop for at least some of the above mentioned events. Let's assume our event loop looks like this: -

    SDL_Event event;
-    /* Other initializtion code goes here */   
-
-    /* Start main game loop here */
-
-    while(SDL_PollEvent(&event))
-    {  
-        switch(event.type)
-        {  
-            case SDL_KEYDOWN:
-            /* handle keyboard stuff here */				
-            break;
-
-            case SDL_QUIT:
-            /* Set whatever flags are necessary to */
-            /* end the main game loop here */
-            break;
-        }
-    }
-
-    /* End loop here */

-To handle Joystick events we merely add cases for them, first we'll add axis handling code. Axis checks can get kinda of tricky because alot of the joystick events received are junk. Joystick axis have a tendency to vary just a little between polling due to the way they are designed. To compensate for this you have to set a threshold for changes and ignore the events that have'nt exceeded the threshold. 10% is usually a good threshold value. This sounds a lot more complicated than it is. Here is the Axis event handler:

Example 3-4. Joystick Axis Events

    case SDL_JOYAXISMOTION:  /* Handle Joystick Motion */
-    if ( ( event.jaxis.value < -3200 ) || (event.jaxis.value > 3200 ) ) 
-    {
-      /* code goes here */
-    }
-    break;

Another trick with axis events is that up-down and left-right movement are two different sets of axes. The most important axis is axis 0 (left-right) and axis 1 (up-down). To handle them seperatly in the code we do the following:

Example 3-5. More Joystick Axis Events

    case SDL_JOYAXISMOTION:  /* Handle Joystick Motion */
-    if ( ( event.jaxis.value < -3200 ) || (event.jaxis.value > 3200 ) ) 
-    {
-        if( event.jaxis.axis == 0) 
-        {
-            /* Left-right movement code goes here */
-        }
-
-        if( event.jaxis.axis == 1) 
-        {
-            /* Up-Down movement code goes here */
-        }
-    }
-    break;

Ideally the code here should use event.jaxis.value to scale something. For example lets assume you are using the joystick to control the movement of a spaceship. If the user is using an analog joystick and they push the stick a little bit they expect to move less than if they pushed it a lot. Designing your code for this situation is preferred because it makes the experience for users of analog controls better and remains the same for users of digital controls.

If your joystick has any additional axis then they may be used for other sticks or throttle controls and those axis return values too just with different event.jaxis.axis values.

Button handling is simple compared to the axis checking.

Example 3-6. Joystick Button Events

    case SDL_JOYBUTTONDOWN:  /* Handle Joystick Button Presses */
-    if ( event.jbutton.button == 0 ) 
-    {
-        /* code goes here */
-    }
-    break;

Button checks are simpler than axis checks because a button can only be pressed or not pressed. The SDL_JOYBUTTONDOWN event is triggered when a button is pressed and the SDL_JOYBUTTONUP event is fired when a button is released. We do have to know what button was pressed though, that is done by reading the event.jbutton.button field.

Lastly when we are through using our joysticks we should close them with a call to SDL_JoystickClose. To close our opened joystick 0 we would do this at the end of our program: -

    SDL_JoystickClose(joystick);

Advanced 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:

Example 3-7. Joystick Ball Events

    case SDL_JOYBALLMOTION:  /* Handle Joyball Motion */
-    if( event.jball.ball == 0 )
-    {
-      /* ball handling */
-    }
-    break;

The above checks the first joyball on the joystick. The change in position will be stored in event.jball.xrel and event.jball.yrel.

Finally we have the hat event. Hats report only the direction they are pushed in. We check hat's position with the bitmasks: - -

SDL_HAT_CENTERED

SDL_HAT_UP

SDL_HAT_RIGHT

SDL_HAT_DOWN

SDL_HAT_LEFT

- -Also there are some predefined combinations of the above: -

SDL_HAT_RIGHTUP

SDL_HAT_RIGHTDOWN

SDL_HAT_LEFTUP

SDL_HAT_LEFTDOWN

- -Our case for the hat may resemble the following:

Example 3-8. Joystick Hat Events

    case SDL_JOYHATMOTION:  /* Handle Hat Motion */
-    if ( event.jhat.value & SDL_HAT_UP )
-    {
-        /* Do up stuff here */
-    }
-
-    if ( event.jhat.value & SDL_HAT_LEFT )
-    {
-        /* Do left stuff here */
-    }
-
-    if ( event.jhat.value & SDL_HAT_RIGHTDOWN )
-    {
-        /* Do right and down together stuff here */
-    }
-    break;

In addition to the queries for number of joysticks on the system and their names there are additional functions to query the capabilities of attached joysticks: -

`SDL_JoystickNumAxes`	Returns the number of joysitck axes
`SDL_JoystickNumButtons`	Returns the number of joysitck buttons
`SDL_JoystickNumBalls`	Returns the number of joysitck balls
`SDL_JoystickNumHats`	Returns the number of joysitck hats

- -To use these functions we just have to pass in the joystick structure we got when we opened the joystick. For Example:

Example 3-9. Querying Joystick Characteristics

    int number_of_buttons;
-    SDL_Joystick *joystick;
-
-    joystick = SDL_JoystickOpen(0);
-    number_of_buttons = SDL_JoystickNumButtons(joystick);

This block of code would get the number of buttons on the first joystick in the system.

Prev	Home	Next
Using OpenGL With SDL	Up	Handling the Keyboard

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guideinputkeyboard.html --- a/docs/html/guideinputkeyboard.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,746 +0,0 @@ -Handling the Keyboard

SDL Library Documentation
Prev	Chapter 3. Input handling	Next

Handling the Keyboard

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.

SDLKey

SDLKey is an enumerated type defined in SDL/include/SDL_keysym.h and detailed here. Each SDLKey symbol represents a key, SDLK_a corresponds to the 'a' key on a keyboard, SDLK_SPACE corresponds to the space bar, and so on.

SDLMod

SDLMod is an enumerated type, similar to SDLKey, however it enumerates keyboard modifiers (Control, Alt, Shift). The full list of modifier symbols is here. SDLMod values can be AND'd together to represent several modifiers.

SDL_keysym

typedef struct{
-  Uint8 scancode;
-  SDLKey sym;
-  SDLMod mod;
-  Uint16 unicode;
-} SDL_keysym;

The SDL_keysym structure describes a key press or a key release. The scancode field is hardware specific and should be ignored unless you know what your doing. The sym field is the SDLKey value of the key being pressed or released. The mod field describes the state of the keyboard modifiers at the time the key press or release occurred. So a value of KMOD_NUM | KMOD_CAPS | KMOD_LSHIFT would mean that Numlock, Capslock and the left shift key were all press (or enabled in the case of the lock keys). Finally, the unicode field stores the 16-bit unicode value of the key.

Note: It should be noted and understood that this field is only valid when the SDL_keysym is describing a key press, not a key release. Unicode values only make sense on a key press because the unicode value describes an international character and only key presses produce characters. More information on Unicode can be found at www.unicode.org

Note: Unicode translation must be enabled using the SDL_EnableUNICODE function.

SDL_KeyboardEvent

typedef struct{
-  Uint8 type;
-  Uint8 state;
-  SDL_keysym keysym;
-} SDL_KeyboardEvent;

The SDL_KeyboardEvent describes a keyboard event (obviously). The key member of the SDL_Event union is a SDL_KeyboardEvent structure. The type field specifies whether the event is a key release (SDL_KEYUP) or a key press (SDL_KEYDOWN) event. The state is largely redundant, it reports the same information as the type field but uses different values (SDL_RELEASED and SDL_PRESSED). The keysym contains information of the key press or release that this event represents (see above).

Reading Keyboard Events

Reading keybaord events from the event queue is quite simple (the event queue and using it is described here). We read events using SDL_PollEvent in a while() loop and check for SDL_KEYUP and SDL_KEYDOWN events using a switch statement, like so:

Example 3-10. Reading Keyboard Events

  SDL_Event event;
-  .
-  .
-  /* Poll for events. SDL_PollEvent() returns 0 when there are no  */
-  /* more events on the event queue, our while loop will exit when */
-  /* that occurs.                                                  */
-  while( SDL_PollEvent( &event ) ){
-    /* We are only worried about SDL_KEYDOWN and SDL_KEYUP events */
-    switch( event.type ){
-      case SDL_KEYDOWN:
-        printf( "Key press detected\n" );
-        break;
-
-      case SDL_KEYUP:
-        printf( "Key release detected\n" );
-        break;
-
-      default:
-        break;
-    }
-  }
-  .
-  .

This is a very basic example. No information about the key press or release is interpreted. We will explore the other extreme out our first full example below - reporting all available information about a keyboard event.

A More Detailed Look

Before we can read events SDL must be initialised with SDL_Init and a video mode must be set using SDL_SetVideoMode. There are, however, two other functions we must use to obtain all the information required. We must enable unicode translation by calling SDL_EnableUNICODE(1) and we must convert SDLKey values into something printable, using SDL_GetKeyName

Note: It is useful to note that unicode values < 0x80 translate directly a characters ASCII value. THis is used in the example below

Example 3-11. Interpreting Key Event Information

    #include "SDL.h"
-
-    /* Function Prototypes */
-    void PrintKeyInfo( SDL_KeyboardEvent *key );
-    void PrintModifiers( SDLMod mod );
-
-    /* main */
-    int main( int argc, char *argv[] ){
-        
-        SDL_Event event;
-        int quit = 0;
-        
-        /* Initialise SDL */
-        if( SDL_Init( SDL_INIT_VIDEO ) < 0){
-            fprintf( stderr, "Could not initialise SDL: %s\n", SDL_GetError() );
-            exit( -1 );
-        }
-
-        /* Set a video mode */
-        if( !SDL_SetVideoMode( 320, 200, 0, 0 ) ){
-            fprintf( stderr, "Could not set video mode: %s\n", SDL_GetError() );
-            SDL_Quit();
-            exit( -1 );
-        }
-
-        /* Enable Unicode translation */
-        SDL_EnableUNICODE( 1 );
-
-        /* Loop until an SDL_QUIT event is found */
-        while( !quit ){
-
-            /* Poll for events */
-            while( SDL_PollEvent( &event ) ){
-                
-                switch( event.type ){
-                    /* Keyboard event */
-                    /* Pass the event data onto PrintKeyInfo() */
-                    case SDL_KEYDOWN:
-                    case SDL_KEYUP:
-                        PrintKeyInfo( &event.key );
-                        break;
-
-                    /* SDL_QUIT event (window close) */
-                    case SDL_QUIT:
-                        quit = 1;
-                        break;
-
-                    default:
-                        break;
-                }
-
-            }
-
-        }
-
-        /* Clean up */
-        SDL_Quit();
-        exit( 0 );
-    }
-
-    /* Print all information about a key event */
-    void PrintKeyInfo( SDL_KeyboardEvent *key ){
-        /* Is it a release or a press? */
-        if( key->type == SDL_KEYUP )
-            printf( "Release:- " );
-        else
-            printf( "Press:- " );
-
-        /* Print the hardware scancode first */
-        printf( "Scancode: 0x%02X", key->keysym.scancode );
-        /* Print the name of the key */
-        printf( ", Name: %s", SDL_GetKeyName( key->keysym.sym ) );
-        /* We want to print the unicode info, but we need to make */
-        /* sure its a press event first (remember, release events */
-        /* don't have unicode info                                */
-        if( key->type == SDL_KEYDOWN ){
-            /* If the Unicode value is less than 0x80 then the    */
-            /* unicode value can be used to get a printable       */
-            /* representation of the key, using (char)unicode.    */
-            printf(", Unicode: " );
-            if( key->keysym.unicode < 0x80 && key->keysym.unicode > 0 ){
-                printf( "%c (0x%04X)", (char)key->keysym.unicode,
-                        key->keysym.unicode );
-            }
-            else{
-                printf( "? (0x%04X)", key->keysym.unicode );
-            }
-        }
-        printf( "\n" );
-        /* Print modifier info */
-        PrintModifiers( key->keysym.mod );
-    }
-
-    /* Print modifier info */
-    void PrintModifiers( SDLMod mod ){
-        printf( "Modifers: " );
-
-        /* If there are none then say so and return */
-        if( mod == KMOD_NONE ){
-            printf( "None\n" );
-            return;
-        }
-
-        /* Check for the presence of each SDLMod value */
-        /* This looks messy, but there really isn't    */
-        /* a clearer way.                              */
-        if( mod & KMOD_NUM ) printf( "NUMLOCK " );
-        if( mod & KMOD_CAPS ) printf( "CAPSLOCK " );
-        if( mod & KMOD_LCTRL ) printf( "LCTRL " );
-        if( mod & KMOD_RCTRL ) printf( "RCTRL " );
-        if( mod & KMOD_RSHIFT ) printf( "RSHIFT " );
-        if( mod & KMOD_LSHIFT ) printf( "LSHIFT " );
-        if( mod & KMOD_RALT ) printf( "RALT " );
-        if( mod & KMOD_LALT ) printf( "LALT " );
-        if( mod & KMOD_CTRL ) printf( "CTRL " );
-        if( mod & KMOD_SHIFT ) printf( "SHIFT " );
-        if( mod & KMOD_ALT ) printf( "ALT " );
-        printf( "\n" );
-    }

Game-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 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, 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 */
-    int alien_x=0, alien_y=0;
-    .
-    .
-    /* Initialise SDL and video modes and all that */
-    .
-    /* Main game loop */
-    /* Check for events */
-    while( SDL_PollEvent( &event ) ){
-        switch( event.type ){
-            /* Look for a keypress */
-            case SDL_KEYDOWN:
-                /* Check the SDLKey values and move change the coords */
-                switch( event.key.keysym.sym ){
-                    case SDLK_LEFT:
-                        alien_x -= 1;
-                        break;
-                    case SDLK_RIGHT:
-                        alien_x += 1;
-                        break;
-                    case SDLK_UP:
-                        alien_y -= 1;
-                        break;
-                    case SDLK_DOWN:
-                        alien_y += 1;
-                        break;
-                    default:
-                        break;
-                }
-            }
-        }
-    }
-    .
-    .

-At first glance you may think this is a perfectly reasonable piece of code for the task, but it isn't. Like I said keyboard events only occur when a key changes state, so the user would have to press and release the left cursor key 100 times to move the alien 100 pixels to the left.

To get around this problem we must not use the events to change the position of the alien, we use the events to set flags which are then used in a seperate section of code to move the alien. Something like this:

Example 3-12. Proper Game Movement

    /* Alien screen coordinates */
-    int alien_x=0, alien_y=0;
-    int alien_xvel=0, alien_yvel=0;
-    .
-    .
-    /* Initialise SDL and video modes and all that */
-    .
-    /* Main game loop */
-    /* Check for events */
-    while( SDL_PollEvent( &event ) ){
-        switch( event.type ){
-            /* Look for a keypress */
-            case SDL_KEYDOWN:
-                /* Check the SDLKey values and move change the coords */
-                switch( event.key.keysym.sym ){
-                    case SDLK_LEFT:
-                        alien_xvel = -1;
-                        break;
-                    case SDLK_RIGHT:
-                        alien_xvel =  1;
-                        break;
-                    case SDLK_UP:
-                        alien_yvel = -1;
-                        break;
-                    case SDLK_DOWN:
-                        alien_yvel =  1;
-                        break;
-                    default:
-                        break;
-                }
-                break;
-            /* We must also use the SDL_KEYUP events to zero the x */
-            /* and y velocity variables. But we must also be       */
-            /* careful not to zero the velocities when we shouldn't*/
-            case SDL_KEYUP:
-                switch( event.key.keysym.sym ){
-                    case SDLK_LEFT:
-                        /* We check to make sure the alien is moving */
-                        /* to the left. If it is then we zero the    */
-                        /* velocity. If the alien is moving to the   */
-                        /* right then the right key is still press   */
-                        /* so we don't tocuh the velocity            */
-                        if( alien_xvel < 0 )
-                            alien_xvel = 0;
-                        break;
-                    case SDLK_RIGHT:
-                        if( alien_xvel > 0 )
-                            alien_xvel = 0;
-                        break;
-                    case SDLK_UP:
-                        if( alien_yvel < 0 )
-                            alien_yvel = 0;
-                        break;
-                    case SDLK_DOWN:
-                        if( alien_yvel > 0 )
-                            alien_yvel = 0;
-                        break;
-                    default:
-                        break;
-                }
-                break;
-            
-            default:
-                break;
-        }
-    }
-    .
-    .
-    /* Update the alien position */
-    alien_x += alien_xvel;
-    alien_y += alien_yvel;

As can be seen, we use two extra variables, alien_xvel and alien_yvel, which represent the motion of the ship, it is these variables that we update when we detect keypresses and releases.

Prev	Home	Next
Input handling	Up	Examples

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guidepreface.html --- a/docs/html/guidepreface.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,178 +0,0 @@ -Preface

SDL Library Documentation
Prev		Next

Preface

Table of Contents
About SDL
About SDLdoc
Credits

About 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.

Prev	Home	Next
SDL Guide	Up	About SDLdoc

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guidethebasics.html --- a/docs/html/guidethebasics.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,173 +0,0 @@ -The Basics

SDL Library Documentation
Prev		Next

Chapter 1. The Basics

Table of Contents
Introduction
Initializing SDL

Introduction

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/.

Prev	Home	Next
Credits	Up	Initializing SDL

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guidetimeexamples.html --- a/docs/html/guidetimeexamples.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,183 +0,0 @@ -Time Examples

SDL Library Documentation
Prev	Chapter 4. Examples	Next

Time Examples

Time based game loop

#define TICK_INTERVAL    30
-
-static Uint32 next_time;
-
-Uint32 time_left(void)
-{
-    Uint32 now;
-
-    now = SDL_GetTicks();
-    if(next_time <= now)
-        return 0;
-    else
-        return next_time - now;
-}
-
-
-/* main game loop */
-
-    next_time = SDL_GetTicks() + TICK_INTERVAL;
-    while ( game_running ) {
-        update_game_state();
-        SDL_Delay(time_left());
-        next_time += TICK_INTERVAL;
-    }

Prev	Home	Next
CDROM Examples	Up	SDL Reference

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guidevideo.html --- a/docs/html/guidevideo.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,463 +0,0 @@ -Graphics and Video

SDL Library Documentation
Prev		Next

Chapter 2. Graphics and Video

Table of Contents
Introduction to SDL Video
Using OpenGL With SDL

Introduction 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 -examples to demonstrate the basics.

Initializing the Video Display

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

Example 2-1. 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,
-     * requesting a software surface
-     */
-    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

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 -use SDL_VideoModeOK() to find the native video mode that is closest to -the mode you request.

Example 2-2. 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

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

Example 2-3. Loading and Displaying a BMP File

void display_bmp(char *file_name)
-{
-    SDL_Surface *image;
-
-    /* Load the BMP file into a surface */
-    image = SDL_LoadBMP(file_name);
-    if (image == NULL) {
-        fprintf(stderr, "Couldn't load %s: %s\n", file_name, SDL_GetError());
-        return;
-    }
-
-    /*
-     * Palettized screen modes will have a default palette (a standard
-     * 8*8*4 colour cube), but if the image is palettized as well we can
-     * use that palette for a nicer colour matching
-     */
-    if (image->format->palette && screen->format->palette) {
-    SDL_SetColors(screen, image->format->palette->colors, 0,
-                  image->format->palette->ncolors);
-    }
-
-    /* Blit onto the screen surface */
-    if(SDL_BlitSurface(image, NULL, screen, NULL) < 0)
-        fprintf(stderr, "BlitSurface error: %s\n", SDL_GetError());
-
-    SDL_UpdateRect(screen, 0, 0, image->w, image->h);
-
-    /* Free the allocated BMP surface */
-    SDL_FreeSurface(image);
-}

Drawing 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 -currently supported by SDL. Remember to lock the surface before -calling them, and to unlock it before calling any other SDL -functions.

To convert between pixel values and their red, green, blue -components, use SDL_GetRGB() and SDL_MapRGB().

Example 2-4. getpixel()

/*
- * Return the pixel value at (x, y)
- * NOTE: The surface must be locked before calling this!
- */
-Uint32 getpixel(SDL_Surface *surface, int x, int y)
-{
-    int bpp = surface->format->BytesPerPixel;
-    /* Here p is the address to the pixel we want to retrieve */
-    Uint8 *p = (Uint8 *)surface->pixels + y * surface->pitch + x * bpp;
-
-    switch(bpp) {
-    case 1:
-        return *p;
-
-    case 2:
-        return *(Uint16 *)p;
-
-    case 3:
-        if(SDL_BYTEORDER == SDL_BIG_ENDIAN)
-            return p[0] << 16 | p[1] << 8 | p[2];
-        else
-            return p[0] | p[1] << 8 | p[2] << 16;
-
-    case 4:
-        return *(Uint32 *)p;
-
-    default:
-        return 0;       /* shouldn't happen, but avoids warnings */
-    }
-}

Example 2-5. putpixel()

/*
- * Set the pixel at (x, y) to the given value
- * NOTE: The surface must be locked before calling this!
- */
-void putpixel(SDL_Surface *surface, int x, int y, Uint32 pixel)
-{
-    int bpp = surface->format->BytesPerPixel;
-    /* Here p is the address to the pixel we want to set */
-    Uint8 *p = (Uint8 *)surface->pixels + y * surface->pitch + x * bpp;
-
-    switch(bpp) {
-    case 1:
-        *p = pixel;
-        break;
-
-    case 2:
-        *(Uint16 *)p = pixel;
-        break;
-
-    case 3:
-        if(SDL_BYTEORDER == SDL_BIG_ENDIAN) {
-            p[0] = (pixel >> 16) & 0xff;
-            p[1] = (pixel >> 8) & 0xff;
-            p[2] = pixel & 0xff;
-        } else {
-            p[0] = pixel & 0xff;
-            p[1] = (pixel >> 8) & 0xff;
-            p[2] = (pixel >> 16) & 0xff;
-        }
-        break;
-
-    case 4:
-        *(Uint32 *)p = pixel;
-        break;
-    }
-}

The following code uses the putpixel() function above to set a -yellow pixel in the middle of the screen.

Example 2-6. Using putpixel()

    /* Code to set a yellow pixel at the center of the screen */
-
-    int x, y;
-    Uint32 yellow;
-
-    /* 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.
-    */
-    yellow = SDL_MapRGB(screen->format, 0xff, 0xff, 0x00);
-
-    x = screen->w / 2;
-    y = screen->h / 2;
-
-    /* Lock the screen for direct access to the pixels */
-    if ( SDL_MUSTLOCK(screen) ) {
-        if ( SDL_LockSurface(screen) < 0 ) {
-            fprintf(stderr, "Can't lock screen: %s\n", SDL_GetError());
-            return;
-        }
-    }
-
-    putpixel(screen, x, y, yellow);
-
-    if ( SDL_MUSTLOCK(screen) ) {
-        SDL_UnlockSurface(screen);
-    }
-    /* Update just the part of the display that we've changed */
-    SDL_UpdateRect(screen, x, y, 1, 1);
-
-    return;

Prev	Home	Next
Initializing SDL	Up	Using OpenGL With SDL

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/guidevideoopengl.html --- a/docs/html/guidevideoopengl.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,730 +0,0 @@ -Using OpenGL With SDL

SDL Library Documentation
Prev	Chapter 2. Graphics and Video	Next

Using OpenGL With SDL

SDL has the ability to create and use OpenGL contexts on several platforms(Linux/X11, Win32, BeOS, MacOS Classic/Toolbox, Mac OS 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).

Initialisation

Initialising SDL to use OpenGL is not very different to initialising SDL normally. There are three differences; you must pass SDL_OPENGL to SDL_SetVideoMode, you must specify several GL attributes (depth buffer size, framebuffer sizes) using SDL_GL_SetAttribute and finally, if you wish to use double buffering you must specify it as a GL attribute, not by passing the SDL_DOUBLEBUF flag to SDL_SetVideoMode.

Example 2-7. Initializing SDL with OpenGL

    /* Information about the current video settings. */
-    const SDL_VideoInfo* info = NULL;
-    /* Dimensions of our window. */
-    int width = 0;
-    int height = 0;
-    /* Color depth in bits of our window. */
-    int bpp = 0;
-    /* Flags we will pass into SDL_SetVideoMode. */
-    int flags = 0;
-
-    /* First, initialize SDL's video subsystem. */
-    if( SDL_Init( SDL_INIT_VIDEO ) < 0 ) {
-        /* Failed, exit. */
-        fprintf( stderr, "Video initialization failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
-    }
-
-    /* Let's get some video information. */
-    info = SDL_GetVideoInfo( );
-
-    if( !info ) {
-        /* This should probably never happen. */
-        fprintf( stderr, "Video query failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
-    }
-
-    /*
-     * Set our width/height to 640/480 (you would
-     * of course let the user decide this in a normal
-     * app). We get the bpp we will request from
-     * the display. On X11, VidMode can't change
-     * resolution, so this is probably being overly
-     * safe. Under Win32, ChangeDisplaySettings
-     * can change the bpp.
-     */
-    width = 640;
-    height = 480;
-    bpp = info->vfmt->BitsPerPixel;
-
-    /*
-     * Now, we want to setup our requested
-     * window attributes for our OpenGL window.
-     * We want *at least* 5 bits of red, green
-     * and blue. We also want at least a 16-bit
-     * depth buffer.
-     *
-     * The last thing we do is request a double
-     * buffered window. '1' turns on double
-     * buffering, '0' turns it off.
-     *
-     * Note that we do not use SDL_DOUBLEBUF in
-     * the flags to SDL_SetVideoMode. That does
-     * not affect the GL attribute state, only
-     * the standard 2D blitting setup.
-     */
-    SDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 );
-    SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 );
-
-    /*
-     * We want to request that SDL provide us
-     * with an OpenGL window, in a fullscreen
-     * video mode.
-     *
-     * EXERCISE:
-     * Make starting windowed an option, and
-     * handle the resize events properly with
-     * glViewport.
-     */
-    flags = SDL_OPENGL | SDL_FULLSCREEN;
-
-    /*
-     * Set the video mode
-     */
-    if( SDL_SetVideoMode( width, height, bpp, flags ) == 0 ) {
-        /* 
-         * This could happen for a variety of reasons,
-         * including DISPLAY not being set, the specified
-         * resolution not being available, etc.
-         */
-        fprintf( stderr, "Video mode set failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
-    }

Drawing

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 -data types. However if you are using a double-buffered display, then you must -use -SDL_GL_SwapBuffers() -to swap the buffers and update the display. To request double-buffering -with OpenGL, use -SDL_GL_SetAttribute -with SDL_GL_DOUBLEBUFFER, and use -SDL_GL_GetAttribute -to see if you actually got it.

A full example code listing is now presented below.

Example 2-8. SDL and OpenGL

/*
- * SDL OpenGL Tutorial.
- * (c) Michael Vance, 2000
- * briareos@lokigames.com
- *
- * Distributed under terms of the LGPL. 
- */
-
-#include <SDL/SDL.h>
-#include <GL/gl.h>
-#include <GL/glu.h>
-
-#include <stdio.h>
-#include <stdlib.h>
-
-static GLboolean should_rotate = GL_TRUE;
-
-static void quit_tutorial( int code )
-{
-    /*
-     * Quit SDL so we can release the fullscreen
-     * mode and restore the previous video settings,
-     * etc.
-     */
-    SDL_Quit( );
-
-    /* Exit program. */
-    exit( code );
-}
-
-static void handle_key_down( SDL_keysym* keysym )
-{
-
-    /* 
-     * We're only interested if 'Esc' has
-     * been presssed.
-     *
-     * EXERCISE: 
-     * Handle the arrow keys and have that change the
-     * viewing position/angle.
-     */
-    switch( keysym->sym ) {
-    case SDLK_ESCAPE:
-        quit_tutorial( 0 );
-        break;
-    case SDLK_SPACE:
-        should_rotate = !should_rotate;
-        break;
-    default:
-        break;
-    }
-
-}
-
-static void process_events( void )
-{
-    /* Our SDL event placeholder. */
-    SDL_Event event;
-
-    /* Grab all the events off the queue. */
-    while( SDL_PollEvent( &event ) ) {
-
-        switch( event.type ) {
-        case SDL_KEYDOWN:
-            /* Handle key presses. */
-            handle_key_down( &event.key.keysym );
-            break;
-        case SDL_QUIT:
-            /* Handle quit requests (like Ctrl-c). */
-            quit_tutorial( 0 );
-            break;
-        }
-
-    }
-
-}
-
-static void draw_screen( void )
-{
-    /* Our angle of rotation. */
-    static float angle = 0.0f;
-
-    /*
-     * EXERCISE:
-     * Replace this awful mess with vertex
-     * arrays and a call to glDrawElements.
-     *
-     * EXERCISE:
-     * After completing the above, change
-     * it to use compiled vertex arrays.
-     *
-     * EXERCISE:
-     * Verify my windings are correct here ;).
-     */
-    static GLfloat v0[] = { -1.0f, -1.0f,  1.0f };
-    static GLfloat v1[] = {  1.0f, -1.0f,  1.0f };
-    static GLfloat v2[] = {  1.0f,  1.0f,  1.0f };
-    static GLfloat v3[] = { -1.0f,  1.0f,  1.0f };
-    static GLfloat v4[] = { -1.0f, -1.0f, -1.0f };
-    static GLfloat v5[] = {  1.0f, -1.0f, -1.0f };
-    static GLfloat v6[] = {  1.0f,  1.0f, -1.0f };
-    static GLfloat v7[] = { -1.0f,  1.0f, -1.0f };
-    static GLubyte red[]    = { 255,   0,   0, 255 };
-    static GLubyte green[]  = {   0, 255,   0, 255 };
-    static GLubyte blue[]   = {   0,   0, 255, 255 };
-    static GLubyte white[]  = { 255, 255, 255, 255 };
-    static GLubyte yellow[] = {   0, 255, 255, 255 };
-    static GLubyte black[]  = {   0,   0,   0, 255 };
-    static GLubyte orange[] = { 255, 255,   0, 255 };
-    static GLubyte purple[] = { 255,   0, 255,   0 };
-
-    /* Clear the color and depth buffers. */
-    glClear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT );
-
-    /* We don't want to modify the projection matrix. */
-    glMatrixMode( GL_MODELVIEW );
-    glLoadIdentity( );
-
-    /* Move down the z-axis. */
-    glTranslatef( 0.0, 0.0, -5.0 );
-
-    /* Rotate. */
-    glRotatef( angle, 0.0, 1.0, 0.0 );
-
-    if( should_rotate ) {
-
-        if( ++angle > 360.0f ) {
-            angle = 0.0f;
-        }
-
-    }
-
-    /* Send our triangle data to the pipeline. */
-    glBegin( GL_TRIANGLES );
-
-    glColor4ubv( red );
-    glVertex3fv( v0 );
-    glColor4ubv( green );
-    glVertex3fv( v1 );
-    glColor4ubv( blue );
-    glVertex3fv( v2 );
-
-    glColor4ubv( red );
-    glVertex3fv( v0 );
-    glColor4ubv( blue );
-    glVertex3fv( v2 );
-    glColor4ubv( white );
-    glVertex3fv( v3 );
-
-    glColor4ubv( green );
-    glVertex3fv( v1 );
-    glColor4ubv( black );
-    glVertex3fv( v5 );
-    glColor4ubv( orange );
-    glVertex3fv( v6 );
-
-    glColor4ubv( green );
-    glVertex3fv( v1 );
-    glColor4ubv( orange );
-    glVertex3fv( v6 );
-    glColor4ubv( blue );
-    glVertex3fv( v2 );
-
-    glColor4ubv( black );
-    glVertex3fv( v5 );
-    glColor4ubv( yellow );
-    glVertex3fv( v4 );
-    glColor4ubv( purple );
-    glVertex3fv( v7 );
-
-    glColor4ubv( black );
-    glVertex3fv( v5 );
-    glColor4ubv( purple );
-    glVertex3fv( v7 );
-    glColor4ubv( orange );
-    glVertex3fv( v6 );
-
-    glColor4ubv( yellow );
-    glVertex3fv( v4 );
-    glColor4ubv( red );
-    glVertex3fv( v0 );
-    glColor4ubv( white );
-    glVertex3fv( v3 );
-
-    glColor4ubv( yellow );
-    glVertex3fv( v4 );
-    glColor4ubv( white );
-    glVertex3fv( v3 );
-    glColor4ubv( purple );
-    glVertex3fv( v7 );
-
-    glColor4ubv( white );
-    glVertex3fv( v3 );
-    glColor4ubv( blue );
-    glVertex3fv( v2 );
-    glColor4ubv( orange );
-    glVertex3fv( v6 );
-
-    glColor4ubv( white );
-    glVertex3fv( v3 );
-    glColor4ubv( orange );
-    glVertex3fv( v6 );
-    glColor4ubv( purple );
-    glVertex3fv( v7 );
-
-    glColor4ubv( green );
-    glVertex3fv( v1 );
-    glColor4ubv( red );
-    glVertex3fv( v0 );
-    glColor4ubv( yellow );
-    glVertex3fv( v4 );
-
-    glColor4ubv( green );
-    glVertex3fv( v1 );
-    glColor4ubv( yellow );
-    glVertex3fv( v4 );
-    glColor4ubv( black );
-    glVertex3fv( v5 );
-
-    glEnd( );
-
-    /*
-     * EXERCISE:
-     * Draw text telling the user that 'Spc'
-     * pauses the rotation and 'Esc' quits.
-     * Do it using vetors and textured quads.
-     */
-
-    /*
-     * Swap the buffers. This this tells the driver to
-     * render the next frame from the contents of the
-     * back-buffer, and to set all rendering operations
-     * to occur on what was the front-buffer.
-     *
-     * Double buffering prevents nasty visual tearing
-     * from the application drawing on areas of the
-     * screen that are being updated at the same time.
-     */
-    SDL_GL_SwapBuffers( );
-}
-
-static void setup_opengl( int width, int height )
-{
-    float ratio = (float) width / (float) height;
-
-    /* Our shading model--Gouraud (smooth). */
-    glShadeModel( GL_SMOOTH );
-
-    /* Culling. */
-    glCullFace( GL_BACK );
-    glFrontFace( GL_CCW );
-    glEnable( GL_CULL_FACE );
-
-    /* Set the clear color. */
-    glClearColor( 0, 0, 0, 0 );
-
-    /* Setup our viewport. */
-    glViewport( 0, 0, width, height );
-
-    /*
-     * Change to the projection matrix and set
-     * our viewing volume.
-     */
-    glMatrixMode( GL_PROJECTION );
-    glLoadIdentity( );
-    /*
-     * EXERCISE:
-     * Replace this with a call to glFrustum.
-     */
-    gluPerspective( 60.0, ratio, 1.0, 1024.0 );
-}
-
-int main( int argc, char* argv[] )
-{
-    /* Information about the current video settings. */
-    const SDL_VideoInfo* info = NULL;
-    /* Dimensions of our window. */
-    int width = 0;
-    int height = 0;
-    /* Color depth in bits of our window. */
-    int bpp = 0;
-    /* Flags we will pass into SDL_SetVideoMode. */
-    int flags = 0;
-
-    /* First, initialize SDL's video subsystem. */
-    if( SDL_Init( SDL_INIT_VIDEO ) < 0 ) {
-        /* Failed, exit. */
-        fprintf( stderr, "Video initialization failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
-    }
-
-    /* Let's get some video information. */
-    info = SDL_GetVideoInfo( );
-
-    if( !info ) {
-        /* This should probably never happen. */
-        fprintf( stderr, "Video query failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
-    }
-
-    /*
-     * Set our width/height to 640/480 (you would
-     * of course let the user decide this in a normal
-     * app). We get the bpp we will request from
-     * the display. On X11, VidMode can't change
-     * resolution, so this is probably being overly
-     * safe. Under Win32, ChangeDisplaySettings
-     * can change the bpp.
-     */
-    width = 640;
-    height = 480;
-    bpp = info->vfmt->BitsPerPixel;
-
-    /*
-     * Now, we want to setup our requested
-     * window attributes for our OpenGL window.
-     * We want *at least* 5 bits of red, green
-     * and blue. We also want at least a 16-bit
-     * depth buffer.
-     *
-     * The last thing we do is request a double
-     * buffered window. '1' turns on double
-     * buffering, '0' turns it off.
-     *
-     * Note that we do not use SDL_DOUBLEBUF in
-     * the flags to SDL_SetVideoMode. That does
-     * not affect the GL attribute state, only
-     * the standard 2D blitting setup.
-     */
-    SDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 );
-    SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 );
-
-    /*
-     * We want to request that SDL provide us
-     * with an OpenGL window, in a fullscreen
-     * video mode.
-     *
-     * EXERCISE:
-     * Make starting windowed an option, and
-     * handle the resize events properly with
-     * glViewport.
-     */
-    flags = SDL_OPENGL | SDL_FULLSCREEN;
-
-    /*
-     * Set the video mode
-     */
-    if( SDL_SetVideoMode( width, height, bpp, flags ) == 0 ) {
-        /* 
-         * This could happen for a variety of reasons,
-         * including DISPLAY not being set, the specified
-         * resolution not being available, etc.
-         */
-        fprintf( stderr, "Video mode set failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
-    }
-
-    /*
-     * At this point, we should have a properly setup
-     * double-buffered window for use with OpenGL.
-     */
-    setup_opengl( width, height );
-
-    /*
-     * Now we want to begin our normal app process--
-     * an event loop with a lot of redrawing.
-     */
-    while( 1 ) {
-        /* Process incoming events. */
-        process_events( );
-        /* Draw the screen. */
-        draw_screen( );
-    }
-
-    /*
-     * EXERCISE:
-     * Record timings using SDL_GetTicks() and
-     * and print out frames per second at program
-     * end.
-     */
-
-    /* Never reached. */
-    return 0;
-}

Prev	Home	Next
Graphics and Video	Up	Input handling

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/index.html --- a/docs/html/index.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1156 +0,0 @@ -

Table of Contents

I. SDL Guide

Preface

About SDL
About SDLdoc
Credits

1. The Basics

Introduction
Initializing SDL

2. Graphics and Video

Introduction to SDL Video
Using OpenGL With SDL

3. Input handling

Handling Joysticks
Handling the Keyboard

4. Examples

Introduction
Event Examples
Audio Examples
CDROM Examples
Time Examples

II. SDL Reference

5. General

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

6. Video

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

7. Window Management

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

8. Events

Introduction
SDL Event Structures.
Event Functions.

9. Joystick

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

10. Audio

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

11. CD-ROM

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

12. Multi-threaded Programming

SDL_CreateThread -- Creates a new thread of execution that shares its parent's properties.
SDL_ThreadID -- Get the 32-bit thread identifier for the current thread.
SDL_GetThreadID -- Get the SDL thread ID of a SDL_Thread
SDL_WaitThread -- Wait for a thread to finish.
SDL_KillThread -- Gracelessly terminates the thread.
SDL_CreateMutex -- Create a mutex
SDL_DestroyMutex -- Destroy a mutex
SDL_mutexP -- Lock a mutex
SDL_mutexV -- Unlock a mutex
SDL_CreateSemaphore -- Creates a new semaphore and assigns an initial value to it.
SDL_DestroySemaphore -- Destroys a semaphore that was created by SDL_CreateSemaphore.
SDL_SemWait -- 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.
SDL_SemWaitTimeout -- Lock a semaphore, but only wait up to a specified maximum time.
SDL_SemPost -- Unlock a semaphore.
SDL_SemValue -- Return the current value of a semaphore.
SDL_CreateCond -- Create a condition variable
SDL_DestroyCond -- Destroy a condition variable
SDL_CondSignal -- Restart a thread wait on a condition variable
SDL_CondBroadcast -- Restart all threads waiting on a condition variable
SDL_CondWait -- Wait on a condition variable
SDL_CondWaitTimeout -- Wait on a condition variable, with timeout

13. Time

SDL_GetTicks -- Get the number of milliseconds since the SDL library initialization.
SDL_Delay -- 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 -elapsed.
SDL_RemoveTimer -- Remove a timer which was added with -SDL_AddTimer.
SDL_SetTimer -- Set a callback to run after the specified number of milliseconds has -elapsed.

List of Tables
8-1. SDL Keysym definitions
8-2. SDL modifier definitions

List of Examples
1-1. Initializing SDL
2-1. Initializing the Video Display
2-2. Initializing the Best Video Mode
2-3. Loading and Displaying a BMP File
2-4. getpixel()
2-5. putpixel()
2-6. Using putpixel()
2-7. Initializing SDL with OpenGL
2-8. SDL and OpenGL
3-1. Initializing SDL with Joystick Support
3-2. Querying the Number of Available Joysticks
3-3. Opening a Joystick
3-4. Joystick Axis Events
3-5. More Joystick Axis Events
3-6. Joystick Button Events
3-7. Joystick Ball Events
3-8. Joystick Hat Events
3-9. Querying Joystick Characteristics
3-10. Reading Keyboard Events
3-11. Interpreting Key Event Information
3-12. Proper Game Movement

		Next
		SDL Guide

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/joystick.html --- a/docs/html/joystick.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,296 +0,0 @@ -Joystick

SDL Library Documentation
Prev		Next

Chapter 9. Joystick

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

Joysticks, and other similar input devices, have a very strong role in game playing and SDL provides comprehensive support for them. Axes, Buttons, POV Hats and trackballs are all supported.

Joystick support is initialized by passed the SDL_INIT_JOYSTICK flag to SDL_Init. Once initilized joysticks must be opened using SDL_JoystickOpen.

While using the functions describe in this secton may seem like the best way to access and read from joysticks, in most cases they aren't. Ideally joysticks should be read using the event system. To enable this, you must set the joystick event processing state with SDL_JoystickEventState. Joysticks must be opened before they can be used of course.

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

Note: Force Feedback is not yet support. Sam (slouken@libsdl.org) is soliciting suggestions from people with force-feedback experience on the best wat to desgin the API.

Prev	Home	Next
SDL_JoystickEventState	Up	SDL_NumJoysticks

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/reference.html --- a/docs/html/reference.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,194 +0,0 @@ -SDL Reference

SDL Library Documentation
Prev		Next

II. SDL Reference

Table of Contents
5. General
6. Video
7. Window Management
8. Events
9. Joystick
10. Audio
11. CD-ROM
12. Multi-threaded Programming
13. Time

Prev	Home	Next
Time Examples		General

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/sdlactiveevent.html --- a/docs/html/sdlactiveevent.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,335 +0,0 @@ -SDL_ActiveEvent

SDL Library Documentation
Prev		Next

SDL_ActiveEvent

Name

SDL_ActiveEvent -- Application visibility event structure

Structure Definition

typedef struct{
-  Uint8 type;
-  Uint8 gain;
-  Uint8 state;
-} SDL_ActiveEvent;

Structure Data

`type`	`SDL_ACTIVEEVENT.`
`gain`	0 if the event is a loss or 1 if it is a gain.
`state`	`SDL_APPMOUSEFOCUS` if mouse focus was gained or lost, `SDL_APPINPUTFOCUS` if input focus was gained or lost, or `SDL_APPACTIVE` if the application was iconified (`gain`=0) or restored(`gain`=1).

Description

SDL_ActiveEvent is a member of the SDL_Event union and is used when an event of type SDL_ACTIVEEVENT is reported.

When the mouse leaves or enters the window area a SDL_APPMOUSEFOCUS type activation event occurs, if the mouse entered the window then gain will be 1, otherwise gain will be 0. A SDL_APPINPUTFOCUS type activation event occurs when the application loses or gains keyboard focus. This usually occurs when another application is made active. Finally, a SDL_APPACTIVE type event occurs when the application is either minimised/iconified (gain=0) or restored.

Note: This event does not occur when an application window is first created.

SDL_AddTimer

Name

SDL_AddTimer -- Add a timer which will call a callback after the specified number of milliseconds has -elapsed.

Synopsis

#include "SDL.h"

SDL_TimerID SDL_AddTimer(Uint32 interval, SDL_NewTimerCallback callback, void *param);

Callback

/* type definition for the "new" timer callback function */
-typedef Uint32 (*SDL_NewTimerCallback)(Uint32 interval, void *param);

Description

Adds a callback function to be run after the specified number of -milliseconds has elapsed. The callback function is passed the current -timer interval and the user supplied parameter from the -SDL_AddTimer call and returns the next timer -interval. If the returned value from the callback is the same as the one -passed in, the periodic alarm continues, otherwise a new alarm is -scheduled.

To cancel a currently running timer call -SDL_RemoveTimer with the -timer ID returned from -SDL_AddTimer.

The timer callback function may run in a different thread than your -main program, and so shouldn't call any functions from within itself. -You may always call SDL_PushEvent, however.

The granularity of the timer is platform-dependent, but you should count -on it being at least 10 ms as this is the most common number. -This means that if -you request a 16 ms timer, your callback will run approximately 20 ms -later on an unloaded system. If you wanted to set a flag signaling -a frame update at 30 frames per second (every 33 ms), you might set a -timer for 30 ms (see example below). - -If you use this function, you need to pass SDL_INIT_TIMER -to SDL_Init.

Return Value

Returns an ID value for the added timer or -NULL if there was an error.

Examples

my_timer_id = SDL_AddTimer((33/10)*10, my_callbackfunc, my_callback_param);

SDL_AudioCVT

Name

SDL_AudioCVT -- Audio Conversion Structure

Structure Definition

typedef struct{
-  int needed;
-  Uint16 src_format;
-  Uint16 dest_format;
-  double rate_incr;
-  Uint8 *buf;
-  int len;
-  int len_cvt;
-  int len_mult;
-  double len_ratio;
-  void (*filters[10])(struct SDL_AudioCVT *cvt, Uint16 format);
-  int filter_index;
-} SDL_AudioCVT;

Structure Data

`needed`	Set to one if the conversion is possible
`src_format`	Audio format of the source
`dest_format`	Audio format of the destination
`rate_incr`	Rate conversion increment
`buf`	Audio buffer
`len`	Length of the original audio buffer in bytes
`len_cvt`	Length of converted audio buffer in bytes (calculated)
`len_mult`	`buf` must be `len`*`len_mult` bytes in size(calculated)
`len_ratio`	Final audio size is `len`*`len_ratio`
`filters[10](..)`	Pointers to functions needed for this conversion
`filter_index`	Current conversion function

Description

The SDL_AudioCVT is used to convert audio data between different formats. A SDL_AudioCVT structure is created with the SDL_BuildAudioCVT function, while the actual conversion is done by the SDL_ConvertAudio function.

Many of the fields in the SDL_AudioCVT structure should be considered private and their function will not be discussed here.

Uint8 *buf: This points to the audio data that will be used in the conversion. It is both the source and the destination, which means the converted audio data overwrites the original data. It also means that the converted data may be larger than the original data (if you were converting from 8-bit to 16-bit, for instance), so you must ensure buf is large enough. See below.
int len: This is the length of the original audio data in bytes.
int len_mult: As explained above, the audio buffer needs to be big enough to store the converted data, which may be bigger than the original audio data. The length of buf should be len*len_mult.
double len_ratio: When you have finished converting your audio data, you need to know how much of your audio buffer is valid. len*len_ratio is the size of the converted audio data in bytes. This is very similar to len_mult, however when the convert audio data is shorter than the original len_mult would be 1. len_ratio, on the other hand, would be a fractional number between 0 and 1.

SDL_AudioSpec

Name

SDL_AudioSpec -- Audio Specification Structure

Structure Definition

typedef struct{
-  int freq;
-  Uint16 format;
-  Uint8 channels;
-  Uint8 silence;
-  Uint16 samples;
-  Uint32 size;
-  void (*callback)(void *userdata, Uint8 *stream, int len);
-  void *userdata;
-} SDL_AudioSpec;

Structure Data

`freq`	Audio frequency in samples per second
`format`	Audio data format
`channels`	Number of channels: 1 mono, 2 stereo
`silence`	Audio buffer silence value (calculated)
`samples`	Audio buffer size in samples
`size`	Audio buffer size in bytes (calculated)
`callback(..)`	Callback function for filling the audio buffer
`userdata`	Pointer the user data which is passed to the callback function

Description

The SDL_AudioSpec structure is used to describe the format of some audio data. This structure is used by SDL_OpenAudio and SDL_LoadWAV. While all fields are used by SDL_OpenAudio only freq, format, samples and channels are used by SDL_LoadWAV. We will detail these common members here.

`freq`	The number of samples sent to the sound device every second. Common values are 11025, 22050 and 44100. The higher the better.
`format`	Specifies the size and type of each sample element - `AUDIO_U8` Unsigned 8-bit samples `AUDIO_S8` Signed 8-bit samples `AUDIO_U16` or `AUDIO_U16LSB` Unsigned 16-bit little-endian samples `AUDIO_S16` or `AUDIO_S16LSB` Signed 16-bit little-endian samples `AUDIO_U16MSB` Unsigned 16-bit big-endian samples `AUDIO_S16MSB` Signed 16-bit big-endian samples `AUDIO_U16SYS` Either `AUDIO_U16LSB` or `AUDIO_U16MSB` depending on you systems endianness `AUDIO_S16SYS` Either `AUDIO_S16LSB` or `AUDIO_S16MSB` depending on you systems endianness
`channels`	The number of seperate sound channels. 1 is mono (single channel), 2 is stereo (dual channel).
`samples`	When used with `SDL_OpenAudio` this refers to the size of the audio buffer in samples. A sample a chunk of audio data of the size specified in `format` mulitplied by the number of channels. When the SDL_AudioSpec is used with `SDL_LoadWAV` `samples` is set to 4096.

SDL_BlitSurface

Name

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

Synopsis

#include "SDL.h"

int SDL_BlitSurface(SDL_Surface *src, SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect);

Description

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

The width and height in srcrect determine the -size of the copied rectangle. Only the position is used in the -dstrect (the width and height are ignored).

If srcrect is NULL, the -entire surface is copied. If dstrect is -NULL, then the destination position (upper left -corner) is (0, 0).

The final blit rectangle is saved in -dstrect after all clipping is performed -(srcrect is not modified).

The blit function should not be called on a locked surface.

The results of blitting operations vary greatly depending on whether SDL_SRCAPLHA is set or not. See SDL_SetAlpha for an explaination of how this affects your results. Colorkeying and alpha attributes also interact with surface blitting, as the following pseudo-code should hopefully explain. -

if (source surface has SDL_SRCALPHA set) {
-    if (source surface has alpha channel (that is, format->Amask != 0))
-        blit using per-pixel alpha, ignoring any colour key
-    else {
-        if (source surface has SDL_SRCCOLORKEY set)
-            blit using the colour key AND the per-surface alpha value
-        else
-            blit using the per-surface alpha value
-    }
-} else {
-    if (source surface has SDL_SRCCOLORKEY set)
-        blit using the colour key
-    else
-        ordinary opaque rectangular blit
-}

Return Value

If the blit is successful, it returns 0, -otherwise it returns -1.

If either of the surfaces were in video memory, and the blit returns --2, the video memory was lost, so it should be -reloaded with artwork and re-blitted: -

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

-This happens under DirectX 5.0 when the system switches away from your -fullscreen application. Locking the surface will also fail until you -have access to the video memory again.

SDL_BuildAudioCVT

Name

SDL_BuildAudioCVT -- Initializes a SDL_AudioCVT structure for conversion

Synopsis

#include "SDL.h"

int SDL_BuildAudioCVT(SDL_AudioCVT *cvt, Uint16 src_format, Uint8 src_channels, int src_rate, Uint16 dst_format, Uint8 dst_channels, int dst_rate);

Description

Before an SDL_AudioCVT structure can be used to convert audio data it must be initialized with source and destination information.

src_format and dst_format are the source and destination format of the conversion. (For information on audio formats see SDL_AudioSpec). src_channels and dst_channels are the number of channels in the source and destination formats. Finally, src_rate and dst_rate are the frequency or samples-per-second of the source and destination formats. Once again, see SDL_AudioSpec.

Return Values

Returns -1 if the filter could not be built or 1 if it could.

Examples

See SDL_ConvertAudio.

SDL_CD

Name

SDL_CD -- CDROM Drive Information

Structure Definition

typedef struct{
-  int id;
-  CDstatus status;
-  int numtracks;
-  int cur_track;
-  int cur_frame;
-  SDL_CDtrack track[SDL_MAX_TRACKS+1];
-} SDL_CD;

Structure Data

`id`	Private drive identifier
`status`	Drive status
`numtracks`	Number of tracks on the CD
`cur_track`	Current track
`cur_frame`	Current frame offset within the track
`track`[SDL_MAX_TRACKS+1]	Array of track descriptions. (see SDL_CDtrack)

Description

An SDL_CD structure is returned by SDL_CDOpen. It represents an opened CDROM device and stores information on the layout of the tracks on the disc.

A frame is the base data unit of a CD. CD_FPS frames is equal to 1 second of music. SDL provides two macros for converting between time and frames: FRAMES_TO_MSF(f, M,S,F) and MSF_TO_FRAMES.

Examples

int min, sec, frame;
-int frame_offset;
-
-FRAMES_TO_MSF(cdrom->cur_frame, &min, &sec, &frame);
-printf("Current Position: %d minutes, %d seconds, %d frames\n", min, sec, frame);
-
-frame_offset=MSF_TO_FRAMES(min, sec, frame);

SDL_CDClose

Name

SDL_CDClose -- Closes a SDL_CD handle

Synopsis

#include "SDL.h"

void SDL_CDClose(SDL_CD *cdrom);

Description

Closes the given cdrom handle.

SDL_CDEject

Name

SDL_CDEject -- Ejects a CDROM

Synopsis

#include "SDL.h"

int SDL_CDEject(SDL_CD *cdrom);

Description

Ejects the given cdrom.

Return Value

Returns 0 on success, or -1 on an error.

SDL_CDName

Name

SDL_CDName -- Returns a human-readable, system-dependent identifier for the CD-ROM.

Synopsis

#include "SDL.h"

const char *SDL_CDName(int drive);

Description

Returns a human-readable, system-dependent identifier for the CD-ROM. drive is the index of the drive. Drive indices start to 0 and end at SDL_CDNumDrives()-1.

Examples

"/dev/cdrom"
"E:"
"/dev/disk/ide/1/master"

SDL_CDNumDrives

Name

SDL_CDNumDrives -- Returns the number of CD-ROM drives on the system.

Synopsis

#include "SDL.h"

int SDL_CDNumDrives(void);

Description

Returns the number of CD-ROM drives on the system.

SDL_CDOpen

Name

SDL_CDOpen -- Opens a CD-ROM drive for access.

Synopsis

#include "SDL.h"

SDL_CD *SDL_CDOpen(int drive);

Description

Opens a CD-ROM drive for access. It returns a SDL_CD structure on success, or NULL if the drive was invalid or busy. This newly opened CD-ROM becomes the default CD used when other CD functions are passed a NULL CD-ROM handle.

Drives are numbered starting with 0. -Drive 0 is the system default CD-ROM.

Examples

SDL_CD *cdrom;
-int cur_track;
-int min, sec, frame;
-SDL_Init(SDL_INIT_CDROM);
-atexit(SDL_Quit);
-
-/* Check for CD drives */
-if(!SDL_CDNumDrives()){
-  /* None found */
-  fprintf(stderr, "No CDROM devices available\n");
-  exit(-1);
-}
-
-/* Open the default drive */
-cdrom=SDL_CDOpen(0);
-
-/* Did if open? Check if cdrom is NULL */
-if(!cdrom){
-  fprintf(stderr, "Couldn't open drive: %s\n", SDL_GetError());
-  exit(-1);
-}
-
-/* Print Volume info */
-printf("Name: %s\n", SDL_CDName(0));
-printf("Tracks: %d\n", cdrom->numtracks);
-for(cur_track=0;cur_track < cdrom->numtracks; cur_track++){
-  FRAMES_TO_MSF(cdrom->track[cur_track].length, &min, &sec, &frame);
-  printf("\tTrack %d: Length %d:%d\n", cur_track, min, sec);
-}
-
-SDL_CDClose(cdrom);

SDL_CDPause

Name

SDL_CDPause -- Pauses a CDROM

Synopsis

#include "SDL.h"

int SDL_CDPause(SDL_CD *cdrom);

Description

Pauses play on the given cdrom.

Return Value

Returns 0 on success, or -1 on an error.

SDL_CDPlay

Name

SDL_CDPlay -- Play a CD

Synopsis

#include "SDL.h"

int SDL_CDPlay(SDL_CD *cdrom, int start, int length);

Description

Plays the given cdrom, starting a frame start for length frames.

Return Values

Returns 0 on success, or -1 on an error.

SDL_CDPlayTracks

Name

SDL_CDPlayTracks -- Play the given CD track(s)

Synopsis

#include "SDL.h"

int SDL_CDPlayTracks(SDL_CD *cdrom, int start_track, int start_frame, int ntracks, int nframes));

Description

SDL_CDPlayTracks plays the given CD starting at track -start_track, for ntracks tracks.

start_frame is the frame offset, from the beginning of the start_track, at which to start. nframes is the frame offset, from the beginning of the last track (start_track+ntracks), at which to end playing.

SDL_CDPlayTracks should only be called after calling -SDL_CDStatus -to get track information about the CD.

Note: Data tracks are ignored.

Return Value

Returns 0, or -1 -if there was an error.

Examples

/* assuming cdrom is a previously opened device */
-/* Play the entire CD */
-if(CD_INDRIVE(SDL_CDStatus(cdrom)))
-  SDL_CDPlayTracks(cdrom, 0, 0, 0, 0);
-
-/* Play the first track */
-if(CD_INDRIVE(SDL_CDStatus(cdrom)))
-  SDL_CDPlayTracks(cdrom, 0, 0, 1, 0);
-
-/* Play first 15 seconds of the 2nd track */
-if(CD_INDRIVE(SDL_CDStatus(cdrom)))
-  SDL_CDPlayTracks(cdrom, 1, 0, 0, CD_FPS*15);

SDL_CDResume

Name

SDL_CDResume -- Resumes a CDROM

Synopsis

#include "SDL.h"

int SDL_CDResume(SDL_CD *cdrom);

Description

Resumes play on the given cdrom.

Return Value

Returns 0 on success, or -1 on an error.

SDL_CDStatus

Name

SDL_CDStatus -- Returns the current status of the given drive.

Synopsis

#include "SDL.h"

CDstatus SDL_CDStatus(SDL_CD *cdrom);

/* Given a status, returns true if there's a disk in the drive */
-#define CD_INDRIVE(status)      ((int)status > 0)

Description

This function returns the current status of the given drive. Status is described like so: -

typedef enum {
-  CD_TRAYEMPTY,
-  CD_STOPPED,
-  CD_PLAYING,
-  CD_PAUSED,
-  CD_ERROR = -1
-} CDstatus;

If the drive has a CD in it, the table of contents of the CD and current -play position of the CD will be stored in the SDL_CD structure.

The macro CD_INDRIVE is provided for convenience, -and given a status returns true if there's a disk in the drive.

Note: SDL_CDStatus also updates the SDL_CD structure passed to it.

Example

int playTrack(int track)
-{
-  int playing = 0;
-
-  if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) {
-  /* clamp to the actual number of tracks on the CD */
-    if (track >= cdrom->numtracks) {
-      track = cdrom->numtracks-1;
-    }
-
-    if ( SDL_CDPlayTracks(cdrom, track, 0, 1, 0) == 0 ) {
-      playing = 1;
-    }
-  }
-  return playing;
-}

SDL_CDStop

Name

SDL_CDStop -- Stops a CDROM

Synopsis

#include "SDL.h"

int SDL_CDStop(SDL_CD *cdrom);

Description

Stops play on the given cdrom.

Return Value

Returns 0 on success, or -1 on an error.

SDL_CDtrack

Name

SDL_CDtrack -- CD Track Information Structure

Structure Definition

typedef struct{
-  Uint8 id;
-  Uint8 type;
-  Uint32 length;
-  Uint32 offset;
-} SDL_CDtrack;

Structure Data

`id`	Track number (0-99)
`type`	`SDL_AUDIO_TRACK` or `SDL_DATA_TRACK`
`length`	Length, in frames, of this track
`offset`	Frame offset to the beginning of this track

Description

SDL_CDtrack stores data on each track on a CD, its fields should be pretty self explainatory. It is a member a the SDL_CD structure.

Note: Frames can be converted to standard timings. There are CD_FPS frames per second, so SDL_CDtrack.length/CD_FPS=length_in_seconds.

SDL_CloseAudio

Name

SDL_CloseAudio -- Shuts down audio processing and closes the audio device.

Synopsis

#include "SDL.h"

void SDL_CloseAudio(void);

Description

This function shuts down audio processing and closes the audio device.

SDL_Color

Name

SDL_Color -- Format independent color description

Structure Definition

typedef struct{
-  Uint8 r;
-  Uint8 g;
-  Uint8 b;
-  Uint8 unused;
-} SDL_Color;

Structure Data

`r`	Red intensity
`g`	Green intensity
`b`	Blue intensity
`unused`	Unused

Description

SDL_Color describes a color in a format independent way. You can convert a SDL_Color to a pixel value for a certain pixel format using SDL_MapRGB.

SDL_CondBroadcast

Name

SDL_CondBroadcast -- Restart all threads waiting on a condition variable

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

int SDL_CondBroadcast(SDL_cond *cond);

Description

Restarts all threads that are waiting on the condition variable, cond. Returns 0 on success, or -1 on an error.

SDL_CondSignal

Name

SDL_CondSignal -- Restart a thread wait on a condition variable

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

int SDL_CondSignal(SDL_cond *cond);

Description

Restart one of the threads that are waiting on the condition variable, cond. Returns 0 on success of -1 on an error.

SDL_CondWait

Name

SDL_CondWait -- Wait on a condition variable

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

int SDL_CondWait(SDL_cond *cond, SDL_mutex *mut);

Description

Wait on the condition variable cond and unlock the provided mutex. The mutex must the locked before entering this function. Returns 0 when it is signalled, or -1 on an error.

SDL_CondWaitTimeout

Name

SDL_CondWaitTimeout -- Wait on a condition variable, with timeout

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

int SDL_CondWaitTimeout(SDL_cond *cond, SDL_mutex *mutex, Uint32 ms);

Description

Wait on the condition variable cond for, at most, ms milliseconds. mut is unlocked so it must be locked when the function is called. Returns SDL_MUTEX_TIMEDOUT if the condition is not signalled in the allotted time, 0 if it was signalled or -1 on an error.

SDL_ConvertAudio

Name

SDL_ConvertAudio -- Convert audio data to a desired audio format.

Synopsis

#include "SDL.h"

int SDL_ConvertAudio(SDL_AudioCVT *cvt);

Description

SDL_ConvertAudio takes one parameter, cvt, which was previously initilized. Initilizing a SDL_AudioCVT is a two step process. First of all, the structure must be passed to SDL_BuildAudioCVT along with source and destination format parameters. Secondly, the cvt->buf and cvt->len fields must be setup. cvt->buf should point to the audio data and cvt->len should be set to the length of the audio data in bytes. Remember, the length of the buffer pointed to by buf show be len*len_mult bytes in length.

Once the SDL_AudioCVTstructure is initilized then we can pass it to SDL_ConvertAudio, which will convert the audio data pointer to by cvt->buf. If SDL_ConvertAudio returned 0 then the conversion was completed successfully, otherwise -1 is returned.

If the conversion completed successfully then the converted audio data can be read from cvt->buf. The amount of valid, converted, audio data in the buffer is equal to cvt->len*cvt->len_ratio.

Examples

/* Converting some WAV data to hardware format */
-void my_audio_callback(void *userdata, Uint8 *stream, int len);
-
-SDL_AudioSpec *desired, *obtained;
-SDL_AudioSpec wav_spec;
-SDL_AudioCVT  wav_cvt;
-Uint32 wav_len;
-Uint8 *wav_buf;
-int ret;
-
-/* Allocated audio specs */
-desired = malloc(sizeof(SDL_AudioSpec));
-obtained = malloc(sizeof(SDL_AudioSpec));
-
-/* Set desired format */
-desired->freq=22050;
-desired->format=AUDIO_S16LSB;
-desired->samples=8192;
-desired->callback=my_audio_callback;
-desired->userdata=NULL;
-
-/* Open the audio device */
-if ( SDL_OpenAudio(desired, obtained) < 0 ){
-  fprintf(stderr, "Couldn't open audio: %s\n", SDL_GetError());
-  exit(-1);
-}
-        
-free(desired);
-
-/* Load the test.wav */
-if( SDL_LoadWAV("test.wav", &wav_spec, &wav_buf, &wav_len) == NULL ){
-  fprintf(stderr, "Could not open test.wav: %s\n", SDL_GetError());
-  SDL_CloseAudio();
-  free(obtained);
-  exit(-1);
-}
-                                            
-/* Build AudioCVT */
-ret = SDL_BuildAudioCVT(&wav_cvt,
-                        wav_spec.format, wav_spec.channels, wav_spec.freq,
-                        obtained->format, obtained->channels, obtained->freq);
-
-/* Check that the convert was built */
-if(ret==-1){
-  fprintf(stderr, "Couldn't build converter!\n");
-  SDL_CloseAudio();
-  free(obtained);
-  SDL_FreeWAV(wav_buf);
-}
-
-/* Setup for conversion */
-wav_cvt.buf = malloc(wav_len * wav_cvt.len_mult);
-wav_cvt.len = wav_len;
-memcpy(wav_cvt.buf, wav_buf, wav_len);
-
-/* We can delete to original WAV data now */
-SDL_FreeWAV(wav_buf);
-
-/* And now we're ready to convert */
-SDL_ConvertAudio(&wav_cvt);
-
-/* do whatever */
-.
-.
-.
-.
-

SDL_ConvertSurface

Name

SDL_ConvertSurface -- Converts a surface to the same format as another surface.

Synopsis

#include "SDL/SDL.h"

SDL_Surface *SDL_ConvertSurface(SDL_Surface *src, SDL_PixelFormat *fmt, Uint32 flags);

Description

Creates a new surface of the specified format, and then copies and maps -the given surface to it. If this function fails, it returns -NULL.

The flags parameter is passed to -SDL_CreateRGBSurface -and has those semantics.

This function is used internally by -SDL_DisplayFormat.

This function can only be called after SDL_Init.

Return Value

Returns either a pointer to the new surface, or -NULL on error.

SDL_CreateCond

Name

SDL_CreateCond -- Create a condition variable

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

SDL_cond *SDL_CreateCond(void);

Description

Creates a condition variable.

Examples

SDL_cond *cond;
-
-cond=SDL_CreateCond();
-.
-.
-/* Do stuff */
-
-.
-.
-SDL_DestroyCond(cond);

SDL_CreateCursor

Name

SDL_CreateCursor -- Creates a new mouse cursor.

Synopsis

#include "SDL.h"

SDL_Cursor *SDL_CreateCursor(Uint8 *data, Uint8 *mask, int w, int h, int hot_x, int hot_y);

Description

Create a cursor using the specified data and mask (in MSB format). -The cursor width must be a multiple of 8 bits.

The cursor is created in black and white according to the following: -

Data / Mask	Resulting pixel on screen
0 / 1	White
1 / 1	Black
0 / 0	Transparent
1 / 0	Inverted color if possible, black if not.

Cursors created with this function must be freed with -SDL_FreeCursor.

Example

/* Stolen from the mailing list */
-/* Creates a new mouse cursor from an XPM */
-
-
-/* XPM */
-static const char *arrow[] = {
-  /* width height num_colors chars_per_pixel */
-  "    32    32        3            1",
-  /* colors */
-  "X c #000000",
-  ". c #ffffff",
-  "  c None",
-  /* pixels */
-  "X                               ",
-  "XX                              ",
-  "X.X                             ",
-  "X..X                            ",
-  "X...X                           ",
-  "X....X                          ",
-  "X.....X                         ",
-  "X......X                        ",
-  "X.......X                       ",
-  "X........X                      ",
-  "X.....XXXXX                     ",
-  "X..X..X                         ",
-  "X.X X..X                        ",
-  "XX  X..X                        ",
-  "X    X..X                       ",
-  "     X..X                       ",
-  "      X..X                      ",
-  "      X..X                      ",
-  "       XX                       ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "                                ",
-  "0,0"
-};
-
-static SDL_Cursor *init_system_cursor(const char *image[])
-{
-  int i, row, col;
-  Uint8 data[4*32];
-  Uint8 mask[4*32];
-  int hot_x, hot_y;
-
-  i = -1;
-  for ( row=0; row<32; ++row ) {
-    for ( col=0; col<32; ++col ) {
-      if ( col % 8 ) {
-        data[i] <<= 1;
-        mask[i] <<= 1;
-      } else {
-        ++i;
-        data[i] = mask[i] = 0;
-      }
-      switch (image[4+row][col]) {
-        case 'X':
-          data[i] |= 0x01;
-          mask[i] |= 0x01;
-          break;
-        case '.':
-          mask[i] |= 0x01;
-          break;
-        case ' ':
-          break;
-      }
-    }
-  }
-  sscanf(image[4+row], "%d,%d", &hot_x, &hot_y);
-  return SDL_CreateCursor(data, mask, 32, 32, hot_x, hot_y);
-}

SDL_CreateMutex

Name

SDL_CreateMutex -- Create a mutex

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

SDL_mutex *SDL_CreateMutex(void);

Description

Create a new, unlocked mutex.

Examples

SDL_mutex *mut;
-
-mut=SDL_CreateMutex();
-.
-.
-if(SDL_mutexP(mut)==-1){
-  fprintf(stderr, "Couldn't lock mutex\n");
-  exit(-1);
-}
-.
-/* Do stuff while mutex is locked */
-.
-.
-if(SDL_mutexV(mut)==-1){
-  fprintf(stderr, "Couldn't unlock mutex\n");
-  exit(-1);
-}
-
-SDL_DestroyMutex(mut);

SDL_CreateRGBSurface

Name

SDL_CreateRGBSurface -- Create an empty SDL_Surface

Synopsis

#include "SDL.h"

SDL_Surface *SDL_CreateRGBSurface(Uint32 flags, int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);

Description

Allocate an empty surface (must be called after SDL_SetVideoMode)

If depth is 8 bits an empty palette is allocated for the surface, otherwise a 'packed-pixel' SDL_PixelFormat is created using the [RGBA]mask's provided (see SDL_PixelFormat). The flags specifies the type of surface that should be created, it is an OR'd combination of the following possible values.

`SDL_SWSURFACE`	SDL will create the surface in system memory. This improves the performance of pixel level access, however you may not be able to take advantage of some types of hardware blitting.
`SDL_HWSURFACE`	SDL will attempt to create the surface in video memory. This will allow SDL to take advantage of Video->Video blits (which are often accelerated).
`SDL_SRCCOLORKEY`	This flag turns on colourkeying for blits from this surface. If -`SDL_HWSURFACE` is also specified and colourkeyed blits -are hardware-accelerated, then SDL will attempt to place the surface in -video memory. -Use `SDL_SetColorKey` -to set or clear this flag after surface creation.
`SDL_SRCALPHA`	This flag turns on alpha-blending for blits from this surface. If -`SDL_HWSURFACE` is also specified and alpha-blending blits -are hardware-accelerated, then the surface will be placed in video memory if -possible. -Use `SDL_SetAlpha` to -set or clear this flag after surface creation.

Note: If an alpha-channel is specified (that is, if Amask is -nonzero), then the SDL_SRCALPHA flag is automatically -set. You may remove this flag by calling -SDL_SetAlpha -after surface creation.

Return Value

Returns the created surface, or NULL upon error.

Example

    /* Create a 32-bit surface with the bytes of each pixel in R,G,B,A order,
-       as expected by OpenGL for textures */
-    SDL_Surface *surface;
-    Uint32 rmask, gmask, bmask, amask;
-
-    /* SDL interprets each pixel as a 32-bit number, so our masks must depend
-       on the endianness (byte order) of the machine */
-#if SDL_BYTEORDER == SDL_BIG_ENDIAN
-    rmask = 0xff000000;
-    gmask = 0x00ff0000;
-    bmask = 0x0000ff00;
-    amask = 0x000000ff;
-#else
-    rmask = 0x000000ff;
-    gmask = 0x0000ff00;
-    bmask = 0x00ff0000;
-    amask = 0xff000000;
-#endif
-
-    surface = SDL_CreateRGBSurface(SDL_SWSURFACE, width, height, 32,
-                                   rmask, gmask, bmask, amask);
-    if(surface == NULL) {
-        fprintf(stderr, "CreateRGBSurface failed: %s\n", SDL_GetError());
-        exit(1);
-    }

SDL_CreateRGBSurfaceFrom

Name

SDL_CreateRGBSurfaceFrom -- Create an SDL_Surface from pixel data

Synopsis

#include "SDL.h"

SDL_Surface *SDL_CreateRGBSurfaceFrom(void *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);

Description

Creates an SDL_Surface from the provided pixel data.

The data stored in pixels is assumed to be of the depth specified in the parameter list. The pixel data is not copied into the SDL_Surface structure so it should not be freed until the surface has been freed with a called to SDL_FreeSurface. pitch is the length of each scanline in bytes.

See SDL_CreateRGBSurface for a more detailed description of the other parameters.

Return Value

Returns the created surface, or NULL upon error.

SDL_CreateSemaphore

Name

SDL_CreateSemaphore -- Creates a new semaphore and assigns an initial value to it.

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

SDL_sem *SDL_CreateSemaphore(Uint32 initial_value);

Description

SDL_CreateSemaphore() creates a new semaphore and -initializes it with the value initial_value. -Each locking operation on the semaphore by -SDL_SemWait, -SDL_SemTryWait or -SDL_SemWaitTimeout -will atomically decrement the semaphore value. The locking operation will be blocked -if the semaphore value is not positive (greater than zero). Each unlock operation by -SDL_SemPost -will atomically increment the semaphore value.

Return Value

Returns a pointer to an initialized semaphore or -NULL if there was an error.

Examples

SDL_sem *my_sem;
-
-my_sem = SDL_CreateSemaphore(INITIAL_SEM_VALUE);
-
-if (my_sem == NULL) {
-        return CREATE_SEM_FAILED;
-}

SDL_CreateThread

Name

SDL_CreateThread -- Creates a new thread of execution that shares its parent's properties.

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

SDL_Thread *SDL_CreateThread(int (*fn)(void *), void *data);

Description

SDL_CreateThread creates a new thread of execution -that shares all of its parent's global memory, signal handlers, -file descriptors, etc, and runs the function fn -passed the void pointer data -The thread quits when this function returns.

SDL_CreateYUVOverlay

Name

SDL_CreateYUVOverlay -- Create a YUV video overlay

Synopsis

#include "SDL.h"

SDL_Overlay *SDL_CreateYUVOverlay(int width, int height, Uint32 format, SDL_Surface *display);

Description

SDL_CreateYUVOverlay creates a YUV overlay of the specified width, height and format (see SDL_Overlay for a list of available formats), for the provided display. A SDL_Overlay structure is returned.

The term 'overlay' is a misnomer since, unless the overlay is created in hardware, the contents for the display surface underneath the area where the overlay is shown will be overwritten when the overlay is displayed.

SDL_Delay

Name

SDL_Delay -- Wait a specified number of milliseconds before returning.

Synopsis

#include "SDL.h"

void SDL_Delay(Uint32 ms);

Description

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

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

SDL_DestroyCond

Name

SDL_DestroyCond -- Destroy a condition variable

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

void SDL_DestroyCond(SDL_cond *cond);

Description

Destroys a condition variable.

SDL_DestroyMutex

Name

SDL_DestroyMutex -- Destroy a mutex

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

void SDL_DestroyMutex(SDL_mutex *mutex);

Description

Destroy a previously created mutex.

SDL_DestroySemaphore

Name

SDL_DestroySemaphore -- Destroys a semaphore that was created by SDL_CreateSemaphore.

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

void SDL_DestroySemaphore(SDL_sem *sem);

Description

SDL_DestroySemaphore destroys the semaphore pointed to -by sem that was created by -SDL_CreateSemaphore. -It is not safe to destroy a semaphore if there are threads currently blocked -waiting on it.

Examples

if (my_sem != NULL) {
-        SDL_DestroySemaphore(my_sem);
-        my_sem = NULL;
-}

SDL_DisplayFormat

Name

SDL_DisplayFormat -- Convert a surface to the display format

Synopsis

#include "SDL.h"

SDL_Surface *SDL_DisplayFormat(SDL_Surface *surface);

Description

This function takes a surface and copies it to a new surface of the -pixel format and colors of the video framebuffer, suitable for fast -blitting onto the display surface. It calls -SDL_ConvertSurface

If you want to take advantage of hardware colorkey or alpha blit -acceleration, you should set the colorkey and alpha value before -calling this function.

If you want an alpha channel, see SDL_DisplayFormatAlpha.

Return Value

If the conversion fails or runs out of memory, it returns -NULL

SDL_DisplayFormatAlpha

Name

SDL_DisplayFormatAlpha -- Convert a surface to the display format

Synopsis

#include "SDL.h"

SDL_Surface *SDL_DisplayFormatAlpha(SDL_Surface *surface);

Description

This function takes a surface and copies it to a new surface of the -pixel format and colors of the video framebuffer plus an alpha channel, -suitable for fast blitting onto the display surface. It calls -SDL_ConvertSurface

If you want to take advantage of hardware colorkey or alpha blit -acceleration, you should set the colorkey and alpha value before -calling this function.

This function can be used to convert a colourkey to an alpha channel, -if the SDL_SRCCOLORKEY flag is set on the surface. -The generated surface will then be transparent (alpha=0) where the -pixels match the colourkey, and opaque (alpha=255) elsewhere.

Return Value

If the conversion fails or runs out of memory, it returns -NULL

SDL_DisplayYUVOverlay

Name

SDL_DisplayYUVOverlay -- Blit the overlay to the display

Synopsis

#include "SDL.h"

int SDL_DisplayYUVOverlay(SDL_Overlay *overlay, SDL_Rect *dstrect);

Description

Blit the overlay to the surface specified when it was created. The SDL_Rect structure, dstrect, specifies the position and size of the destination. If the dstrect is a larger or smaller than the overlay then the overlay will be scaled, this is optimized for 2x scaling.

Return Values

Returns 0 on success

SDL_EnableKeyRepeat

Name

SDL_EnableKeyRepeat -- Set keyboard repeat rate.

Synopsis

#include "SDL.h"

int SDL_EnableKeyRepeat(int delay, int interval);

Description

Enables or disables the keyboard repeat rate. delay specifies how long the key must be pressed before it begins repeating, it then repeats at the speed specified by interval. Both delay and interval are expressed in milliseconds.

Setting delay to 0 disables key repeating completely. Good default values are SDL_DEFAULT_REPEAT_DELAY and SDL_DEFAULT_REPEAT_INTERVAL.

Return Value

Returns 0 on success and -1 on failure.

Prev	Home	Next
SDL_EnableUNICODE	Up	SDL_GetMouseState

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/sdlenableunicode.html --- a/docs/html/sdlenableunicode.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,252 +0,0 @@ -SDL_EnableUNICODE

SDL Library Documentation
Prev		Next

SDL_EnableUNICODE

Name

SDL_EnableUNICODE -- Enable UNICODE translation

Synopsis

#include "SDL.h"

int SDL_EnableUNICODE(int enable);

Description

Enables/Disables Unicode keyboard translation.

To obtain the character codes corresponding to received keyboard events, -Unicode translation must first be turned on using this function. The -translation incurs a slight overhead for each keyboard event and is therefore -disabled by default. For each subsequently received key down event, the -unicode member of the -SDL_keysym structure -will then contain the corresponding character code, or zero for keysyms that do -not correspond to any character code.

A value of 1 for enable enables Unicode translation; -0 disables it, and -1 leaves it unchanged (useful for querying the current -translation mode).

Note that only key press events will be translated, not release events.

Return Value

Returns the previous translation mode (0 or 1).

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`	(Mac OS X)
`CGX`	(Amiga)
`photon`	(QNX)
`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.

Prev	Home	Next
SDL_GetError	Up	Video

diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/sdlevent.html --- a/docs/html/sdlevent.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,994 +0,0 @@ -SDL_Event

SDL Library Documentation
Prev		Next

SDL_Event

Name

SDL_Event -- General event structure

Structure Definition

typedef union{
-  Uint8 type;
-  SDL_ActiveEvent active;
-  SDL_KeyboardEvent key;
-  SDL_MouseMotionEvent motion;
-  SDL_MouseButtonEvent button;
-  SDL_JoyAxisEvent jaxis;
-  SDL_JoyBallEvent jball;
-  SDL_JoyHatEvent jhat;
-  SDL_JoyButtonEvent jbutton;
-  SDL_ResizeEvent resize;
-  SDL_ExposeEvent expose;
-  SDL_QuitEvent quit;
-  SDL_UserEvent user;
-  SDL_SysWMEvent syswm;
-} SDL_Event;

Structure Data

`type`	The type of event
`active`	Activation event
`key`	Keyboard event
`motion`	Mouse motion event
`button`	Mouse button event
`jaxis`	Joystick axis motion event
`jball`	Joystick trackball motion event
`jhat`	Joystick hat motion event
`jbutton`	Joystick button event
`resize`	Application window resize event
`expose`	Application window expose event
`quit`	Application quit request event
`user`	User defined event
`syswm`	Undefined window manager event

Description

The SDL_Event union is the core to all event handling is SDL, its probably the most important structure after SDL_Surface. SDL_Event is a union of all event structures used in SDL, using it is a simple matter of knowing which union member relates to which event type.

Event `type`	Event Structure
`SDL_ACTIVEEVENT`	SDL_ActiveEvent
`SDL_KEYDOWN/UP`	SDL_KeyboardEvent
`SDL_MOUSEMOTION`	SDL_MouseMotionEvent
`SDL_MOUSEBUTTONDOWN/UP`	SDL_MouseButtonEvent
`SDL_JOYAXISMOTION`	SDL_JoyAxisEvent
`SDL_JOYBALLMOTION`	SDL_JoyBallEvent
`SDL_JOYHATMOTION`	SDL_JoyHatEvent
`SDL_JOYBUTTONDOWN/UP`	SDL_JoyButtonEvent
`SDL_QUIT`	SDL_QuitEvent
`SDL_SYSWMEVENT`	SDL_SysWMEvent
`SDL_VIDEORESIZE`	SDL_ResizeEvent
`SDL_VIDEOEXPOSE`	SDL_ExposeEvent
`SDL_USEREVENT`	SDL_UserEvent

Use

The SDL_Event structure has two uses

Reading events on the event queue
Placing events on the event queue

Reading events from the event queue is done with either SDL_PollEvent or SDL_PeepEvents. We'll use SDL_PollEvent and step through an example.

First off, we create an empty SDL_Event structure. -

SDL_Event test_event;

-SDL_PollEvent removes the next event from the event queue, if there are no events on the queue it returns 0 otherwise it returns 1. We use a while loop to process each event in turn. -

while(SDL_PollEvent(&test_event)) {

-The SDL_PollEvent function take a pointer to an SDL_Event structure that is to be filled with event information. We know that if SDL_PollEvent removes an event from the queue then the event information will be placed in our test_event structure, but we also know that the type of event will be placed in the type member of test_event. So to handle each event type seperately we use a switch statement. -

  switch(test_event.type) {

-We need to know what kind of events we're looking for and the event type's of those events. So lets assume we want to detect where the user is moving the mouse pointer within our application. We look through our event types and notice that SDL_MOUSEMOTION is, more than likely, the event we're looking for. A little more research tells use that SDL_MOUSEMOTION events are handled within the SDL_MouseMotionEvent structure which is the motion member of SDL_Event. We can check for the SDL_MOUSEMOTION event type within our switch statement like so: -

    case SDL_MOUSEMOTION:

-All we need do now is read the information out of the motion member of test_event. -

      printf("We got a motion event.\n");
-      printf("Current mouse position is: (%d, %d)\n", test_event.motion.x, test_event.motion.y);
-      break;
-    default:
-      printf("Unhandled Event!\n");
-      break;
-  }
-}
-printf("Event queue empty.\n");

It is also possible to push events onto the event queue and so use it as a two-way communication path. Both SDL_PushEvent and SDL_PeepEvents allow you to place events onto the event queue. This is usually used to place a SDL_USEREVENT on the event queue, however you could use it to post fake input events if you wished. Creating your own events is a simple matter of choosing the event type you want, setting the type member and filling the appropriate member structure with information. -

SDL_Event user_event;
-
-user_event.type=SDL_USEREVENT;
-user_event.user.code=2;
-user_event.user.data1=NULL;
-user_event.user.data2=NULL;
-SDL_PushEvent(&user_event);

SDL_EventState

Name

SDL_EventState -- This function allows you to set the state of processing certain events.

Synopsis

#include "SDL.h"

Uint8 SDL_EventState(Uint8 type, int state);

Description

This function allows you to set the state of processing certain event type's.

If state is set to SDL_IGNORE, -that event type will be automatically dropped from the event queue and will -not be filtered.

If state is set to SDL_ENABLE, -that event type will be processed normally.

If state is set to SDL_QUERY, -SDL_EventState will return the current processing -state of the specified event type.

A list of event type's can be found in the SDL_Event section.

SDL_ExposeEvent

Name

SDL_ExposeEvent -- Quit requested event

Structure Definition

typedef struct{
-  Uint8 type
-} SDL_ExposeEvent;

Structure Data

type SDL_VIDEOEXPOSE

Description

SDL_ExposeEvent is a member of the SDL_Event union and is used whan an event of type SDL_VIDEOEXPOSE is reported.

A VIDEOEXPOSE event is triggered when the screen has been modified -outside of the application, usually by the window manager and needs to -be redrawn.

SDL_FillRect

Name

SDL_FillRect -- This function performs a fast fill of the given rectangle with some color

Synopsis

#include "SDL.h"

int SDL_FillRect(SDL_Surface *dst, SDL_Rect *dstrect, Uint32 color);

Description

This function performs a fast fill of the given rectangle with -color. If dstrect -is NULL, the whole surface will be filled with -color.

The color should be a pixel of the format used by the surface, and -can be generated by the -SDL_MapRGB or SDL_MapRGBA -functions. If the color value contains an alpha value then the -destination is simply "filled" with that alpha information, no blending -takes place.

If there is a clip rectangle set on the destination (set via -SDL_SetClipRect) then this -function will clip based on the intersection of the clip rectangle and -the dstrect rectangle and the dstrect rectangle -will be modified to represent the area actually filled.

Return Value

This function returns 0 on success, or --1 on error.

SDL_Flip

Name

SDL_Flip -- Swaps screen buffers

Synopsis

#include "SDL.h"

SDL_GetAppState -- Get the state of the application

Synopsis

#include "SDL.h"

Uint8 SDL_GetAppState(void);

Description

This function returns the current state of the application. The value returned is a bitwise combination of:

`SDL_APPMOUSEFOCUS`	The application has mouse focus.
`SDL_APPINPUTFOCUS`	The application has keyboard focus
`SDL_APPACTIVE`	The application is visible

SDL_GetAudioStatus

Name

SDL_GetAudioStatus -- Get the current audio state

Synopsis

#include "SDL.h"

SDL_audiostatusSDL_GetAudioStatus(void);

Description

typedef enum{
-  SDL_AUDIO_STOPPED,
-  SDL_AUDIO_PAUSED,
-  SDL_AUDIO_PLAYING
-} SDL_audiostatus;

Returns either SDL_AUDIO_STOPPED, SDL_AUDIO_PAUSED or SDL_AUDIO_PLAYING depending on the current audio state.

SDL_GetClipRect

Name

SDL_GetClipRect -- Gets the clipping rectangle for a surface.

Synopsis

#include "SDL.h"

void SDL_GetClipRect(SDL_Surface *surface, SDL_Rect *rect);

Description

Gets the clipping rectangle for a surface. When this surface is the -destination of a blit, only the area within the clip rectangle is -drawn into.

The rectangle pointed to by rect will be -filled with the clipping rectangle of the surface.

SDL_GetCursor

Name

SDL_GetCursor -- Get the currently active mouse cursor.

Synopsis

#include "SDL.h"

SDL_Cursor *SDL_GetCursor(void);

Description

Returns the currently active mouse cursor.

SDL_GetError

Name

SDL_GetError -- Get SDL error string

Synopsis

#include "SDL/SDL.h"

char *SDL_GetError(void);

Description

SDL_GetError returns a NULL terminated string containing information about the last internal SDL error.

Return Value

SDL_GetError returns a string containing the last error.

Prev	Home	Next
SDL_WasInit	Up	SDL_envvars

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/sdlgeteventfilter.html --- a/docs/html/sdlgeteventfilter.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,235 +0,0 @@ -SDL_GetEventFilter

SDL Library Documentation
Prev		Next

SDL_GetEventFilter

Name

SDL_GetEventFilter -- Retrieves a pointer to he event filter

Synopsis

#include "SDL.h"

SDL_EventFilter SDL_GetEventFilter(void);

Description

This function retrieces a pointer to the event filter that was previously set using SDL_SetEventFilter. An SDL_EventFilter function is defined as: -

typedef int (*SDL_EventFilter)(const SDL_Event *event);

Return Value

Returns a pointer to the event filter or NULL if no filter has been set.

SDL_GetGammaRamp

Name

SDL_GetGammaRamp -- Gets the color gamma lookup tables for the display

Synopsis

#include "SDL.h"

int SDL_GetGammaRamp(Uint16 *redtable, Uint16 *greentable, Uint16 *bluetable);

Description

Gets the gamma translation lookup tables currently used by the display. -Each table is an array of 256 Uint16 values.

Not all display hardware is able to change gamma.

Return Value

Returns -1 on error.

SDL_GetKeyName

Name

SDL_GetKeyName -- Get the name of an SDL virtual keysym

Synopsis

#include "SDL.h"

char *SDL_GetKeyName(SDLKey key);

Description

Returns the SDL-defined name of the SDLKey key.

SDL_GetKeyState

Name

SDL_GetKeyState -- Get a snapshot of the current keyboard state

Synopsis

#include "SDL.h"

Uint8 *SDL_GetKeyState(int *numkeys);

Description

Gets a snapshot of the current keyboard state. The current state is return as a pointer to an array, the size of this array is stored in numkeys. The array is indexed by the SDLK_* symbols. A value of 1 means the key is pressed and a value of 0 means its not. The pointer returned is a pointer to an internal SDL array and should not be freed by the caller.

Note: Use SDL_PumpEvents to update the state array.

Example

Uint8 *keystate = SDL_GetKeyState(NULL);
-if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed.\n");

SDL_GetModState

Name

SDL_GetModState -- Get the state of modifier keys.

Synopsis

#include "SDL.h"

SDLMod SDL_GetModState(void);

Description

Returns the current state of the modifier keys (CTRL, ALT, etc.).

Return Value

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

SDLMod

typedef enum {
-  KMOD_NONE  = 0x0000,
-  KMOD_LSHIFT= 0x0001,
-  KMOD_RSHIFT= 0x0002,
-  KMOD_LCTRL = 0x0040,
-  KMOD_RCTRL = 0x0080,
-  KMOD_LALT  = 0x0100,
-  KMOD_RALT  = 0x0200,
-  KMOD_LMETA = 0x0400,
-  KMOD_RMETA = 0x0800,
-  KMOD_NUM   = 0x1000,
-  KMOD_CAPS  = 0x2000,
-  KMOD_MODE  = 0x4000,
-} SDLMod;

-SDL also defines the following symbols for convenience: -

#define KMOD_CTRL (KMOD_LCTRL|KMOD_RCTRL)
-#define KMOD_SHIFT  (KMOD_LSHIFT|KMOD_RSHIFT)
-#define KMOD_ALT  (KMOD_LALT|KMOD_RALT)
-#define KMOD_META (KMOD_LMETA|KMOD_RMETA)

SDL_GetMouseState

Name

SDL_GetMouseState -- Retrieve the current state of the mouse

Synopsis

#include "SDL.h"

Uint8 SDL_GetMouseState(int *x, int *y);

Description

The current button state is returned as a button bitmask, which can -be tested using the SDL_BUTTON(X) macros, and x and y are set to the -current mouse cursor position. You can pass NULL for either x or y.

Example

SDL_PumpEvents();
-if(SDL_GetMouseState(NULL, NULL)&SDL_BUTTON(1))
-  printf("Mouse Button 1(left) is pressed.\n");

SDL_GetRelativeMouseState

Name

SDL_GetRelativeMouseState -- Retrieve the current state of the mouse

Synopsis

#include "SDL.h"

Uint8 SDL_GetRelativeMouseState(int *x, int *y);

Description

The current button state is returned as a button bitmask, which can -be tested using the SDL_BUTTON(X) macros, and x and y are set to the change in the mouse position since the last call to SDL_GetRelativeMouseState or since event initialization. You can pass NULL for either x or y.

SDL_GetRGB

Name

SDL_GetRGB -- Get RGB values from a pixel in the specified pixel format.

Synopsis

#include "SDL.h"

void SDL_GetRGB(Uint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g, Uint8 *b);

Description

Get RGB component values from a pixel stored in the specified pixel format.

This function uses the entire 8-bit [0..255] range when converting color -components from pixel formats with less than 8-bits per RGB component -(e.g., a completely white pixel in 16-bit RGB565 format would return -[0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).

SDL_GetRGBA

Name

SDL_GetRGBA -- Get RGBA values from a pixel in the specified pixel format.

Synopsis

#include "SDL.h"

void SDL_GetRGBA(Uint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a);

Description

Get RGBA component values from a pixel stored in the specified pixel format.

If the surface has no alpha component, the alpha will be returned as 0xff -(100% opaque).

SDL_GetThreadID

Name

SDL_GetThreadID -- Get the SDL thread ID of a SDL_Thread

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

Uint32 SDL_GetThreadID(SDL_Thread *thread);

Description

Returns the ID of a SDL_Thread created by SDL_CreateThread.

SDL_GetTicks

Name

SDL_GetTicks -- Get the number of milliseconds since the SDL library initialization.

Synopsis

#include "SDL.h"

Uint32 SDL_GetTicks(void);

Description

Get the number of milliseconds since the SDL library initialization. -Note that this value wraps if the program runs for more than ~49 days.

SDL_GetVideoInfo

Name

SDL_GetVideoInfo -- returns a pointer to information about the video hardware

Synopsis

#include "SDL.h"

SDL_VideoInfo *SDL_GetVideoInfo(void);

Description

This function returns a read-only pointer to information about the video -hardware. If this is called before SDL_SetVideoMode, the -vfmt member of the returned structure will contain the -pixel format of the "best" video mode.

SDL_GetVideoSurface

Name

SDL_GetVideoSurface -- returns a pointer to the current display surface

Synopsis

#include "SDL.h"

SDL_Surface *SDL_GetVideoSurface(void);

Description

This function returns a pointer to the current display surface. -If SDL is doing format conversion on the display surface, this -function returns the publicly visible surface, not the real video -surface.

SDL_GLattr

Name

SDL_GLattr -- SDL GL Attributes

Attributes

`SDL_GL_RED_SIZE`	Size of the framebuffer red component, in bits
`SDL_GL_GREEN_SIZE`	Size of the framebuffer green component, in bits
`SDL_GL_BLUE_SIZE`	Size of the framebuffer blue component, in bits
`SDL_GL_ALPHA_SIZE`	Size of the framebuffer alpha component, in bits
`SDL_GL_DOUBLEBUFFER`	0 or 1, enable or disable double buffering
`SDL_GL_BUFFER_SIZE`	Size of the framebuffer, in bits
`SDL_GL_DEPTH_SIZE`	Size of the depth buffer, in bits
`SDL_GL_STENCIL_SIZE`	Size of the stencil buffer, in bits
`SDL_GL_ACCUM_RED_SIZE`	Size of the accumulation buffer red component, in bits
`SDL_GL_ACCUM_GREEN_SIZE`	Size of the accumulation buffer green component, in bits
`SDL_GL_ACCUM_BLUE_SIZE`	Size of the accumulation buffer blue component, in bits
`SDL_GL_ACCUM_ALPHA_SIZE`	Size of the accumulation buffer alpha component, in bits

Description

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 SDL_GL_SetAttribute and SDL_GL_GetAttribute.

SDL_GL_GetAttribute

Name

SDL_GL_GetAttribute -- Get the value of a special SDL/OpenGL attribute

Synopsis

#include "SDL.h"

int SDL_GL_GetAttribute(SDLGLattr attr, int *value);

Description

Places the value of the SDL/OpenGL attribute attr into value. This is useful after a call to SDL_SetVideoMode to check whether your attributes have been set as you expected.

Return Value

Returns 0 on success, or -1 on an error.

SDL_GL_GetProcAddress

Name

SDL_GL_GetProcAddress -- Get the address of a GL function

Synopsis

#include "SDL.h"

void *SDL_GL_GetProcAddress(const char* proc);

Description

Returns the address of the GL function proc, or NULL if the function is not found. If the GL library is loaded at runtime, with SDL_GL_LoadLibrary, then all GL functions must be retrieved this way. Usually this is used to retrieve function pointers to OpenGL extensions.

Example

typedef void (*GL_ActiveTextureARB_Func)(unsigned int);
-GL_ActiveTextureARB_Func glActiveTextureARB_ptr = 0;
-int has_multitexture=1;
-.
-.
-.
-/* Get function pointer */
-glActiveTextureARB_ptr=(GL_ActiveTextureARB_Func) SDL_GL_GetProcAddress("glActiveTextureARB");
-
-/* Check for a valid function ptr */
-if(!glActiveTextureARB_ptr){
-  fprintf(stderr, "Multitexture Extensions not present.\n");
-  has_multitexture=0;
-}
-.
-.
-.
-.
-if(has_multitexture){
-  glActiveTextureARB_ptr(GL_TEXTURE0_ARB);
-  .
-  .
-}
-else{
-  .
-  .
-}

SDL_GL_LoadLibrary

Name

SDL_GL_LoadLibrary -- Specify an OpenGL library

Synopsis

#include "SDL.h"

int SDL_GL_LoadLibrary(const char *path);

Description

If you wish, you may load the OpenGL library at runtime, this must be done before SDL_SetVideoMode is called. The path of the GL library is passed to SDL_GL_LoadLibrary and it returns 0 on success, or -1 on an error. You must then use SDL_GL_GetProcAddress to retrieve function pointers to GL functions.

SDL_GL_SetAttribute

Name

SDL_GL_SetAttribute -- Set a special SDL/OpenGL attribute

Synopsis

#include "SDL.h"

int SDL_GL_SetAttribute(SDL_GLattr attr, int value);

Description

Sets the OpenGL attribute attr to value. The attributes you set don't take effect until after a call to SDL_SetVideoMode. You should use SDL_GL_GetAttribute to check the values after a SDL_SetVideoMode call.

Return Value

Returns 0 on success, or -1 on error.

Example

SDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 );
-SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 );
-SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 );
-SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 );
-SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 );
-if ( (screen=SDL_SetVideoMode( 640, 480, 16, SDL_OPENGL )) == NULL ) {
-  fprintf(stderr, "Couldn't set GL mode: %s\n", SDL_GetError());
-  SDL_Quit();
-  return;
-}

Note: The SDL_DOUBLEBUF flag is not required to enable double buffering when setting an OpenGL video mode. Double buffering is enabled or disabled using the SDL_GL_DOUBLEBUFFER attribute.

SDL_GL_SwapBuffers

Name

SDL_GL_SwapBuffers -- Swap OpenGL framebuffers/Update Display

Synopsis

#include "SDL.h"

void SDL_GL_SwapBuffers(void );

Description

Swap the OpenGL buffers, if double-buffering is supported.

SDL_Init

Name

SDL_Init -- Initializes SDL

Synopsis

#include "SDL.h"

int SDL_Init(Uint32 flags);

Description

Initializes SDL. This should be called before all other SDL functions. The flags parameter specifies what part(s) of SDL to initialize.

`SDL_INIT_TIMER`	Initializes the timer subsystem.
`SDL_INIT_AUDIO`	Initializes the audio subsystem.
`SDL_INIT_VIDEO`	Initializes the video subsystem.
`SDL_INIT_CDROM`	Initializes the cdrom subsystem.
`SDL_INIT_JOYSTICK`	Initializes the joystick subsystem.
`SDL_INIT_EVERYTHING`	Initialize all of the above.
`SDL_INIT_NOPARACHUTE`	Prevents SDL from catching fatal signals.
`SDL_INIT_EVENTTHREAD`

Return Value

Returns -1 on an error or 0 on success.

SDL_InitSubSystem

Name

SDL_InitSubSystem -- Initialize subsystems

Synopsis

#include "SDL.h"

int SDL_InitSubSystem(Uint32 flags);

Description

After SDL has been initialized with SDL_Init you may initialize uninitialized subsystems with SDL_InitSubSystem. The flags parameter is the same as that used in SDL_Init.

Examples

/* Seperating Joystick and Video initialization. */
-SDL_Init(SDL_INIT_VIDEO);
-.
-.
-SDL_SetVideoMode(640, 480, 16, SDL_DOUBLEBUF|SDL_FULLSCREEN);
-.
-/* Do Some Video stuff */
-.
-.
-/* Initialize the joystick subsystem */
-SDL_InitSubSystem(SDL_INIT_JOYSTICK);
-
-/* Do some stuff with video and joystick */
-.
-.
-.
-/* Shut them both down */
-SDL_Quit();

Return Value

Returns -1 on an error or 0 on success.

SDL_JoyAxisEvent

Name

SDL_JoyAxisEvent -- Joystick axis motion event structure

Structure Definition

typedef struct{
-  Uint8 type;
-  Uint8 which;
-  Uint8 axis;
-  Sint16 value;
-} SDL_JoyAxisEvent;

Structure Data

`type`	`SDL_JOYAXISMOTION`
`which`	Joystick device index
`axis`	Joystick axis index
`value`	Axis value (range: -32768 to 32767)

Description

SDL_JoyAxisEvent is a member of the SDL_Event union and is used when an event of type SDL_JOYAXISMOTION is reported.

A SDL_JOYAXISMOTION event occurs when ever a user moves an axis on the joystick. The field which is the index of the joystick that reported the event and axis is the index of the axis (for a more detailed explaination see the Joystick section). value is the current position of the axis.

SDL_JoyBallEvent

Name

SDL_JoyBallEvent -- Joystick trackball motion event structure

Structure Definition

typedef struct{
-  Uint8 type;
-  Uint8 which;
-  Uint8 ball;
-  Sint16 xrel, yrel;
-} SDL_JoyBallEvent;

Structure Data

`type`	`SDL_JOYBALLMOTION`
`which`	Joystick device index
`ball`	Joystick trackball index
`xrel`, `yrel`	The relative motion in the X/Y direction

Description

SDL_JoyBallEvent is a member of the SDL_Event union and is used when an event of type SDL_JOYBALLMOTION is reported.

A SDL_JOYBALLMOTION event occurs when a user moves a trackball on the joystick. The field which is the index of the joystick that reported the event and ball is the index of the trackball (for a more detailed explaination see the Joystick section). Trackballs only return relative motion, this is the change in position on the ball since it was last polled (last cycle of the event loop) and it is stored in xrel and yrel.

SDL_JoyButtonEvent

Name

SDL_JoyButtonEvent -- Joystick button event structure

Structure Definition

typedef struct{
-  Uint8 type;
-  Uint8 which;
-  Uint8 button;
-  Uint8 state;
-} SDL_JoyButtonEvent;

Structure Data

`type`	`SDL_JOYBUTTONDOWN` or `SDL_JOYBUTTONUP`
`which`	Joystick device index
`button`	Joystick button index
`state`	`SDL_PRESSED` or `SDL_RELEASED`

Description

SDL_JoyButtonEvent is a member of the SDL_Event union and is used when an event of type SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP is reported.

A SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP event occurs when ever a user presses or releases a button on a joystick. The field which is the index of the joystick that reported the event and button is the index of the button (for a more detailed explaination see the Joystick section). state is the current state or the button which is either SDL_PRESSED or SDL_RELEASED.

SDL_JoyHatEvent

Name

SDL_JoyHatEvent -- Joystick hat position change event structure

Structure Definition

typedef struct{
-  Uint8 type;
-  Uint8 which;
-  Uint8 hat;
-  Uint8 value;
-} SDL_JoyHatEvent;

Structure Data

`type`	`SDL_JOY`
`which`	Joystick device index
`hat`	Joystick hat index
`value`	Hat position

Description

SDL_JoyHatEvent is a member of the SDL_Event union and is used when an event of type SDL_JOYHATMOTION is reported.

A SDL_JOYHATMOTION event occurs when ever a user moves a hat on the joystick. The field which is the index of the joystick that reported the event and hat is the index of the hat (for a more detailed exlaination see the Joystick section). value is the current position of the hat. It is a logically OR'd combination of the following values (whose meanings should be pretty obvious:) :

SDL_HAT_CENTERED

SDL_HAT_UP

SDL_HAT_RIGHT

SDL_HAT_DOWN

SDL_HAT_LEFT

The following defines are also provided:

SDL_HAT_RIGHTUP

SDL_HAT_RIGHTDOWN

SDL_HAT_LEFTUP

SDL_HAT_LEFTDOWN

SDL_JoystickClose

Name

SDL_JoystickClose -- Closes a previously opened joystick

Synopsis

#include "SDL.h"

void SDL_JoystickClose(SDL_Joystick *joystick);

Description

Close a joystick that was previously opened with SDL_JoystickOpen.

SDL_JoystickEventState

Name

SDL_JoystickEventState -- Enable/disable joystick event polling

Synopsis

#include "SDL.h"

int SDL_JoystickEventState(int state);

Description

This function is used to enable or disable joystick event processing. With joystick event processing disabled you will have to update joystick states with SDL_JoystickUpdate and read the joystick information manually. state is either SDL_QUERY, SDL_ENABLE or SDL_IGNORE.

Note: Joystick event handling is prefered

Return Value

If state is SDL_QUERY then the current state is returned, otherwise the new processing state is returned.

SDL_JoystickGetAxis

Name

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 SDL_JoystickGetAxis is a signed integer (-32768 to 32768) representing the current position of the axis, it maybe necessary to impose certain tolerances on these values to account for jitter. It is worth noting that some joysticks use axes 2 and 3 for extra buttons.

Return Value

Returns a 16-bit signed integer representing the current position of the axis.

Examples

Sint16 x_move, y_move;
-SDL_Joystick *joy1;
-.
-.
-x_move=SDL_JoystickGetAxis(joy1, 0);
-y_move=SDL_JoystickGetAxis(joy1, 1);

SDL_JoystickGetBall

Name

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

Examples

int delta_x, delta_y;
-SDL_Joystick *joy;
-.
-.
-.
-SDL_JoystickUpdate();
-if(SDL_JoystickGetBall(joy, 0, &delta_x, &delta_y)==-1)
-  printf("TrackBall Read Error!\n");
-printf("Trackball Delta- X:%d, Y:%d\n", delta_x, delta_y);

SDL_JoystickGetButton

Name

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.

SDL_JoystickGetHat

Name

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 following

SDL_HAT_CENTERED

SDL_HAT_UP

SDL_HAT_RIGHT

SDL_HAT_DOWN

SDL_HAT_LEFT

SDL_HAT_RIGHTUP

SDL_HAT_RIGHTDOWN

SDL_HAT_LEFTUP

SDL_HAT_LEFTDOWN

SDL_JoystickIndex

Name

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.

SDL_JoystickName

Name

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();
-printf("%d joysticks found\n", num_joy);
-for(i=0;i<num_joy;i++)
-  printf("%s\n", SDL_JoystickName(i));

SDL_JoystickNumAxes

Name

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.

SDL_JoystickNumBalls

Name

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.

SDL_JoystickNumButtons

Name

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.

SDL_JoystickNumHats

Name

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.

SDL_JoystickOpen

Name

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;
-// Check for joystick
-if(SDL_NumJoysticks()>0){
-  // Open joystick
-  joy=SDL_JoystickOpen(0);
-  
-  if(joy)
-  {
-    printf("Opened Joystick 0\n");
-    printf("Name: %s\n", SDL_JoystickName(0));
-    printf("Number of Axes: %d\n", SDL_JoystickNumAxes(joy));
-    printf("Number of Buttons: %d\n", SDL_JoystickNumButtons(joy));
-    printf("Number of Balls: %d\n", SDL_JoystickNumBalls(joy));
-  }
-  else
-    printf("Couldn't open Joystick 0\n");
-  
-  // Close if opened
-  if(SDL_JoystickOpened(0))
-    SDL_JoystickClose(joy);
-}

SDL_JoystickOpened

Name

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.

SDL_JoystickUpdate

Name

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.

SDLKey

Name

SDLKey -- Keysym definitions.

Description

Table 8-1. SDL Keysym definitions

SDLKey	ASCII value	Common name
SDLK_BACKSPACE	'\b'	backspace
SDLK_TAB	'\t'	tab
SDLK_CLEAR		clear
SDLK_RETURN	'\r'	return
SDLK_PAUSE		pause
SDLK_ESCAPE	'^['	escape
SDLK_SPACE	' '	space
SDLK_EXCLAIM	'!'	exclaim
SDLK_QUOTEDBL	'"'	quotedbl
SDLK_HASH	'#'	hash
SDLK_DOLLAR	'$'	dollar
SDLK_AMPERSAND	'&'	ampersand
SDLK_QUOTE	'''	quote
SDLK_LEFTPAREN	'('	left parenthesis
SDLK_RIGHTPAREN	')'	right parenthesis
SDLK_ASTERISK	'*'	asterisk
SDLK_PLUS	'+'	plus sign
SDLK_COMMA	','	comma
SDLK_MINUS	'-'	minus sign
SDLK_PERIOD	'.'	period
SDLK_SLASH	'/'	forward slash
SDLK_0	'0'	0
SDLK_1	'1'	1
SDLK_2	'2'	2
SDLK_3	'3'	3
SDLK_4	'4'	4
SDLK_5	'5'	5
SDLK_6	'6'	6
SDLK_7	'7'	7
SDLK_8	'8'	8
SDLK_9	'9'	9
SDLK_COLON	':'	colon
SDLK_SEMICOLON	';'	semicolon
SDLK_LESS	'<'	less-than sign
SDLK_EQUALS	'='	equals sign
SDLK_GREATER	'>'	greater-than sign
SDLK_QUESTION	'?'	question mark
SDLK_AT	'@'	at
SDLK_LEFTBRACKET	'['	left bracket
SDLK_BACKSLASH	'\'	backslash
SDLK_RIGHTBRACKET	']'	right bracket
SDLK_CARET	'^'	caret
SDLK_UNDERSCORE	'_'	underscore
SDLK_BACKQUOTE	'`'	grave
SDLK_a	'a'	a
SDLK_b	'b'	b
SDLK_c	'c'	c
SDLK_d	'd'	d
SDLK_e	'e'	e
SDLK_f	'f'	f
SDLK_g	'g'	g
SDLK_h	'h'	h
SDLK_i	'i'	i
SDLK_j	'j'	j
SDLK_k	'k'	k
SDLK_l	'l'	l
SDLK_m	'm'	m
SDLK_n	'n'	n
SDLK_o	'o'	o
SDLK_p	'p'	p
SDLK_q	'q'	q
SDLK_r	'r'	r
SDLK_s	's'	s
SDLK_t	't'	t
SDLK_u	'u'	u
SDLK_v	'v'	v
SDLK_w	'w'	w
SDLK_x	'x'	x
SDLK_y	'y'	y
SDLK_z	'z'	z
SDLK_DELETE	'^?'	delete
SDLK_KP0		keypad 0
SDLK_KP1		keypad 1
SDLK_KP2		keypad 2
SDLK_KP3		keypad 3
SDLK_KP4		keypad 4
SDLK_KP5		keypad 5
SDLK_KP6		keypad 6
SDLK_KP7		keypad 7
SDLK_KP8		keypad 8
SDLK_KP9		keypad 9
SDLK_KP_PERIOD	'.'	keypad period
SDLK_KP_DIVIDE	'/'	keypad divide
SDLK_KP_MULTIPLY	'*'	keypad multiply
SDLK_KP_MINUS	'-'	keypad minus
SDLK_KP_PLUS	'+'	keypad plus
SDLK_KP_ENTER	'\r'	keypad enter
SDLK_KP_EQUALS	'='	keypad equals
SDLK_UP		up arrow
SDLK_DOWN		down arrow
SDLK_RIGHT		right arrow
SDLK_LEFT		left arrow
SDLK_INSERT		insert
SDLK_HOME		home
SDLK_END		end
SDLK_PAGEUP		page up
SDLK_PAGEDOWN		page down
SDLK_F1		F1
SDLK_F2		F2
SDLK_F3		F3
SDLK_F4		F4
SDLK_F5		F5
SDLK_F6		F6
SDLK_F7		F7
SDLK_F8		F8
SDLK_F9		F9
SDLK_F10		F10
SDLK_F11		F11
SDLK_F12		F12
SDLK_F13		F13
SDLK_F14		F14
SDLK_F15		F15
SDLK_NUMLOCK		numlock
SDLK_CAPSLOCK		capslock
SDLK_SCROLLOCK		scrollock
SDLK_RSHIFT		right shift
SDLK_LSHIFT		left shift
SDLK_RCTRL		right ctrl
SDLK_LCTRL		left ctrl
SDLK_RALT		right alt
SDLK_LALT		left alt
SDLK_RMETA		right meta
SDLK_LMETA		left meta
SDLK_LSUPER		left windows key
SDLK_RSUPER		right windows key
SDLK_MODE		mode shift
SDLK_HELP		help
SDLK_PRINT		print-screen
SDLK_SYSREQ		SysRq
SDLK_BREAK		break
SDLK_MENU		menu
SDLK_POWER		power
SDLK_EURO		euro

- -

Table 8-2. SDL modifier definitions

SDL Modifier	Meaning
KMOD_NONE	No modifiers applicable
KMOD_NUM	Numlock is down
KMOD_CAPS	Capslock is down
KMOD_LCTRL	Left Control is down
KMOD_RCTRL	Right Control is down
KMOD_RSHIFT	Right Shift is down
KMOD_LSHIFT	Left Shift is down
KMOD_RALT	Right Alt is down
KMOD_LALT	Left Alt is down
KMOD_CTRL	A Control key is down
KMOD_SHIFT	A Shift key is down
KMOD_ALT	An Alt key is down

Prev	Home	Next
SDL_keysym	Up	Event Functions.

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/sdlkeyboardevent.html --- a/docs/html/sdlkeyboardevent.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,375 +0,0 @@ -SDL_KeyboardEvent

SDL Library Documentation
Prev		Next

SDL_KeyboardEvent

Name

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 type and state actually report the same information, they just use different values to do it! A keyboard event occurs when a key is released (type=SDK_KEYUP or state=SDL_RELEASED) and when a key is pressed (type=SDL_KEYDOWN or state=SDL_PRESSED). The information on what key was pressed or released is in the keysym structure.

Note: Repeating SDL_KEYDOWN events will occur if key repeat is enabled (see SDL_EnableKeyRepeat).

SDL_keysym

Name

SDL_keysym -- Keysym structure

Structure Definition

typedef struct{
-  Uint8 scancode;
-  SDLKey sym;
-  SDLMod mod;
-  Uint16 unicode;
-} SDL_keysym;

Structure Data

`scancode`	Hardware specific scancode
`sym`	SDL virtual keysym
`mod`	Current key modifiers
`unicode`	Translated character

Description

The SDL_keysym structure is used by reporting key presses and releases since it is a part of the SDL_KeyboardEvent.

The scancode field should generally be left alone, it is the hardware dependent scancode returned by the keyboard. The sym field is extremely useful. It is the SDL-defined value of the key (see SDL Key Syms. This field is very useful when you are checking for certain key presses, like so: -

.
-.
-while(SDL_PollEvent(&event)){
-  switch(event.type){
-    case SDL_KEYDOWN:
-      if(event.key.keysym.sym==SDLK_LEFT)
-        move_left();
-      break;
-    .
-    .
-    .
-  }
-}
-.
-.

-mod stores the current state of the keyboard modifiers as explained in SDL_GetModState. The unicode is only used when UNICODE translation is enabled with SDL_EnableUNICODE. If unicode is non-zero then this a the UNICODE character corresponding to the keypress. If the high 9 bits of the character are 0, then this maps to the equivalent ASCII character: -

char ch;
-if ( (keysym.unicode & 0xFF80) == 0 ) {
-  ch = keysym.unicode & 0x7F;
-}
-else {
-  printf("An International Character.\n");
-}

-UNICODE translation does have a slight overhead so don't enable it unless its needed.

SDL_KillThread

Name

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.

SDL_ListModes

Name

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 dimensions available for a particular -format, or -1 if any dimension is okay for -the given format.

If format is NULL, the mode list -will be for the format returned by SDL_GetVideoInfo()->vfmt. The flag parameter is an OR'd combination of surface flags. The flags are the same as those used SDL_SetVideoMode and they play a strong role in deciding what modes are valid. For instance, if you pass SDL_HWSURFACE as a flag only modes that support hardware video surfaces will be returned.

Example

SDL_Rect **modes;
-int i;
-.
-.
-.
-
-/* Get available fullscreen/hardware modes */
-modes=SDL_ListModes(NULL, SDL_FULLSCREEN|SDL_HWSURFACE);
-
-/* Check is there are any modes available */
-if(modes == (SDL_Rect **)0){
-  printf("No modes available!\n");
-  exit(-1);
-}
-
-/* Check if our resolution is restricted */
-if(modes == (SDL_Rect **)-1){
-  printf("All resolutions available.\n");
-}
-else{
-  /* Print valid modes */
-  printf("Available Modes\n");
-  for(i=0;modes[i];++i)
-    printf("  %d x %d\n", modes[i]->w, modes[i]->h);
-}
-.
-.

SDL_LoadBMP

Name

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.

SDL_LoadWAV

Name

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 containing the audio data, and sets audio_len -to the length of that audio buffer, in bytes. You need to free the audio -buffer with SDL_FreeWAV when you are -done with it.

This function returns NULL and sets the SDL -error message if the wave file cannot be opened, uses an unknown data format, -or is corrupt. Currently raw, MS-ADPCM and IMA-ADPCM WAVE files are supported.

Example

SDL_AudioSpec wav_spec;
-Uint32 wav_length;
-Uint8 *wav_buffer;
-
-/* Load the WAV */
-if( SDL_LoadWAV("test.wav", &wav_spec, &wav_buffer, &wav_length) == NULL ){
-  fprintf(stderr, "Could not open test.wav: %s\n", SDL_GetError());
-  exit(-1);
-}
-.
-.
-.
-/* Do stuff with the WAV */
-.
-.
-/* Free It */
-SDL_FreeWAV(wav_buffer);

SDL_LockAudio

Name

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.

SDL_LockSurface

Name

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 use SDL_UnlockSurface to release it.

Not all surfaces require locking. -If SDL_MUSTLOCK(surface) -evaluates to 0, then you can read and write to the -surface at any time, and the pixel format of the surface will not change.

No operating system or library calls should be made between lock/unlock -pairs, as critical system locks may be held during this time.

It should be noted, that since SDL 1.1.8 surface locks are recursive. This means that you can lock a surface multiple times, but each lock must have a match unlock. -

    .
-    .
-    SDL_LockSurface( surface );
-    .
-    /* Surface is locked */
-    /* Direct pixel access on surface here */
-    .
-    SDL_LockSurface( surface );
-    .
-    /* More direct pixel access on surface */
-    .
-    SDL_UnlockSurface( surface );
-    /* Surface is still locked */
-    /* Note: Is versions < 1.1.8, the surface would have been */
-    /* no longer locked at this stage                         */
-    .
-    SDL_UnlockSurface( surface );
-    /* Surface is now unlocked */
-    .
-    .

Return Value

SDL_LockSurface returns 0, -or -1 if the surface couldn't be locked.

SDL_LockYUVOverlay

Name

SDL_LockYUVOverlay -- Lock an overlay

Synopsis

#include "SDL.h"

int SDL_LockYUVOverlay(SDL_Overlay *overlay);

Description

Much the same as SDL_LockSurface, SDL_LockYUVOverlay locks the overlay for direct access to pixel data.

Return Value

Returns 0 on success, or -1 on an error.

SDL_MapRGB

Name

SDL_MapRGB -- Map a RGB color value to a pixel format.

Synopsis

#include "SDL.h"

Uint32 SDL_MapRGB(SDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b);

Description

Maps the RGB color value to the specified pixel format and returns the -pixel value as a 32-bit int.

If the format has a palette (8-bit) the index of the closest matching -color in the palette will be returned.

If the specified pixel format has an alpha component it will be returned -as all 1 bits (fully opaque).

Return Value

A pixel value best approximating the given RGB color value for a given -pixel format. If the pixel format bpp (color depth) is less than 32-bpp -then the unused upper bits of the return value can safely be ignored -(e.g., with a 16-bpp format the return value can be assigned to a -Uint16, and similarly a Uint8 for an 8-bpp -format).

SDL_MapRGBA

Name

SDL_MapRGBA -- Map a RGBA color value to a pixel format.

Synopsis

#include "SDL.h"

Uint32 SDL_MapRGBA(SDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b, Uint8 a);

Description

Maps the RGBA color value to the specified pixel format and returns the -pixel value as a 32-bit int.

If the format has a palette (8-bit) the index of the closest matching -color in the palette will be returned.

If the specified pixel format has no alpha component the alpha value -will be ignored (as it will be in formats with a palette).

Return Value

A pixel value best approximating the given RGBA color value for a given -pixel format. If the pixel format bpp (color depth) is less than 32-bpp -then the unused upper bits of the return value can safely be ignored -(e.g., with a 16-bpp format the return value can be assigned to a -Uint16, and similarly a Uint8 for an 8-bpp -format).

SDL_MixAudio

Name

SDL_MixAudio -- Mix audio data

Synopsis

#include "SDL.h"

void SDL_MixAudio(Uint8 *dst, Uint8 *src, Uint32 len, int volume);

Description

This function takes two audio buffers of len bytes each -of the playing audio format and mixes them, performing addition, volume -adjustment, and overflow clipping. The volume ranges -from 0 to SDL_MIX_MAXVOLUME and should be set to the maximum -value for full audio volume. Note this does not change hardware volume. This is -provided for convenience -- you can mix your own audio data.

Note: Do not use this function for mixing together more than two streams of sample -data. The output from repeated application of this function may be distorted -by clipping, because there is no accumulator with greater range than the -input (not to mention this being an inefficient way of doing it). -Use mixing functions from SDL_mixer, OpenAL, or write your own mixer instead.

SDL_MouseButtonEvent

Name

SDL_MouseButtonEvent -- Mouse button event structure

Structure Definition

typedef struct{
-  Uint8 type;
-  Uint8 button;
-  Uint8 state;
-  Uint16 x, y;
-} SDL_MouseButtonEvent;

Structure Data

`type`	`SDL_MOUSEBUTTONDOWN` or `SDL_MOUSEBUTTONUP`
`button`	The mouse button index (SDL_BUTTON_LEFT, SDL_BUTTON_MIDDLE, SDL_BUTTON_RIGHT)
`state`	`SDL_PRESSED` or `SDL_RELEASED`
`x`, `y`	The X/Y coordinates of the mouse at press/release time

Description

SDL_MouseButtonEvent is a member of the SDL_Event union and is used when an event of type SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP is reported.

When a mouse button press or release is detected then number of the button pressed (from 1 to 255, with 1 usually being the left button and 2 the right) is placed into button, the position of the mouse when this event occured is stored in the x and the y fields. Like SDL_KeyboardEvent, information on whether the event was a press or a release event is stored in both the type and state fields, but this should be obvious.

SDL_MouseMotionEvent

Name

SDL_MouseMotionEvent -- Mouse motion event structure

Structure Definition

typedef struct{
-  Uint8 type;
-  Uint8 state;
-  Uint16 x, y;
-  Sint16 xrel, yrel;
-} SDL_MouseMotionEvent;

Structure Data

`type`	`SDL_MOUSEMOTION`
`state`	The current button state
`x`, `y`	The X/Y coordinates of the mouse
`xrel`, `yrel`	Relative motion in the X/Y direction

Description

SDL_MouseMotionEvent is a member of the SDL_Event union and is used when an event of type SDL_MOUSEMOTION is reported.

Simply put, a SDL_MOUSEMOTION type event occurs when a user moves the mouse within the application window or when SDL_WarpMouse is called. Both the absolute (x and y) and relative (xrel and yrel) coordinates are reported along with the current button states (state). The button state can be interpreted using the SDL_BUTTON macro (see SDL_GetMouseState).

If the cursor is hidden (SDL_ShowCursor(0)) and the input is grabbed (SDL_WM_GrabInput(SDL_GRAB_ON)), then the mouse will give relative motion events even when the cursor reaches the edge fo the screen. This is currently only implemented on Windows and Linux/Unix-a-likes.

SDL_mutexP

Name

SDL_mutexP -- Lock a mutex

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

int SDL_mutexP(SDL_mutex *mutex);

Description

Locks the mutex, which was previously created with SDL_CreateMutex. If the mutex is already locked then SDL_mutexP will not return until it is unlocked. Returns 0 on success, or -1 on an error.

SDL also defines a macro #define SDL_LockMutex(m) SDL_mutexP(m).

SDL_mutexV

Name

SDL_mutexV -- Unlock a mutex

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

int SDL_mutexV(SDL_mutex *mutex);

Description

Unlocks the mutex, which was previously created with SDL_CreateMutex. Returns 0 on success, or -1 on an error.

SDL also defines a macro #define SDL_UnlockMutex(m) SDL_mutexV(m).

SDL_NumJoysticks

Name

SDL_NumJoysticks -- Count available joysticks.

Synopsis

#include "SDL.h"

int SDL_NumJoysticks(void);

Description

Counts the number of joysticks attached to the system.

Return Value

Returns the number of attached joysticks

SDL_OpenAudio

Name

SDL_OpenAudio -- Opens the audio device with the desired parameters.

Synopsis

#include "SDL.h"

int SDL_OpenAudio(SDL_AudioSpec *desired, SDL_AudioSpec *obtained);

Description

This function opens the audio device with the desired parameters, and -returns 0 if successful, placing the actual hardware parameters in the -structure pointed to by obtained. If obtained is NULL, the audio -data passed to the callback function will be guaranteed to be in the -requested format, and will be automatically converted to the hardware -audio format if necessary. This function returns -1 if it failed -to open the audio device, or couldn't set up the audio thread.

To open the audio device a desired SDL_AudioSpec must be created. -

SDL_AudioSpec *desired;
-.
-.
-desired = malloc(sizeof(SDL_AudioSpec));

-You must then fill this structure with your desired audio specifications.

desired->freq

The desired audio frequency in samples-per-second.

desired->format

The desired audio format (see SDL_AudioSpec)

desired->samples

The desired size of the audio buffer in samples. This number should be a power of two, and may be adjusted by the audio driver to a value more suitable for the hardware. Good values seem to range between 512 and 8192 inclusive, depending on the application and CPU speed. Smaller values yield faster response time, but can lead to underflow if the application is doing heavy processing and cannot fill the audio buffer in time. A stereo sample consists of both right and left channels in LR ordering. Note that the number of samples is directly related to time by the following formula: ms = (samples*1000)/freq

desired->callback

This should be set to a function that will be called when the audio device is ready for more data. It is passed a pointer to the audio buffer, and the length in bytes of the audio buffer. This function usually runs in a separate thread, and so you should protect data structures that it accesses by calling SDL_LockAudio and SDL_UnlockAudio in your code. The callback prototype is: -

void callback(void *userdata, Uint8 *stream, int len);

-userdata is the pointer stored in userdata field of the SDL_AudioSpec. stream is a pointer to the audio buffer you want to fill with information and len is the length of the audio buffer in bytes.

desired->userdata

This pointer is passed as the first parameter to the callback function.

SDL_OpenAudio reads these fields from the desired SDL_AudioSpec structure pass to the function and attempts to find an audio configuration matching your desired. As mentioned above, if the obtained parameter is NULL then SDL with convert from your desired audio settings to the hardware settings as it plays.

If obtained is NULL then the desired SDL_AudioSpec is your working specification, otherwise the obtained SDL_AudioSpec becomes the working specification and the desirec specification can be deleted. The data in the working specification is used when building SDL_AudioCVT's for converting loaded data to the hardware format.

SDL_OpenAudio calculates the size and silence fields for both the desired and obtained specifications. The size field stores the total size of the audio buffer in bytes, while the silence stores the value used to represent silence in the audio buffer

The audio device starts out playing silence when it's opened, and should be enabled for playing by calling SDL_PauseAudio(0) when you are ready for your audio callback function to be called. Since the audio driver may modify the requested size of the audio buffer, you should allocate any local mixing buffers after you open the audio device.

Examples

/* Prototype of our callback function */
-void my_audio_callback(void *userdata, Uint8 *stream, int len);
-
-/* Open the audio device */
-SDL_AudioSpec *desired, *obtained;
-SDL_AudioSpec *hardware_spec;
-
-/* Allocate a desired SDL_AudioSpec */
-desired = malloc(sizeof(SDL_AudioSpec));
-
-/* Allocate space for the obtained SDL_AudioSpec */
-obtained = malloc(sizeof(SDL_AudioSpec));
-
-/* 22050Hz - FM Radio quality */
-desired->freq=22050;
-
-/* 16-bit signed audio */
-desired->format=AUDIO_S16LSB;
-
-/* Mono */
-desired->channels=0;
-
-/* Large audio buffer reduces risk of dropouts but increases response time */
-desired->samples=8192;
-
-/* Our callback function */
-desired->callback=my_audio_callback;
-
-desired->userdata=NULL;
-
-/* Open the audio device */
-if ( SDL_OpenAudio(desired, obtained) < 0 ){
-  fprintf(stderr, "Couldn't open audio: %s\n", SDL_GetError());
-  exit(-1);
-}
-/* desired spec is no longer needed */
-free(desired);
-hardware_spec=obtained;
-.
-.
-/* Prepare callback for playing */
-.
-.
-.
-/* Start playing */
-SDL_PauseAudio(0);

SDL_Overlay

Name

SDL_Overlay -- YUV video overlay

Structure Definition

typedef struct{
-  Uint32 format;
-  int w, h;
-  int planes;
-  Uint16 *pitches;
-  Uint8 **pixels;
-  Uint32 hw_overlay:1;
-} SDL_Overlay;

Structure Data

`format`	Overlay format (see below)
`w, h`	Width and height of overlay
`planes`	Number of planes in the overlay. Usually either 1 or 3
`pitches`	An array of pitches, one for each plane. Pitch is the length of a row in bytes.
`pixels`	An array of pointers to teh data of each plane. The overlay should be locked before these pointers are used.
`hw_overlay`	This will be set to 1 if the overlay is hardware accelerated.

Description

A SDL_Overlay is similar to a SDL_Surface except it stores a YUV overlay. All the fields are read only, except for pixels which should be locked before use. The format field stores the format of the overlay which is one of the following: -

#define SDL_YV12_OVERLAY  0x32315659  /* Planar mode: Y + V + U */
-#define SDL_IYUV_OVERLAY  0x56555949  /* Planar mode: Y + U + V */
-#define SDL_YUY2_OVERLAY  0x32595559  /* Packed mode: Y0+U0+Y1+V0 */
-#define SDL_UYVY_OVERLAY  0x59565955  /* Packed mode: U0+Y0+V0+Y1 */
-#define SDL_YVYU_OVERLAY  0x55595659  /* Packed mode: Y0+V0+Y1+U0 */

-More information on YUV formats can be found at http://www.webartz.com/fourcc/indexyuv.htm.

SDL_Palette

Name

SDL_Palette -- Color palette for 8-bit pixel formats

Structure Definition

typedef struct{
-  int ncolors;
-  SDL_Color *colors;
-} SDL_Palette;

Structure Data

`ncolors`	Number of colors used in this palette
`colors`	Pointer to SDL_Color structures that make up the palette.

Description

Each pixel in an 8-bit surface is an index into the colors field of the SDL_Palette structure store in SDL_PixelFormat. A SDL_Palette should never need to be created manually. It is automatically created when SDL allocates a SDL_PixelFormat for a surface. The colors values of a SDL_Surfaces palette can be set with the SDL_SetColors.

SDL_PauseAudio

Name

SDL_PauseAudio -- Pauses and unpauses the audio callback processing

Synopsis

#include "SDL.h"

void SDL_PauseAudio(int pause_on);

Description

This function pauses and unpauses the audio callback processing. -It should be called with pause_on=0 after opening the audio -device to start playing sound. This is so you can safely initialize -data for your callback function after opening the audio device. -Silence will be written to the audio device during the pause.

SDL_PeepEvents

Name

SDL_PeepEvents -- Checks the event queue for messages and optionally returns them.

Synopsis

#include "SDL.h"

int SDL_PeepEvents(SDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask);

Description

Checks the event queue for messages and optionally returns them.

If action is SDL_ADDEVENT, up to -numevents events will be added to the back of the event - queue.

If action is SDL_PEEKEVENT, up to -numevents events at the front of the event queue, -matching mask, -will be returned and will not be removed from the queue.

If action is SDL_GETEVENT, up to -numevents events at the front of the event queue, -matching mask, -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

This function returns the number of events actually stored, or --1 if there was an error.

SDL_PixelFormat

Name

SDL_PixelFormat -- Stores surface format information

Structure Definition

typedef struct SDL_PixelFormat {
-  SDL_Palette *palette;
-  Uint8  BitsPerPixel;
-  Uint8  BytesPerPixel;
-  Uint8  Rloss, Gloss, Bloss, Aloss;
-  Uint8  Rshift, Gshift, Bshift, Ashift;
-  Uint32 Rmask, Gmask, Bmask, Amask;
-  Uint32 colorkey;
-  Uint8  alpha;
-} SDL_PixelFormat;

Structure Data

`palette`	Pointer to the palette, or `NULL` if the `BitsPerPixel`>8
`BitsPerPixel`	The number of bits used to represent each pixel in a surface. Usually 8, 16, 24 or 32.
`BytesPerPixel`	The number of bytes used to represent each pixel in a surface. Usually one to four.
`[RGBA]mask`	Binary mask used to retrieve individual color values
`[RGBA]loss`	Precision loss of each color component (2^[RGBA]loss)
`[RGBA]shift`	Binary left shift of each color component in the pixel value
`colorkey`	Pixel value of transparent pixels
`alpha`	Overall surface alpha value

Description

A SDL_PixelFormat describes the format of the pixel data stored at the pixels field of a SDL_Surface. Every surface stores a SDL_PixelFormat in the format field.

If you wish to do pixel level modifications on a surface, then understanding how SDL stores its color information is essential.

8-bit pixel formats are the easiest to understand. Since its an 8-bit format, we have 8 BitsPerPixel and 1 BytesPerPixel. Since BytesPerPixel is 1, all pixels are represented by a Uint8 which contains an index into palette->colors. So, to determine the color of a pixel in a 8-bit surface: we read the color index from surface->pixels and we use that index to read the SDL_Color structure from surface->format->palette->colors. Like so: -

SDL_Surface *surface;
-SDL_PixelFormat *fmt;
-SDL_Color *color;
-Uint8 index;
-
-.
-.
-
-/* Create surface */
-.
-.
-fmt=surface->format;
-
-/* Check the bitdepth of the surface */
-if(fmt->BitsPerPixel!=8){
-  fprintf(stderr, "Not an 8-bit surface.\n");
-  return(-1);
-}
-
-/* Lock the surface */
-SDL_LockSurface(surface);
-
-/* Get the topleft pixel */
-index=*(Uint8 *)surface->pixels;
-color=fmt->palette->colors[index];
-
-/* Unlock the surface */
-SDL_UnlockSurface(surface);
-printf("Pixel Color-> Red: %d, Green: %d, Blue: %d. Index: %d\n",
-          color->r, color->g, color->b, index);
-.
-.

Pixel formats above 8-bit are an entirely different experience. They are -considered to be "TrueColor" formats and the color information is stored in the -pixels themselves, not in a palette. The mask, shift and loss fields tell us -how the color information is encoded. The mask fields allow us to isolate each -color component, the shift fields tell us the number of bits to the right of -each component in the pixel value and the loss fields tell us the number of -bits lost from each component when packing 8-bit color component in a pixel. -

/* Extracting color components from a 32-bit color value */
-SDL_PixelFormat *fmt;
-SDL_Surface *surface;
-Uint32 temp, pixel;
-Uint8 red, green, blue, alpha;
-.
-.
-.
-fmt=surface->format;
-SDL_LockSurface(surface);
-pixel=*((Uint32*)surface->pixels);
-SDL_UnlockSurface(surface);
-
-/* Get Red component */
-temp=pixel&fmt->Rmask; /* Isolate red component */
-temp=temp>>fmt->Rshift;/* Shift it down to 8-bit */
-temp=temp<<fmt->Rloss; /* Expand to a full 8-bit number */
-red=(Uint8)temp;
-
-/* Get Green component */
-temp=pixel&fmt->Gmask; /* Isolate green component */
-temp=temp>>fmt->Gshift;/* Shift it down to 8-bit */
-temp=temp<<fmt->Gloss; /* Expand to a full 8-bit number */
-green=(Uint8)temp;
-
-/* Get Blue component */
-temp=pixel&fmt->Bmask; /* Isolate blue component */
-temp=temp>>fmt->Bshift;/* Shift it down to 8-bit */
-temp=temp<<fmt->Bloss; /* Expand to a full 8-bit number */
-blue=(Uint8)temp;
-
-/* Get Alpha component */
-temp=pixel&fmt->Amask; /* Isolate alpha component */
-temp=temp>>fmt->Ashift;/* Shift it down to 8-bit */
-temp=temp<<fmt->Aloss; /* Expand to a full 8-bit number */
-alpha=(Uint8)temp;
-
-printf("Pixel Color -> R: %d,  G: %d,  B: %d,  A: %d\n", red, green, blue, alpha);
-.
-.
-.

SDL_PollEvent

Name

SDL_PollEvent -- Polls for currently pending events.

Synopsis

#include "SDL.h"

int SDL_PollEvent(SDL_Event *event);

Description

Polls for currently pending events, and returns 1 -if there are any pending events, or 0 if there -are none available.

If event is not NULL, the next -event is removed from the queue and stored in that area.

Examples

SDL_Event event; /* Event structure */
-
-.
-.
-.
-/* Check for events */
-while(SDL_PollEvent(&event)){  /* Loop until there are no events left on the queue */
-  switch(event.type){  /* Process the appropiate event type */
-    case SDL_KEYDOWN:  /* Handle a KEYDOWN event */         
-      printf("Oh! Key press\n");
-      break;
-    case SDL_MOUSEMOTION:
-      .
-      .
-      .
-    default: /* Report an unhandled event */
-      printf("I don't know what this event is!\n");
-  }
-}

SDL_PumpEvents

Name

SDL_PumpEvents -- Pumps the event loop, gathering events from the input devices.

Synopsis

#include "SDL.h"

void SDL_PumpEvents(void);

Description

Pumps the event loop, gathering events from the input devices.

SDL_PumpEvents gathers all the pending input information from devices and places it on the event queue. Without calls to SDL_PumpEvents no events would ever be placed on the queue. Often calls the need for SDL_PumpEvents is hidden from the user since SDL_PollEvent and SDL_WaitEvent implicitly call SDL_PumpEvents. 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.

Note: You can only call this function in the thread that set the video mode.

SDL_PushEvent

Name

SDL_PushEvent -- Pushes an event onto the event queue

Synopsis

#include "SDL.h"

int SDL_PushEvent(SDL_Event *event);

Description

The event queue can actually be used as a two way communication channel. Not only can events be read from the queue, but the user can also push their own events onto it. event is a pointer to the event structure you wish to push onto the queue.

Note: Pushing device input events onto the queue doesn't modify the state of the device within SDL.

Return Value

Returns 0 on success or -1 if the event couldn't be pushed.

Examples

See SDL_Event.

SDL_Quit

Name

SDL_Quit -- Shut down SDL

Synopsis

#include "SDL.h"

void SDL_Quit(void);

Description

SDL_Quit shuts down all SDL subsystems and frees the resources allocated to them. This should always be called before you exit. For the sake of simplicity you can set SDL_Quit as your atexit call, like: -

SDL_Init(SDL_INIT_VIDEO|SDL_INIT_AUDIO);
-atexit(SDL_Quit);
-.
-.

Note: While using atexit maybe be fine for small programs, more advanced users should shut down SDL in their own cleanup code. Plus, using atexit in a library is a sure way to crash dynamically loaded code

SDL_QuitEvent

Name

SDL_QuitEvent -- Quit requested event

Structure Definition

typedef struct{
-  Uint8 type
-} SDL_QuitEvent;

Structure Data

type SDL_QUIT

Description

SDL_QuitEvent is a member of the SDL_Event union and is used whan an event of type SDL_QUIT is reported.

As can be seen, the SDL_QuitEvent structure serves no useful purpose. The event itself, on the other hand, is very important. If you filter out or ignore a quit event then it is impossible for the user to close the window. On the other hand, if you do accept a quit event then the application window will be closed, and screen updates will still report success event though the application will no longer be visible.

Note: The macro SDL_QuitRequested will return non-zero if a quit event is pending

SDL_QuitSubSystem

Name

SDL_QuitSubSystem -- Shut down a subsystem

Synopsis

#include "SDL.h"

void SDL_QuitSubSystem(Uint32 flags);

Description

SDL_QuitSubSystem allows you to shut down a subsystem that has been previously initialized by SDL_Init or SDL_InitSubSystem. The flags tells SDL_QuitSubSystem which subsystems to shut down, it uses the same values that are passed to SDL_Init.

SDL_Rect

Name

SDL_Rect -- Defines a rectangular area

Structure Definition

typedef struct{
-  Sint16 x, y;
-  Uint16 w, h;
-} SDL_Rect;

Structure Data

`x, y`	Position of the upper-left corner of the rectangle
`w, h`	The width and height of the rectangle

Description

A SDL_Rect defines a rectangular area of pixels. It is used by SDL_BlitSurface to define blitting regions and by several other video functions.

SDL_RemoveTimer

Name

SDL_RemoveTimer -- Remove a timer which was added with -SDL_AddTimer.

Synopsis

#include "SDL.h"

SDL_bool SDL_RemoveTimer(SDL_TimerID id);

Description

Removes a timer callback previously added with -SDL_AddTimer.

Return Value

Returns a boolean value indicating success.

Examples

SDL_RemoveTimer(my_timer_id);

SDL_ResizeEvent

Name

SDL_ResizeEvent -- Window resize event structure

Structure Definition

typedef struct{
-  Uint8 type;
-  int w, h;
-} SDL_ResizeEvent;

Structure Data

`type`	`SDL_VIDEORESIZE`
`w`, `h`	New width and height of the window

Description

SDL_ResizeEvent is a member of the SDL_Event union and is used when an event of type SDL_VIDEORESIZE is reported.

When SDL_RESIZABLE is passed as a flag to SDL_SetVideoMode the user is allowed to resize the applications window. When the window is resized an SDL_VIDEORESIZE is report, with the new window width and height values stored in w and h, respectively. When an SDL_VIDEORESIZE is recieved the window should be resized to the new dimensions using SDL_SetVideoMode.

SDL_SaveBMP

Name

SDL_SaveBMP -- Save an SDL_Surface as a Windows BMP file.

Synopsis

#include "SDL.h"

int SDL_SaveBMP(SDL_Surface *surface, const char *file);

Description

Saves the SDL_Surface surface as a Windows BMP file named file.

Return Value

Returns 0 if successful or --1 -if there was an error.

SDL_SemPost

Name

SDL_SemPost -- Unlock a semaphore.

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

int SDL_SemPost(SDL_sem *sem);

Description

SDL_SemPost unlocks the semaphore pointed to by -sem and atomically increments the semaphores value. -Threads that were blocking on the semaphore may be scheduled after this call -succeeds.

SDL_SemPost should be called after a semaphore is locked by a successful call to -SDL_SemWait, -SDL_SemTryWait or -SDL_SemWaitTimeout.

Return Value

Returns 0 if successful or --1 if there was an error (leaving the semaphore unchanged).

Examples

SDL_SemPost(my_sem);

SDL_SemTryWait

Name

SDL_SemTryWait -- Attempt to lock a semaphore but don't suspend the thread.

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

int SDL_SemTryWait(SDL_sem *sem);

Description

SDL_SemTryWait is a non-blocking varient of -SDL_SemWait. If the value of the semaphore -pointed to by sem is positive it will atomically -decrement the semaphore value and return 0, otherwise it will return -SDL_MUTEX_TIMEDOUT instead of suspending the thread.

After SDL_SemTryWait is successful, the semaphore -can be released and its count atomically incremented by a successful call to -SDL_SemPost.

Return Value

Returns 0 if the semaphore was successfully locked or -either SDL_MUTEX_TIMEDOUT or -1 -if the thread would have suspended or there was an error, respectivly.

If the semaphore was not successfully locked, the semaphore will be unchanged.

Examples

res = SDL_SemTryWait(my_sem);
-
-if (res == SDL_MUTEX_TIMEDOUT) {
-        return TRY_AGAIN;
-}
-if (res == -1) {
-        return WAIT_ERROR;
-}
-
-...
-
-SDL_SemPost(my_sem);

SDL_SemValue

Name

SDL_SemValue -- Return the current value of a semaphore.

Synopsis

#include "SDL.h"
-#include "SDL/SDL_thread.h"

Uint32 SDL_SemValue(SDL_sem *sem);

Description

SDL_SemValue() returns the current semaphore value from -the semaphore pointed to by sem.

Return Value

Returns current value of the semaphore.

Examples

  sem_value = SDL_SemValue(my_sem);

SDL_SemWait

Name

SDL_SemWait -- Lock a semaphore and suspend the thread if the semaphore value is zero.

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

int SDL_SemWait(SDL_sem *sem);

Description

SDL_SemWait() suspends the calling thread until either -the semaphore pointed to by sem has a positive value, -the call is interrupted by a signal or error. If the call is successful it -will atomically decrement the semaphore value.

After SDL_SemWait() is successful, the semaphore -can be released and its count atomically incremented by a successful call to -SDL_SemPost.

Return Value

Returns 0 if successful or --1 if there was an error (leaving the semaphore unchanged).

Examples

if (SDL_SemWait(my_sem) == -1) {
-        return WAIT_FAILED;
-}
-
-...
-
-SDL_SemPost(my_sem);

SDL_SemWaitTimeout

Name

SDL_SemWaitTimeout -- Lock a semaphore, but only wait up to a specified maximum time.

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

int SDL_SemWaitTimeout(SDL_sem *sem, Uint32 timeout);

Description

SDL_SemWaitTimeout() is a varient of -SDL_SemWait -with a maximum timeout value. -If the value of the semaphore pointed to by sem is -positive (greater than zero) it will atomically decrement the semaphore value -and return 0, otherwise it will wait up to timeout -milliseconds trying to lock the semaphore. This function is to be avoided if -possible since on some platforms it is implemented by polling the semaphore -every millisecond in a busy loop.

After SDL_SemWaitTimeout() is successful, the semaphore -can be released and its count atomically incremented by a successful call to -SDL_SemPost.

Return Value

Returns 0 if the semaphore was successfully locked or -either SDL_MUTEX_TIMEDOUT or -1 -if the timeout period was exceeded or there was an error, respectivly.

If the semaphore was not successfully locked, the semaphore will be unchanged.

Examples

res = SDL_SemWaitTimeout(my_sem, WAIT_TIMEOUT_MILLISEC);
-
-if (res == SDL_MUTEX_TIMEDOUT) {
-        return TRY_AGAIN;
-}
-if (res == -1) {
-        return WAIT_ERROR;
-}
-
-...
-
-SDL_SemPost(my_sem);

SDL_SetAlpha

Name

SDL_SetAlpha -- Adjust the alpha properties of a surface

Synopsis

#include "SDL.h"

int SDL_SetAlpha(SDL_Surface *surface, Uint32 flag, Uint8 alpha);

Description

Note: This function and the semantics of SDL alpha blending have changed since version 1.1.4. Up until version 1.1.5, an alpha value of 0 was considered opaque and a value of 255 was considered transparent. This has now been inverted: 0 (SDL_ALPHA_TRANSPARENT) is now considered transparent and 255 (SDL_ALPHA_OPAQUE) is now considered opaque.

SDL_SetAlpha is used for setting the per-surface alpha -value and/or enabling and disabling alpha blending.

Thesurface parameter specifies which surface whose alpha -attributes you wish to adjust. flags is used to specify -whether alpha blending should be used (SDL_SRCALPHA) and -whether the surface should use RLE acceleration for blitting -(SDL_RLEACCEL). flags can be an OR'd -combination of these two options, one of these options or 0. If -SDL_SRCALPHA is not passed as a flag then all alpha -information is ignored when blitting the surface. The -alpha parameter is the per-surface alpha value; a -surface need not have an alpha channel to use per-surface alpha and blitting -can still be accelerated with SDL_RLEACCEL.

Note: The per-surface alpha value of 128 is considered a special case and -is optimised, so it's much faster than other per-surface values.

Alpha effects surface blitting in the following ways:

RGBA->RGB with `SDL_SRCALPHA`	The source is alpha-blended with the destination, using the alpha channel. `SDL_SRCCOLORKEY` and the per-surface alpha are ignored.
RGBA->RGB without `SDL_SRCALPHA`	The RGB data is copied from the source. The source alpha channel and the per-surface alpha value are ignored.
RGB->RGBA with `SDL_SRCALPHA`	The source is alpha-blended with the destination using the per-surface alpha -value. If `SDL_SRCCOLORKEY` is set, only the pixels not -matching the colorkey value are copied. The alpha channel of the copied pixels -is set to opaque.
RGB->RGBA without `SDL_SRCALPHA`	The RGB data is copied from the source and the alpha value of the copied pixels -is set to opaque. If `SDL_SRCCOLORKEY` is set, only the pixels -not matching the colorkey value are copied.
RGBA->RGBA with `SDL_SRCALPHA`	The source is alpha-blended with the destination using the source alpha -channel. The alpha channel in the destination surface is left untouched. -`SDL_SRCCOLORKEY` is ignored.
RGBA->RGBA without `SDL_SRCALPHA`	The RGBA data is copied to the destination surface. If `SDL_SRCCOLORKEY` is set, only the pixels not matching the colorkey value are copied.
RGB->RGB with `SDL_SRCALPHA`	The source is alpha-blended with the destination using the per-surface alpha value. If `SDL_SRCCOLORKEY` is set, only the pixels not matching the colorkey value are copied.
RGB->RGB without `SDL_SRCALPHA`	The RGB data is copied from the source. If `SDL_SRCCOLORKEY` is set, only the pixels not matching the colorkey value are copied.

Note: Note that RGBA->RGBA blits (with SDL_SRCALPHA set) keep the alpha -of the destination surface. This means that you cannot compose two arbitrary -RGBA surfaces this way and get the result you would expect from "overlaying" -them; the destination alpha will work as a mask.
Also note that per-pixel and per-surface alpha cannot be combined; -the per-pixel alpha is always used if available

Return Value

This function returns 0, or --1 if there was an error.

SDL_SetClipRect

Name

SDL_SetClipRect -- Sets the clipping rectangle for a surface.

Synopsis

#include "SDL.h"

void SDL_SetClipRect(SDL_Surface *surface, SDL_Rect *rect);

Description

Sets the clipping rectangle for a surface. When this surface is the -destination of a blit, only the area within the clip rectangle will be -drawn into.

The rectangle pointed to by rect will be -clipped to the edges of the surface so that the clip rectangle for a -surface can never fall outside the edges of the surface.

If rect is NULL the clipping -rectangle will be set to the full size of the surface.

SDL_SetColorKey

Name

SDL_SetColorKey -- Sets the color key (transparent pixel) in a blittable surface and -RLE acceleration.

Synopsis

#include "SDL.h"

int SDL_SetColorKey(SDL_Surface *surface, Uint32 flag, Uint32 key);

Description

Sets the color key (transparent pixel) in a blittable surface and enables or - disables RLE blit acceleration.

RLE acceleration can substantially speed up blitting of images with large -horizontal runs of transparent pixels (i.e., pixels that match the -key value). The key must be of the same pixel format as the surface, SDL_MapRGB is often useful for obtaining an acceptable value.

If flag is SDL_SRCCOLORKEY then -key is the transparent pixel value in the source image of a -blit.

If flag is OR'd with -SDL_RLEACCEL then the surface will be draw using RLE -acceleration when drawn with -SDL_BlitSurface. The surface will -actually be encoded for RLE acceleration the first time -SDL_BlitSurface or -SDL_DisplayFormat is called on the -surface.

If flag is 0, this function clears -any current color key.

Return Value

This function returns 0, or --1 if there was an error.

SDL_SetColors

Name

SDL_SetColors -- Sets a portion of the colormap for the given 8-bit surface.

Synopsis

#include "SDL.h"

int SDL_SetColors(SDL_Surface *surface, SDL_Color *colors, int firstcolor, int ncolors);

Description

Sets a portion of the colormap for the given 8-bit surface.

When surface is the surface associated with the current -display, the display colormap will be updated with the requested colors. If -SDL_HWPALETTE was set in SDL_SetVideoMode flags, -SDL_SetColors will always return 1, -and the palette is guaranteed to be set the way you desire, even if the window -colormap has to be warped or run under emulation.

The color components of a -SDL_Color -structure are 8-bits in size, giving you a total of 256³ -=16777216 colors.

Palettized (8-bit) screen surfaces with the SDL_HWPALETTE -flag have two palettes, a logical palette that is used for mapping blits -to/from the surface and a physical palette (that determines how the -hardware will map the colors to the display). SDL_SetColors -modifies both palettes (if present), and is equivalent to calling -SDL_SetPalette with the -flags set to -(SDL_LOGPAL | SDL_PHYSPAL).

Return Value

If surface is not a palettized surface, this function -does nothing, returning 0. If all of the colors were set -as passed to SDL_SetColors, it will return -1. If not all the color entries were set exactly as -given, it will return 0, and you should look at the -surface palette to determine the actual color palette.

Example

/* Create a display surface with a grayscale palette */
-SDL_Surface *screen;
-SDL_Color colors[256];
-int i;
-.
-.
-.
-/* Fill colors with color information */
-for(i=0;i<256;i++){
-  colors[i].r=i;
-  colors[i].g=i;
-  colors[i].b=i;
-}
-
-/* Create display */
-screen=SDL_SetVideoMode(640, 480, 8, SDL_HWPALETTE);
-if(!screen){
-  printf("Couldn't set video mode: %s\n", SDL_GetError());
-  exit(-1);
-}
-
-/* Set palette */
-SDL_SetColors(screen, colors, 0, 256);
-.
-.
-.
-.

SDL_SetCursor

Name

SDL_SetCursor -- Set the currently active mouse cursor.

Synopsis

#include "SDL.h"

void SDL_SetCursor(SDL_Cursor *cursor);

Description

Sets the currently active cursor to -the specified one. -If the cursor is currently visible, the change will be immediately -represented on the display.

SDL_SetEventFilter

Name

SDL_SetEventFilter -- Sets up a filter to process all events before they are posted -to the event queue.

Synopsis

#include "SDL.h"

void SDL_SetEventFilter(SDL_EventFilter filter);

Description

This function sets up a filter to process all events before they are posted -to the event queue. This is a very powerful and flexible feature. The filter -is prototyped as: -

typedef int (*SDL_EventFilter)(const SDL_Event *event);

-If the filter returns 1, then the event will be -added to the internal queue. If it returns 0, -then the event will be dropped from the queue. This allows selective -filtering of dynamically.

There is one caveat when dealing with the SDL_QUITEVENT event type. The -event filter is only called when the window manager desires to close the -application window. If the event filter returns 1, then the window will -be closed, otherwise the window will remain open if possible. -If the quit event is generated by an interrupt signal, it will bypass the -internal queue and be delivered to the application at the next event poll.

Note: Events pushed onto the queue with SDL_PushEvent or SDL_PeepEvents do not get passed through the event filter.

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

SDL_SetGamma

Name

SDL_SetGamma -- Sets the color gamma function for the display

Synopsis

#include "SDL.h"

int SDL_SetGamma(float redgamma, float greengamma, float bluegamma);

Description

Sets the "gamma function" for the display of each color component. Gamma -controls the brightness/contrast of colors displayed on the screen. -A gamma value of 1.0 is identity (i.e., no adjustment -is made).

This function adjusts the gamma based on the "gamma function" parameter, -you can directly specify lookup tables for gamma adjustment with -SDL_SetGammaRamp.

Not all display hardware is able to change gamma.

Return Value

Returns -1 on error (or if gamma adjustment is not supported).

SDL_SetGammaRamp

Name

SDL_SetGammaRamp -- Sets the color gamma lookup tables for the display

Synopsis

#include "SDL.h"

int SDL_SetGammaRamp(Uint16 *redtable, Uint16 *greentable, Uint16 *bluetable);

Description

Sets the gamma lookup tables for the display for each color component. -Each table is an array of 256 Uint16 values, representing a mapping -between the input and output for that channel. The input is the index -into the array, and the output is the 16-bit gamma value at that index, -scaled to the output color precision. You may pass NULL to any of the -channels to leave them unchanged.

This function adjusts the gamma based on lookup tables, you can also -have the gamma calculated based on a "gamma function" parameter with -SDL_SetGamma.

Not all display hardware is able to change gamma.

Return Value

Returns -1 on error (or if gamma adjustment is not supported).

SDL_SetModState

Name

SDL_SetModState -- Set the current key modifier state

Synopsis

#include "SDL.h"

void SDL_SetModState(SDLMod modstate);

Description

The inverse of SDL_GetModState, SDL_SetModState allows you to impose modifier key states on your application.

Simply pass your desired modifier states into modstate. This value my be a logical OR'd combination of the following:

typedef enum {
-  KMOD_NONE  = 0x0000,
-  KMOD_LSHIFT= 0x0001,
-  KMOD_RSHIFT= 0x0002,
-  KMOD_LCTRL = 0x0040,
-  KMOD_RCTRL = 0x0080,
-  KMOD_LALT  = 0x0100,
-  KMOD_RALT  = 0x0200,
-  KMOD_LMETA = 0x0400,
-  KMOD_RMETA = 0x0800,
-  KMOD_NUM   = 0x1000,
-  KMOD_CAPS  = 0x2000,
-  KMOD_MODE  = 0x4000,
-} SDLMod;

SDL_SetPalette

Name

SDL_SetPalette -- Sets the colors in the palette of an 8-bit surface.

Synopsis

#include "SDL.h"

int SDL_SetPalette(SDL_Surface *surface, int flags, SDL_Color *colors, int firstcolor, int ncolors);

Description

Sets a portion of the palette for the given 8-bit surface.

Palettized (8-bit) screen surfaces with the -SDL_HWPALETTE flag have two palettes, a logical -palette that is used for mapping blits to/from the surface and a -physical palette (that determines how the hardware will map the colors -to the display). SDL_BlitSurface -always uses the logical palette when blitting surfaces (if it has to -convert between surface pixel formats). Because of this, it is often -useful to modify only one or the other palette to achieve various -special color effects (e.g., screen fading, color flashes, screen dimming).

This function can modify either the logical or physical palette by -specifing SDL_LOGPAL or -SDL_PHYSPALthe in the flags -parameter.

When surface is the surface associated with the current -display, the display colormap will be updated with the requested colors. If -SDL_HWPALETTE was set in SDL_SetVideoMode flags, -SDL_SetPalette will always return 1, -and the palette is guaranteed to be set the way you desire, even if the window -colormap has to be warped or run under emulation.

The color components of a -SDL_Color structure -are 8-bits in size, giving you a total of -256³=16777216 colors.

Return Value

If surface is not a palettized surface, this function -does nothing, returning 0. If all of the colors were set -as passed to SDL_SetPalette, it will return -1. If not all the color entries were set exactly as -given, it will return 0, and you should look at the -surface palette to determine the actual color palette.

Example

        /* Create a display surface with a grayscale palette */
-        SDL_Surface *screen;
-        SDL_Color colors[256];
-        int i;
-        .
-        .
-        .
-        /* Fill colors with color information */
-        for(i=0;i<256;i++){
-          colors[i].r=i;
-          colors[i].g=i;
-          colors[i].b=i;
-        }
-
-        /* Create display */
-        screen=SDL_SetVideoMode(640, 480, 8, SDL_HWPALETTE);
-        if(!screen){
-          printf("Couldn't set video mode: %s\n", SDL_GetError());
-          exit(-1);
-        }
-
-        /* Set palette */
-        SDL_SetPalette(screen, SDL_LOGPAL|SDL_PHYSPAL, colors, 0, 256);
-        .
-        .
-        .
-        .

SDL_SetTimer

Name

SDL_SetTimer -- Set a callback to run after the specified number of milliseconds has -elapsed.

Synopsis

#include "SDL.h"

int SDL_SetTimer(Uint32 interval, SDL_TimerCallback callback);

Callback

/* Function prototype for the timer callback function */ -typedef Uint32 (*SDL_TimerCallback)(Uint32 interval);

Description

Set a callback to run after the specified number of milliseconds has -elapsed. The callback function is passed the current timer interval -and returns the next timer interval. If the returned value is the -same as the one passed in, the periodic alarm continues, otherwise a -new alarm is scheduled.

To cancel a currently running timer, call -SDL_SetTimer(0, NULL);

The timer callback function may run in a different thread than your -main constant, and so shouldn't call any functions from within itself.

The maximum resolution of this timer is 10 ms, which means that if -you request a 16 ms timer, your callback will run approximately 20 ms -later on an unloaded system. If you wanted to set a flag signaling -a frame update at 30 frames per second (every 33 ms), you might set a -timer for 30 ms (see example below).

If you use this function, you need to pass SDL_INIT_TIMER -to SDL_Init().

Note: This function is kept for compatibility but has been superseded -by the new timer functions -SDL_AddTimer and -SDL_RemoveTimer which support -multiple timers.

Examples

SDL_SetTimer((33/10)*10, my_callback);

SDL_SetVideoMode

Name

SDL_SetVideoMode -- Set up a video mode with the specified width, height and bits-per-pixel.

Synopsis

#include "SDL.h"

SDL_Surface *SDL_SetVideoMode(int width, int height, int bpp, Uint32 flags);

Description

Set up a video mode with the specified width, height and bits-per-pixel.

If bpp is 0, it is treated as the -current display bits per pixel.

The flags parameter is the same as the flags field of the SDL_Surface structure. OR'd combinations of the following values are valid.

`SDL_SWSURFACE`	Create the video surface in system memory
`SDL_HWSURFACE`	Create the video surface in video memory
`SDL_ASYNCBLIT`	Enables the use of asynchronous updates of the display surface. This will -usually slow down blitting on single CPU machines, but may provide a speed -increase on SMP systems.
`SDL_ANYFORMAT`	Normally, if a video surface of the requested bits-per-pixel (`bpp`) is not available, SDL will emulate one with a shadow surface. Passing `SDL_ANYFORMAT` prevents this and causes SDL to use the video surface, regardless of its pixel depth.
`SDL_HWPALETTE`	Give SDL exclusive palette access. Without this flag you may not always get the the colors you request with `SDL_SetColors` or `SDL_SetPalette`.
`SDL_DOUBLEBUF`	Enable hardware double buffering; only valid with SDL_HWSURFACE. Calling -`SDL_Flip` will flip the -buffers and update the screen. All drawing will take place on the surface -that is not displayed at the moment. If double buffering could not be enabled -then `SDL_Flip` will just perform a -`SDL_UpdateRect` -on the entire screen.
`SDL_FULLSCREEN`	SDL will attempt to use a fullscreen mode. If a hardware resolution change is -not possible (for whatever reason), the next higher resolution will be used and -the display window centered on a black background.
`SDL_OPENGL`	Create an OpenGL rendering context. You should have previously set OpenGL video attributes with `SDL_GL_SetAttribute`.
`SDL_OPENGLBLIT`	Create an OpenGL rendering context, like above, but allow normal blitting -operations. The screen (2D) surface may have an alpha channel, and -`SDL_UpdateRects` -must be used for updating changes to the screen surface. NOTE: This option -is kept for compatibility only, and is not recommended for -new code.
`SDL_RESIZABLE`	Create a resizable window. When the window is resized by the user a `SDL_VIDEORESIZE` event is generated and `SDL_SetVideoMode` can be called again with the new size.
`SDL_NOFRAME`	If possible, `SDL_NOFRAME` causes SDL to create a window with no title bar or frame decoration. Fullscreen modes automatically have this flag set.

Note: Whatever flags SDL_SetVideoMode could satisfy are set in the flags member of the returned surface.

Note: The bpp parameter is the number of bits per pixel, -so a bpp of 24 uses the packed representation of -3 bytes/pixel. For the more common 4 bytes/pixel mode, use a -bpp of 32. Somewhat oddly, both 15 and 16 will -request a 2 bytes/pixel mode, but different pixel formats.

Return Value

The framebuffer surface, or NULL if it fails. -The surface returned is freed by SDL_Quit() and should nt be freed by -the caller.

SDL_ShowCursor

Name

SDL_ShowCursor -- Toggle whether or not the cursor is shown on the screen.

Synopsis

#include "SDL.h"

int SDL_ShowCursor(int toggle);

Description

Toggle whether or not the cursor is shown on the screen. Passing SDL_ENABLE displays the cursor and passing SDL_DISABLE hides it. The current state of the mouse cursor can be queried by passing SDL_QUERY, either SDL_DISABLE or SDL_ENABLE will be returned.

The cursor starts off displayed, but can be turned off.

Return Value

Returns the current state of the cursor.

SDL_Surface

Name

SDL_Surface -- Graphical Surface Structure

Structure Definition

typedef struct SDL_Surface {
-        Uint32 flags;                           /* Read-only */
-        SDL_PixelFormat *format;                /* Read-only */
-        int w, h;                               /* Read-only */
-        Uint16 pitch;                           /* Read-only */
-        void *pixels;                           /* Read-write */
-
-        /* clipping information */
-        SDL_Rect clip_rect;                     /* Read-only */
-
-        /* Reference count -- used when freeing surface */
-        int refcount;                           /* Read-mostly */
-
-	/* This structure also contains private fields not shown here */
-} SDL_Surface;

Structure Data

`flags`	Surface flags
`format`	Pixel format
`w, h`	Width and height of the surface
`pitch`	Length of a surface scanline in bytes
`pixels`	Pointer to the actual pixel data
`clip_rect`	surface clip rectangle

Description

SDL_Surface's represent areas of "graphical" -memory, memory that can be drawn to. The video framebuffer is returned -as a SDL_Surface by -SDL_SetVideoMode -and SDL_GetVideoSurface. -Most of the fields should be pretty obvious. -w and h are the -width and height of the surface in pixels. -pixels is a pointer to the actual pixel data, -the surface should be locked -before accessing this field. The clip_rect field -is the clipping rectangle as set by -SDL_SetClipRect.

The following are supported in the -flags field.

`SDL_SWSURFACE`	Surface is stored in system memory
`SDL_HWSURFACE`	Surface is stored in video memory
`SDL_ASYNCBLIT`	Surface uses asynchronous blits if possible
`SDL_ANYFORMAT`	Allows any pixel-format (Display surface)
`SDL_HWPALETTE`	Surface has exclusive palette
`SDL_DOUBLEBUF`	Surface is double buffered (Display surface)
`SDL_FULLSCREEN`	Surface is full screen (Display Surface)
`SDL_OPENGL`	Surface has an OpenGL context (Display Surface)
`SDL_OPENGLBLIT`	Surface supports OpenGL blitting (Display Surface)
`SDL_RESIZABLE`	Surface is resizable (Display Surface)
`SDL_HWACCEL`	Surface blit uses hardware acceleration
`SDL_SRCCOLORKEY`	Surface use colorkey blitting
`SDL_RLEACCEL`	Colorkey blitting is accelerated with RLE
`SDL_SRCALPHA`	Surface blit uses alpha blending
`SDL_PREALLOC`	Surface uses preallocated memory

SDL_SysWMEvent

Name

SDL_SysWMEvent -- Platform-dependent window manager event.

Description

The system window manager event contains a pointer to system-specific -information about unknown window manager events. If you enable this event -using -SDL_EventState(), -it will be generated whenever unhandled events are received from the window -manager. This can be used, for example, to implement cut-and-paste in your -application. - -

typedef struct {
-         Uint8 type;   /* Always SDL_SYSWMEVENT */
-         SDL_SysWMmsg *msg;
- } SDL_SysWMEvent;

- -If you want to obtain system-specific information about the window manager, -you can fill the version member of a SDL_SysWMinfo -structure (details can be found in SDL_syswm.h, which must be included) using the SDL_VERSION() macro found in -SDL_version.h, and pass it to the -function: -

int SDL_GetWMInfo(SDL_SysWMinfo *info);

SDL_ThreadID

Name

SDL_ThreadID -- Get the 32-bit thread identifier for the current thread.

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

Uint32 SDL_ThreadID(void);

Description

Get the 32-bit thread identifier for the current thread.

Prev	Home	Next
SDL_CreateThread	Up	SDL_GetThreadID

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/sdlunlockaudio.html --- a/docs/html/sdlunlockaudio.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,211 +0,0 @@ -SDL_UnlockAudio

SDL Library Documentation
Prev		Next

SDL_UnlockAudio

Name

SDL_UnlockAudio -- Unlock the callback function

Synopsis

#include "SDL.h"

void SDL_UnlockAudio(void);

Description

Unlocks a previous SDL_LockAudio call.

SDL_UnlockSurface

Name

SDL_UnlockSurface -- Unlocks a previously locked surface.

Synopsis

#include "SDL.h"

void SDL_UnlockSurface(SDL_Surface *surface);

Description

Surfaces that were previously locked using SDL_LockSurface must be unlocked with SDL_UnlockSurface. Surfaces should be unlocked as soon as possible.

It should be noted that since 1.1.8, surface locks are recursive. See SDL_LockSurface.

SDL_UnlockYUVOverlay

Name

SDL_UnlockYUVOverlay -- Unlock an overlay

Synopsis

#include "SDL.h"

void SDL_UnlockYUVOverlay(SDL_Overlay *overlay);

Description

The opposite to SDL_LockYUVOverlay. Unlocks a previously locked overlay. An overlay must be unlocked before it can be displayed.

SDL_UpdateRect

Name

SDL_UpdateRect -- Makes sure the given area is updated on the given screen.

Synopsis

#include "SDL.h"

void SDL_UpdateRect(SDL_Surface *screen, Sint32 x, Sint32 y, Sint32 w, Sint32 h);

Description

Makes sure the given area is updated on the given screen. The rectangle must -be confined within the screen boundaries (no clipping is done).

If 'x', 'y', 'w' -and 'h' are all 0, -SDL_UpdateRect will update the -entire screen.

This function should not be called while 'screen' is -locked.

SDL_UpdateRects

Name

SDL_UpdateRects -- Makes sure the given list of rectangles is updated on the given screen.

Synopsis

#include "SDL.h"

void SDL_UpdateRects(SDL_Surface *screen, int numrects, SDL_Rect *rects);

Description

Makes sure the given list of rectangles is updated on the given screen. -The rectangles must all be confined within the screen boundaries (no -clipping is done).

This function should not be called while screen is -locked.

Note: It is adviced to call this function only once per frame, since each -call has some processing overhead. This is no restriction since you -can pass any number of rectangles each time.
The rectangles are not automatically merged or checked for overlap. In -general, the programmer can use his knowledge about his particular -rectangles to merge them in an efficient way, to avoid overdraw.

SDL_UserEvent

Name

SDL_UserEvent -- A user-defined event type

Structure Definition

typedef struct{
-  Uint8 type;
-  int code;
-  void *data1;
-  void *data2;
-} SDL_UserEvent;

Structure Data

`type`	`SDL_USEREVENT` through to `SDL_NUMEVENTS-1`
`code`	User defined event code
`data1`	User defined data pointer
`data2`	User defined data pointer

Description

SDL_UserEvent is in the user member of the structure SDL_Event. This event is unique, it is never created by SDL but only by the user. The event can be pushed onto the event queue using SDL_PushEvent. The contents of the structure members or completely up to the programmer, the only requirement is that type is a value from SDL_USEREVENT to SDL_NUMEVENTS-1 (inclusive).

Examples

SDL_Event event;
-
-event.type = SDL_USEREVENT;
-event.user.code = my_event_code;
-event.user.data1 = significant_data;
-event.user.data2 = 0;
-SDL_PushEvent(&event);

SDL_VideoDriverName

Name

SDL_VideoDriverName -- Obtain the name of the video driver

Synopsis

#include "SDL.h"

char *SDL_VideoDriverName(char *namebuf, int maxlen);

Description

The buffer pointed to by namebuf is filled up to a maximum of maxlen characters (include the NULL terminator) with the name of the initialised video driver. The driver name is a simple one word identifier like "x11" or "windib".

Return Value

Returns NULL if video has not been initialised with SDL_Init or a pointer to namebuf otherwise.

SDL_VideoInfo

Name

SDL_VideoInfo -- Video Target information

Structure Definition

typedef struct{
-  Uint32 hw_available:1;
-  Uint32 wm_available:1;
-  Uint32 blit_hw:1;
-  Uint32 blit_hw_CC:1;
-  Uint32 blit_hw_A:1;
-  Uint32 blit_sw:1;
-  Uint32 blit_sw_CC:1;
-  Uint32 blit_sw_A:1;
-  Uint32 blit_fill;
-  Uint32 video_mem;
-  SDL_PixelFormat *vfmt;
-} SDL_VideoInfo;

Structure Data

`hw_available`	Is it possible to create hardware surfaces?
`wm_available`	Is there a window manager available
`blit_hw`	Are hardware to hardware blits accelerated?
`blit_hw_CC`	Are hardware to hardware colorkey blits accelerated?
`blit_hw_A`	Are hardware to hardware alpha blits accelerated?
`blit_sw`	Are software to hardware blits accelerated?
`blit_sw_CC`	Are software to hardware colorkey blits accelerated?
`blit_sw_A`	Are software to hardware alpha blits accelerated?
`blit_fill`	Are color fills accelerated?
`video_mem`	Total amount of video memory in Kilobytes
`vfmt`	Pixel format of the video device

Description

This (read-only) structure is returned by SDL_GetVideoInfo. It contains information on either the 'best' available mode (if called before SDL_SetVideoMode) or the current video mode.

SDL_VideoModeOK

Name

SDL_VideoModeOK -- Check to see if a particular video mode is supported.

Synopsis

#include "SDL.h"

int SDL_VideoModeOK(int width, int height, int bpp, Uint32 flags);

Description

SDL_VideoModeOK returns 0 -if the requested mode is not supported under any bit depth, or returns the -bits-per-pixel of the closest available mode with the given width, height and requested surface flags (see SDL_SetVideoMode).

The bits-per-pixel value returned is only a suggested mode. You can usually request and bpp you want when setting the video mode and SDL will emulate that color depth with a shadow video surface.

The arguments to SDL_VideoModeOK are the same ones you -would pass to SDL_SetVideoMode

Example

SDL_Surface *screen;
-Uint32 bpp;
-.
-.
-.
-printf("Checking mode 640x480@16bpp.\n");
-bpp=SDL_VideoModeOK(640, 480, 16, SDL_HWSURFACE);
-
-if(!bpp){
-  printf("Mode not available.\n");
-  exit(-1);
-}
-
-printf("SDL Recommends 640x480@%dbpp.\n", bpp);
-screen=SDL_SetVideoMode(640, 480, bpp, SDL_HWSURFACE);
-.
-.

SDL_WaitEvent

Name

SDL_WaitEvent -- Waits indefinitely for the next available event.

Synopsis

#include "SDL.h"

int SDL_WaitEvent(SDL_Event *event);

Description

Waits indefinitely for the next available event, returning -1, or 0 if there was -an error while waiting for events.

If event is not NULL, the next -event is removed from the queue and stored in that area.

SDL_WaitThread

Name

SDL_WaitThread -- Wait for a thread to finish.

Synopsis

#include "SDL.h"
-#include "SDL_thread.h"

void SDL_WaitThread(SDL_Thread *thread, int *status);

Description

Wait for a thread to finish (timeouts are not supported).

Return Value

The return code for the thread function is placed in the area pointed to by -status, if status is not -NULL.

SDL_WarpMouse

Name

SDL_WarpMouse -- Set the position of the mouse cursor.

Synopsis

#include "SDL.h"

void SDL_WarpMouse(Uint16 x, Uint16 y);

Description

Set the position of the mouse cursor (generates a mouse motion event).

SDL_WasInit

Name

SDL_WasInit -- Check which subsystems are initialized

Synopsis

#include "SDL.h"

Uint32 SDL_WasInit(Uint32 flags);

Description

SDL_WasInit allows you to see which SDL subsytems have been initialized. flags is a bitwise OR'd combination of the subsystems you wish to check (see SDL_Init for a list of subsystem flags).

Return Value

SDL_WasInit returns a bitwised OR'd combination of the initialized subsystems.

Examples

/* Here are several ways you can use SDL_WasInit() */
-
-/* Get init data on all the subsystems */
-Uint32 subsystem_init;
-
-subsystem_init=SDL_WasInit(SDL_INIT_EVERYTHING);
-
-if(subsystem_init&SDL_INIT_VIDEO)
-  printf("Video is initialized.\n");
-else
-  printf("Video is not initialized.\n");
-
-
-
-/* Just check for one specfic subsystem */
-
-if(SDL_WasInit(SDL_INIT_VIDEO)!=0)
-  printf("Video is initialized.\n");
-else
-  printf("Video is not initialized.\n");
-
-
-
-
-/* Check for two subsystems */
-
-Uint32 subsystem_mask=SDL_INIT_VIDEO|SDL_INIT_AUDIO;
-
-if(SDL_WasInit(subsystem_mask)==subsystem_mask)
-  printf("Video and Audio initialized.\n");
-else
-  printf("Video and Audio not initialized.\n");

SDL_WM_GetCaption

Name

SDL_WM_GetCaption -- Gets the window title and icon name.

Synopsis

#include "SDL.h"

void SDL_WM_GetCaption(char **title, char **icon);

Description

Set pointers to the window title and icon name.

SDL_WM_GrabInput

Name

SDL_WM_GrabInput -- Grabs mouse and keyboard input.

Synopsis

#include "SDL.h"

SDL_GrabMode SDL_WM_GrabInput(SDL_GrabMode mode);

Description

Grabbing means that the mouse is confined to the application window, -and nearly all keyboard input is passed directly to the application, -and not interpreted by a window manager, if any.

When mode is SDL_GRAB_QUERY the grab mode is not changed, but the current grab mode is returned.

typedef enum {
-  SDL_GRAB_QUERY,
-  SDL_GRAB_OFF,
-  SDL_GRAB_ON
-} SDL_GrabMode;

Return Value

The current/new SDL_GrabMode.

Prev	Home	Next
SDL_WM_ToggleFullScreen	Up	Events

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/sdlwmiconifywindow.html --- a/docs/html/sdlwmiconifywindow.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,211 +0,0 @@ -SDL_WM_IconifyWindow

SDL Library Documentation
Prev		Next

SDL_WM_IconifyWindow

Name

SDL_WM_IconifyWindow -- Iconify/Minimise the window

Synopsis

#include "SDL.h"

int SDL_WM_IconifyWindow(void);

Description

If the application is running in a window managed environment SDL attempts to iconify/minimise it. If SDL_WM_IconifyWindow is successful, the application will receive a SDL_APPACTIVE loss event.

Return Value

Returns non-zero on success or 0 if iconification is not support or was refused by the window manager.

Prev	Home	Next
SDL_WM_SetIcon	Up	SDL_WM_ToggleFullScreen

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/sdlwmsetcaption.html --- a/docs/html/sdlwmsetcaption.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,212 +0,0 @@ -SDL_WM_SetCaption

SDL Library Documentation
Prev		Next

SDL_WM_SetCaption

Name

SDL_WM_SetCaption -- Sets the window tile and icon name.

Synopsis

#include "SDL.h"

void SDL_WM_SetCaption(const char *title, const char *icon);

Description

Sets the title-bar and icon name of the display window.

SDL_WM_SetIcon

Name

SDL_WM_SetIcon -- Sets the icon for the display window.

Synopsis

#include "SDL.h"

void SDL_WM_SetIcon(SDL_Surface *icon, Uint8 *mask);

Description

Sets the icon for the display window. Win32 icons must be 32x32.

This function must be called before the first call to -SDL_SetVideoMode.

The mask is a bitmask that describes the shape of the -icon. If mask 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 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

SDL_WM_SetIcon(SDL_LoadBMP("icon.bmp"), NULL);

SDL_WM_ToggleFullScreen

Name

SDL_WM_ToggleFullScreen -- Toggles fullscreen mode

Synopsis

#include "SDL.h"

int SDL_WM_ToggleFullScreen(SDL_Surface *surface);

Description

Toggles the application between windowed and fullscreen mode, if supported. (X11 is the only target currently supported, BeOS support is experimental).

Return Value

Returns 0 on failure or 1 on success.

Prev	Home	Next
SDL_WM_IconifyWindow	Up	SDL_WM_GrabInput

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/thread.html --- a/docs/html/thread.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,313 +0,0 @@ -Multi-threaded Programming

SDL Library Documentation
Prev		Next

Chapter 12. Multi-threaded Programming

Table of Contents
SDL_CreateThread -- Creates a new thread of execution that shares its parent's properties.
SDL_ThreadID -- Get the 32-bit thread identifier for the current thread.
SDL_GetThreadID -- Get the SDL thread ID of a SDL_Thread
SDL_WaitThread -- Wait for a thread to finish.
SDL_KillThread -- Gracelessly terminates the thread.
SDL_CreateMutex -- Create a mutex
SDL_DestroyMutex -- Destroy a mutex
SDL_mutexP -- Lock a mutex
SDL_mutexV -- Unlock a mutex
SDL_CreateSemaphore -- Creates a new semaphore and assigns an initial value to it.
SDL_DestroySemaphore -- Destroys a semaphore that was created by SDL_CreateSemaphore.
SDL_SemWait -- 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.
SDL_SemWaitTimeout -- Lock a semaphore, but only wait up to a specified maximum time.
SDL_SemPost -- Unlock a semaphore.
SDL_SemValue -- Return the current value of a semaphore.
SDL_CreateCond -- Create a condition variable
SDL_DestroyCond -- Destroy a condition variable
SDL_CondSignal -- Restart a thread wait on a condition variable
SDL_CondBroadcast -- Restart all threads waiting on a condition variable
SDL_CondWait -- Wait on a condition variable
SDL_CondWaitTimeout -- Wait on a condition variable, with timeout

SDL provides functions for creating threads, mutexes, semphores and condition variables.

In general, you must be very aware of concurrency and data integrity issues -when writing multi-threaded programs. Some good guidelines include: -

Don't call SDL video/event functions from separate threads
Don't use any library functions in separate threads
Don't perform any memory management in separate threads
Lock global variables which may be accessed by multiple threads
Never terminate threads, always set a flag and wait for them to quit
Think very carefully about all possible ways your code may interact

Note: SDL's threading is not implemented on MacOS, due to that lack of preemptive thread support (Mac OS X dos nt suffer from this problem)

Prev	Home	Next
SDL_CDtrack	Up	SDL_CreateThread

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/time.html --- a/docs/html/time.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,206 +0,0 @@ -Time

SDL Library Documentation
Prev		Next

Chapter 13. Time

Table of Contents
SDL_GetTicks -- Get the number of milliseconds since the SDL library initialization.
SDL_Delay -- 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 -elapsed.
SDL_RemoveTimer -- Remove a timer which was added with -SDL_AddTimer.
SDL_SetTimer -- Set a callback to run after the specified number of milliseconds has -elapsed.

SDL provides several cross-platform functions for dealing with time. -It provides a way to get the current time, a way to wait a little while, -and a simple timer mechanism. These functions give you two ways of moving an -object every x milliseconds: - -

Use a timer callback function. This may have the bad effect that it runs in a seperate thread or uses alarm signals, but it's easier to implement.
Or you can get the number of milliseconds passed, and move the object if, for example, 30 ms passed.

Prev	Home	Next
SDL_CondWaitTimeout	Up	SDL_GetTicks

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/video.html --- a/docs/html/video.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,507 +0,0 @@ -Video

SDL Library Documentation
Prev		Next

Chapter 6. Video

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

SDL presents a very simple interface to the display framebuffer. The -framebuffer is represented as an offscreen surface to which you can write -directly. If you want the screen to show what you have written, call the update function which will -guarantee that the desired portion of the screen is updated.

Before you call any of the SDL video functions, you must first call -SDL_Init(SDL_INIT_VIDEO), which initializes the video -and events in the SDL library. Check the return code, which should be -0, to see if there were any errors in starting up.

If you use both sound and video in your application, you need to call -SDL_Init(SDL_INIT_AUDIO | SDL_INIT_VIDEO) before opening the -sound device, otherwise under Win32 DirectX, you won't be able to set -full-screen display modes.

After you have initialized the library, you can start up the video display in a -number of ways. The easiest way is to pick a common screen resolution and -depth and just initialize the video, checking for errors. You will probably -get what you want, but SDL may be emulating your requested mode and converting -the display on update. The best way is to -query, for the best -video mode closest to the desired one, and then -convert -your images to that pixel format.

SDL currently supports any bit depth >= 8 bits per pixel. 8 bpp formats are -considered 8-bit palettized modes, while 12, 15, 16, 24, and 32 bits per pixel -are considered "packed pixel" modes, meaning each pixel contains the RGB color -components packed in the bits of the pixel.

After you have initialized your video mode, you can take the surface that was -returned, and write to it like any other framebuffer, calling the update -routine as you go.

When you have finished your video access and are ready to quit your -application, you should call "SDL_Quit()" to shutdown the -video and events.

Prev	Home	Next
SDL_envvars	Up	SDL_GetVideoSurface

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/html/wm.html --- a/docs/html/wm.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,188 +0,0 @@ -Window Management

SDL Library Documentation
Prev		Next

Chapter 7. Window Management

Table of Contents
SDL_WM_SetCaption -- Sets the window tile and icon name.
SDL_WM_GetCaption -- Gets the window title and icon name.
SDL_WM_SetIcon -- Sets the icon for the display window.
SDL_WM_IconifyWindow -- Iconify/Minimise the window
SDL_WM_ToggleFullScreen -- Toggles fullscreen mode
SDL_WM_GrabInput -- Grabs mouse and keyboard input.

SDL provides a small set of window management functions which allow applications to change their title and toggle from windowed mode to fullscreen (if available)

Prev	Home	Next
SDL_Overlay	Up	SDL_WM_SetCaption

\ No newline at end of file diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/images/rainbow.gif Binary file docs/images/rainbow.gif has changed diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/index.html --- a/docs/index.html Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,55 +0,0 @@ - - -Simple DirectMedia Layer Introduction - -

Simple DirectMedia Layer Introduction

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

-An introduction to SDL can be found online at: - - http://www.libsdl.org/intro.php -

-Tutorials on a variety of topics can be found online at: - - http://www.libsdl.org/tutorials.php -

-Documentation in Wiki form can be found online at: - - http://www.libsdl.org/cgi/docwiki.cgi/ -

-Enjoy! -

- Sam Lantinga -<slouken@libsdl.org> -

diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDLKey.3 --- a/docs/man3/SDLKey.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,161 +0,0 @@ -.TH "SDLKey" "3" "Wed 11 Oct 2000, 22:28" "SDL" "SDL API Reference" -.SH "NAME" -SDLKey \- SDL Keysym Definitions -.SH "SDL Keysym definitions" -.PP -\fBSDLKey ASCII value Common Name\fR -.nf -\f(CWSDLK_BACKSPACE '\\b' backspace -SDLK_TAB '\\t' tab -SDLK_CLEAR clear -SDLK_RETURN '\\r' return -SDLK_PAUSE pause -SDLK_ESCAPE '^[' escape -SDLK_SPACE ' ' space -SDLK_EXCLAIM '!' exclaim -SDLK_QUOTEDBL '"' quotedbl -SDLK_HASH '#' hash -SDLK_DOLLAR '$' dollar -SDLK_AMPERSAND '&' ampersand -SDLK_QUOTE ''' quote -SDLK_LEFTPAREN '(' left parenthesis -SDLK_RIGHTPAREN ')' right parenthesis -SDLK_ASTERISK '*' asterisk -SDLK_PLUS '+' plus sign -SDLK_COMMA ',' comma -SDLK_MINUS '-' minus sign -SDLK_PERIOD '.' period -SDLK_SLASH '/' forward slash -SDLK_0 '0' 0 -SDLK_1 '1' 1 -SDLK_2 '2' 2 -SDLK_3 '3' 3 -SDLK_4 '4' 4 -SDLK_5 '5' 5 -SDLK_6 '6' 6 -SDLK_7 '7' 7 -SDLK_8 '8' 8 -SDLK_9 '9' 9 -SDLK_COLON ':' colon -SDLK_SEMICOLON ';' semicolon -SDLK_LESS '<' less-than sign -SDLK_EQUALS '=' equals sign -SDLK_GREATER '>' greater-than sign -SDLK_QUESTION '?' question mark -SDLK_AT '@' at -SDLK_LEFTBRACKET '[' left bracket -SDLK_BACKSLASH '\\' backslash -SDLK_RIGHTBRACKET ']' right bracket -SDLK_CARET '^' caret -SDLK_UNDERSCORE '_' underscore -SDLK_BACKQUOTE '`' grave -SDLK_a 'a' a -SDLK_b 'b' b -SDLK_c 'c' c -SDLK_d 'd' d -SDLK_e 'e' e -SDLK_f 'f' f -SDLK_g 'g' g -SDLK_h 'h' h -SDLK_i 'i' i -SDLK_j 'j' j -SDLK_k 'k' k -SDLK_l 'l' l -SDLK_m 'm' m -SDLK_n 'n' n -SDLK_o 'o' o -SDLK_p 'p' p -SDLK_q 'q' q -SDLK_r 'r' r -SDLK_s 's' s -SDLK_t 't' t -SDLK_u 'u' u -SDLK_v 'v' v -SDLK_w 'w' w -SDLK_x 'x' x -SDLK_y 'y' y -SDLK_z 'z' z -SDLK_DELETE '^?' delete -SDLK_KP0 keypad 0 -SDLK_KP1 keypad 1 -SDLK_KP2 keypad 2 -SDLK_KP3 keypad 3 -SDLK_KP4 keypad 4 -SDLK_KP5 keypad 5 -SDLK_KP6 keypad 6 -SDLK_KP7 keypad 7 -SDLK_KP8 keypad 8 -SDLK_KP9 keypad 9 -SDLK_KP_PERIOD '.' keypad period -SDLK_KP_DIVIDE '/' keypad divide -SDLK_KP_MULTIPLY '*' keypad multiply -SDLK_KP_MINUS '-' keypad minus -SDLK_KP_PLUS '+' keypad plus -SDLK_KP_ENTER '\\r' keypad enter -SDLK_KP_EQUALS '=' keypad equals -SDLK_UP up arrow -SDLK_DOWN down arrow -SDLK_RIGHT right arrow -SDLK_LEFT left arrow -SDLK_INSERT insert -SDLK_HOME home -SDLK_END end -SDLK_PAGEUP page up -SDLK_PAGEDOWN page down -SDLK_F1 F1 -SDLK_F2 F2 -SDLK_F3 F3 -SDLK_F4 F4 -SDLK_F5 F5 -SDLK_F6 F6 -SDLK_F7 F7 -SDLK_F8 F8 -SDLK_F9 F9 -SDLK_F10 F10 -SDLK_F11 F11 -SDLK_F12 F12 -SDLK_F13 F13 -SDLK_F14 F14 -SDLK_F15 F15 -SDLK_NUMLOCK numlock -SDLK_CAPSLOCK capslock -SDLK_SCROLLOCK scrollock -SDLK_RSHIFT right shift -SDLK_LSHIFT left shift -SDLK_RCTRL right ctrl -SDLK_LCTRL left ctrl -SDLK_RALT right alt -SDLK_LALT left alt -SDLK_RMETA right meta -SDLK_LMETA left meta -SDLK_LSUPER left windows key -SDLK_RSUPER right windows key -SDLK_MODE mode shift -SDLK_HELP help -SDLK_PRINT print-screen -SDLK_SYSREQ SysRq -SDLK_BREAK break -SDLK_MENU menu -SDLK_POWER power -SDLK_EURO euro\fR -.fi - - -.SH "SDL modifier definitions" -.PP -\fBSDL Modifier Meaning\fR -.nf -\f(CWKMOD_NONE No modifiers applicable -KMOD_NUM Numlock is down -KMOD_CAPS Capslock is down -KMOD_LCTRL Left Control is down -KMOD_RCTRL Right Control is down -KMOD_RSHIFT Right Shift is down -KMOD_LSHIFT Left Shift is down -KMOD_RALT Right Alt is down -KMOD_LALT Left Alt is down -KMOD_CTRL A Control key is down -KMOD_SHIFT A Shift key is down -KMOD_ALT An Alt key is down\fR -.fi - diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_ActiveEvent.3 --- a/docs/man3/SDL_ActiveEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,38 +0,0 @@ -.TH "SDL_ActiveEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_ActiveEvent \- Application visibility event structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type; - Uint8 gain; - Uint8 state; -} SDL_ActiveEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_ACTIVEEVENT\&.\fP -.TP 20 -\fBgain\fR -0 if the event is a loss or 1 if it is a gain\&. -.TP 20 -\fBstate\fR -\fBSDL_APPMOUSEFOCUS\fP if mouse focus was gained or lost, \fBSDL_APPINPUTFOCUS\fP if input focus was gained or lost, or \fBSDL_APPACTIVE\fP if the application was iconified (\fBgain\fR=0) or restored(\fBgain\fR=1)\&. -.SH "DESCRIPTION" -.PP -\fBSDL_ActiveEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_ACTIVEEVENT\fP is reported\&. -.PP -When the mouse leaves or enters the window area a \fBSDL_APPMOUSEFOCUS\fP type activation event occurs, if the mouse entered the window then \fBgain\fR will be 1, otherwise \fBgain\fR will be 0\&. A \fBSDL_APPINPUTFOCUS\fP type activation event occurs when the application loses or gains keyboard focus\&. This usually occurs when another application is made active\&. Finally, a \fBSDL_APPACTIVE\fP type event occurs when the application is either minimised/iconified (\fBgain\fR=0) or restored\&. -.PP -.RS -\fBNote: -.PP -This event does not occur when an application window is first created\&. -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_GetAppState\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_AddTimer.3 --- a/docs/man3/SDL_AddTimer.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,38 +0,0 @@ -.TH "SDL_AddTimer" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_AddTimer \- Add a timer which will call a callback after the specified number of milliseconds has elapsed\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_TimerID \fBSDL_AddTimer\fP\fR(\fBUint32 interval, SDL_NewTimerCallback callback, void *param\fR); -.SH "CALLBACK" -.PP -.nf -\f(CW/* type definition for the "new" timer callback function */ -typedef Uint32 (*SDL_NewTimerCallback)(Uint32 interval, void *param);\fR -.fi -.PP -.SH "DESCRIPTION" -.PP -Adds a callback function to be run after the specified number of milliseconds has elapsed\&. The callback function is passed the current timer interval and the user supplied parameter from the \fBSDL_AddTimer\fP call and returns the next timer interval\&. If the returned value from the callback is the same as the one passed in, the periodic alarm continues, otherwise a new alarm is scheduled\&. -.PP -To cancel a currently running timer call \fISDL_RemoveTimer\fR with the timer ID returned from \fBSDL_AddTimer\fP\&. -.PP -The timer callback function may run in a different thread than your main program, and so shouldn\&'t call any functions from within itself\&. You may always call \fISDL_PushEvent\fR, however\&. -.PP -The granularity of the timer is platform-dependent, but you should count on it being at least 10 ms as this is the most common number\&. This means that if you request a 16 ms timer, your callback will run approximately 20 ms later on an unloaded system\&. If you wanted to set a flag signaling a frame update at 30 frames per second (every 33 ms), you might set a timer for 30 ms (see example below)\&. If you use this function, you need to pass \fBSDL_INIT_TIMER\fP to \fISDL_Init\fR\&. -.SH "RETURN VALUE" -.PP -Returns an ID value for the added timer or \fBNULL\fR if there was an error\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWmy_timer_id = SDL_AddTimer((33/10)*10, my_callbackfunc, my_callback_param);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_RemoveTimer\fP\fR, \fI\fBSDL_PushEvent\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_AudioCVT.3 --- a/docs/man3/SDL_AudioCVT.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,68 +0,0 @@ -.TH "SDL_AudioCVT" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_AudioCVT \- Audio Conversion Structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - int needed; - Uint16 src_format; - Uint16 dest_format; - double rate_incr; - Uint8 *buf; - int len; - int len_cvt; - int len_mult; - double len_ratio; - void (*filters[10])(struct SDL_AudioCVT *cvt, Uint16 format); - int filter_index; -} SDL_AudioCVT;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBneeded\fR -Set to one if the conversion is possible -.TP 20 -\fBsrc_format\fR -Audio format of the source -.TP 20 -\fBdest_format\fR -Audio format of the destination -.TP 20 -\fBrate_incr\fR -Rate conversion increment -.TP 20 -\fBbuf\fR -Audio buffer -.TP 20 -\fBlen\fR -Length of the original audio buffer in bytes -.TP 20 -\fBlen_cvt\fR -Length of converted audio buffer in bytes (calculated) -.TP 20 -\fBlen_mult\fR -\fBbuf\fR must be \fBlen\fR*\fBlen_mult\fR bytes in size(calculated) -.TP 20 -\fBlen_ratio\fR -Final audio size is \fBlen\fR*\fBlen_ratio\fR -.TP 20 -\fBfilters[10](\&.\&.)\fR -Pointers to functions needed for this conversion -.TP 20 -\fBfilter_index\fR -Current conversion function -.SH "DESCRIPTION" -.PP -The \fBSDL_AudioCVT\fR is used to convert audio data between different formats\&. A \fBSDL_AudioCVT\fR structure is created with the \fI\fBSDL_BuildAudioCVT\fP\fR function, while the actual conversion is done by the \fI\fBSDL_ConvertAudio\fP\fR function\&. -.PP -Many of the fields in the \fBSDL_AudioCVT\fR structure should be considered private and their function will not be discussed here\&. -.IP "\fBUint8 *\fP\fBbuf\fR" 10This points to the audio data that will be used in the conversion\&. It is both the source and the destination, which means the converted audio data overwrites the original data\&. It also means that the converted data may be larger than the original data (if you were converting from 8-bit to 16-bit, for instance), so you must ensure \fBbuf\fR is large enough\&. See below\&. -.IP "\fBint\fP \fBlen\fR" 10This is the length of the original audio data in bytes\&. -.IP "\fBint\fP \fBlen_mult\fR" 10As explained above, the audio buffer needs to be big enough to store the converted data, which may be bigger than the original audio data\&. The length of \fBbuf\fR should be \fBlen\fR*\fBlen_mult\fR\&. -.IP "\fBdouble\fP \fBlen_ratio\fR" 10When you have finished converting your audio data, you need to know how much of your audio buffer is valid\&. \fBlen\fR*\fBlen_ratio\fR is the size of the converted audio data in bytes\&. This is very similar to \fBlen_mult\fR, however when the convert audio data is shorter than the original \fBlen_mult\fR would be 1\&. \fBlen_ratio\fR, on the other hand, would be a fractional number between 0 and 1\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_BuildAudioCVT\fP\fR, \fI\fBSDL_ConvertAudio\fP\fR, \fI\fBSDL_AudioSpec\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_AudioSpec.3 --- a/docs/man3/SDL_AudioSpec.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,70 +0,0 @@ -.TH "SDL_AudioSpec" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_AudioSpec \- Audio Specification Structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - int freq; - Uint16 format; - Uint8 channels; - Uint8 silence; - Uint16 samples; - Uint32 size; - void (*callback)(void *userdata, Uint8 *stream, int len); - void *userdata; -} SDL_AudioSpec;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBfreq\fR -Audio frequency in samples per second -.TP 20 -\fBformat\fR -Audio data format -.TP 20 -\fBchannels\fR -Number of channels: 1 mono, 2 stereo -.TP 20 -\fBsilence\fR -Audio buffer silence value (calculated) -.TP 20 -\fBsamples\fR -Audio buffer size in samples -.TP 20 -\fBsize\fR -Audio buffer size in bytes (calculated) -.TP 20 -\fBcallback(\&.\&.)\fR -Callback function for filling the audio buffer -.TP 20 -\fBuserdata\fR -Pointer the user data which is passed to the callback function -.SH "DESCRIPTION" -.PP -The \fBSDL_AudioSpec\fR structure is used to describe the format of some audio data\&. This structure is used by \fI\fBSDL_OpenAudio\fP\fR and \fI\fBSDL_LoadWAV\fP\fR\&. While all fields are used by \fBSDL_OpenAudio\fP only \fBfreq\fR, \fBformat\fR, \fBsamples\fR and \fBchannels\fR are used by \fBSDL_LoadWAV\fP\&. We will detail these common members here\&. -.TP 20 -\fBfreq\fR -The number of samples sent to the sound device every second\&. Common values are 11025, 22050 and 44100\&. The higher the better\&. -.TP 20 -\fBformat\fR -Specifies the size and type of each sample element -.IP "\fBAUDIO_U8\fP" 10Unsigned 8-bit samples -.IP "\fBAUDIO_S8\fP" 10Signed 8-bit samples -.IP "\fBAUDIO_U16\fP or \fBAUDIO_U16LSB\fP" 10Unsigned 16-bit little-endian samples -.IP "\fBAUDIO_S16\fP or \fBAUDIO_S16LSB\fP" 10Signed 16-bit little-endian samples -.IP "\fBAUDIO_U16MSB\fP" 10Unsigned 16-bit big-endian samples -.IP "\fBAUDIO_S16MSB\fP" 10Signed 16-bit big-endian samples -.IP "\fBAUDIO_U16SYS\fP" 10Either \fBAUDIO_U16LSB\fP or \fBAUDIO_U16MSB\fP depending on you systems endianness -.IP "\fBAUDIO_S16SYS\fP" 10Either \fBAUDIO_S16LSB\fP or \fBAUDIO_S16MSB\fP depending on you systems endianness -.TP 20 -\fBchannels\fR -The number of seperate sound channels\&. 1 is mono (single channel), 2 is stereo (dual channel)\&. -.TP 20 -\fBsamples\fR -When used with \fI\fBSDL_OpenAudio\fP\fR this refers to the size of the audio buffer in samples\&. A sample a chunk of audio data of the size specified in \fBformat\fR mulitplied by the number of channels\&. When the \fBSDL_AudioSpec\fR is used with \fI\fBSDL_LoadWAV\fP\fR \fBsamples\fR is set to 4096\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_OpenAudio\fP\fR, \fI\fBSDL_LoadWAV\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_BlitSurface.3 --- a/docs/man3/SDL_BlitSurface.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,60 +0,0 @@ -.TH "SDL_BlitSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_BlitSurface \- This performs a fast blit from the source surface to the destination surface\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_BlitSurface\fP\fR(\fBSDL_Surface *src, SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect\fR); -.SH "DESCRIPTION" -.PP -This performs a fast blit from the source surface to the destination surface\&. -.PP -Only the position is used in the \fBdstrect\fR (the width and height are ignored)\&. -.PP -If either \fBsrcrect\fR or \fBdstrect\fR are \fBNULL\fP, the entire surface (\fBsrc\fR or \fBdst\fR) is copied\&. -.PP -The final blit rectangle is saved in \fBdstrect\fR after all clipping is performed (\fBsrcrect\fR is not modified)\&. -.PP -The blit function should not be called on a locked surface\&. -.PP -The results of blitting operations vary greatly depending on whether \fBSDL_SRCAPLHA\fP is set or not\&. See \fISDL_SetAlpha\fR for an explaination of how this affects your results\&. Colorkeying and alpha attributes also interact with surface blitting, as the following pseudo-code should hopefully explain\&. -.PP -.nf -\f(CWif (source surface has SDL_SRCALPHA set) { - if (source surface has alpha channel (that is, format->Amask != 0)) - blit using per-pixel alpha, ignoring any colour key - else { - if (source surface has SDL_SRCCOLORKEY set) - blit using the colour key AND the per-surface alpha value - else - blit using the per-surface alpha value - } -} else { - if (source surface has SDL_SRCCOLORKEY set) - blit using the colour key - else - ordinary opaque rectangular blit -}\fR -.fi -.PP -.SH "RETURN VALUE" -.PP -If the blit is successful, it returns \fB0\fR, otherwise it returns \fB-1\fR\&. -.PP -If either of the surfaces were in video memory, and the blit returns \fB-2\fR, the video memory was lost, so it should be reloaded with artwork and re-blitted: -.PP -.nf -\f(CW while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) { - while ( SDL_LockSurface(image)) < 0 ) - Sleep(10); - -- Write image pixels to image->pixels -- - SDL_UnlockSurface(image); - }\fR -.fi -.PP - This happens under DirectX 5\&.0 when the system switches away from your fullscreen application\&. Locking the surface will also fail until you have access to the video memory again\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_FillRect\fP\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_Rect\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_BuildAudioCVT.3 --- a/docs/man3/SDL_BuildAudioCVT.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,23 +0,0 @@ -.TH "SDL_BuildAudioCVT" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_BuildAudioCVT \- Initializes a SDL_AudioCVT structure for conversion -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_BuildAudioCVT\fP\fR(\fBSDL_AudioCVT *cvt, Uint16 src_format, Uint8 src_channels, int src_rate, Uint16 dst_format, Uint8 dst_channels, int dst_rate\fR); -.SH "DESCRIPTION" -.PP -Before an \fI\fBSDL_AudioCVT\fR\fR structure can be used to convert audio data it must be initialized with source and destination information\&. -.PP -\fBsrc_format\fR and \fBdst_format\fR are the source and destination format of the conversion\&. (For information on audio formats see \fI\fB SDL_AudioSpec\fR\fR)\&. \fBsrc_channels\fR and \fBdst_channels\fR are the number of channels in the source and destination formats\&. Finally, \fBsrc_rate\fR and \fBdst_rate\fR are the frequency or samples-per-second of the source and destination formats\&. Once again, see \fI\fBSDL_AudioSpec\fR\fR\&. -.SH "RETURN VALUES" -.PP -Returns \fB-1\fR if the filter could not be built or 1 if it could\&. -.SH "EXAMPLES" -.PP -See \fI\fBSDL_ConvertAudio\fP\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_ConvertAudio\fP\fR, \fI\fBSDL_AudioCVT\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CD.3 --- a/docs/man3/SDL_CD.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,57 +0,0 @@ -.TH "SDL_CD" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CD \- CDROM Drive Information -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - int id; - CDstatus status; - int numtracks; - int cur_track; - int cur_frame; - SDL_CDtrack track[SDL_MAX_TRACKS+1]; -} SDL_CD;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBid\fR -Private drive identifier -.TP 20 -\fBstatus\fR -Drive \fIstatus\fR -.TP 20 -\fBnumtracks\fR -Number of tracks on the CD -.TP 20 -\fBcur_track\fR -Current track -.TP 20 -\fBcur_frame\fR -Current frame offset within the track -.TP 20 -\fBtrack\fR[SDL_MAX_TRACKS+1] -Array of track descriptions\&. (see \fI\fBSDL_CDtrack\fR\fR) -.SH "DESCRIPTION" -.PP -An \fBSDL_CD\fR structure is returned by \fI\fBSDL_CDOpen\fP\fR\&. It represents an opened CDROM device and stores information on the layout of the tracks on the disc\&. -.PP -A frame is the base data unit of a CD\&. \fBCD_FPS\fP frames is equal to 1 second of music\&. SDL provides two macros for converting between time and frames: \fBFRAMES_TO_MSF(f, M,S,F)\fP and \fBMSF_TO_FRAMES\fP\&. -.SH "EXAMPLES" -.PP -.nf -\f(CWint min, sec, frame; -int frame_offset; - -FRAMES_TO_MSF(cdrom->cur_frame, &min, &sec, &frame); -printf("Current Position: %d minutes, %d seconds, %d frames -", min, sec, frame); - -frame_offset=MSF_TO_FRAMES(min, sec, frame);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_CDOpen\fP\fR, \fI\fBSDL_CDtrack\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDClose.3 --- a/docs/man3/SDL_CDClose.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_CDClose" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDClose \- Closes a SDL_CD handle -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_CDClose\fP\fR(\fBSDL_CD *cdrom\fR); -.SH "DESCRIPTION" -.PP -Closes the given \fBcdrom\fR handle\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CDOpen\fP\fR, \fI\fBSDL_CD\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDEject.3 --- a/docs/man3/SDL_CDEject.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_CDEject" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDEject \- Ejects a CDROM -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_CDEject\fP\fR(\fBSDL_CD *cdrom\fR); -.SH "DESCRIPTION" -.PP -Ejects the given \fBcdrom\fR\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on success, or \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CD\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDName.3 --- a/docs/man3/SDL_CDName.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,23 +0,0 @@ -.TH "SDL_CDName" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDName \- Returns a human-readable, system-dependent identifier for the CD-ROM\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBconst char *\fBSDL_CDName\fP\fR(\fBint drive\fR); -.SH "DESCRIPTION" -.PP -Returns a human-readable, system-dependent identifier for the CD-ROM\&. \fBdrive\fR is the index of the drive\&. Drive indices start to 0 and end at \fBSDL_CDNumDrives()\fP-1\&. -.SH "EXAMPLES" -.PP -.IP " \(bu" 6 -"/dev/cdrom" -.IP " \(bu" 6 -"E:" -.IP " \(bu" 6 -"/dev/disk/ide/1/master" -.SH "SEE ALSO" -.PP -\fI\fBSDL_CDNumDrives\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDNumDrives.3 --- a/docs/man3/SDL_CDNumDrives.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_CDNumDrives" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDNumDrives \- Returns the number of CD-ROM drives on the system\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_CDNumDrives\fP\fR(\fBvoid\fR) -.SH "DESCRIPTION" -.PP -Returns the number of CD-ROM drives on the system\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CDOpen\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDOpen.3 --- a/docs/man3/SDL_CDOpen.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,58 +0,0 @@ -.TH "SDL_CDOpen" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDOpen \- Opens a CD-ROM drive for access\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_CD *\fBSDL_CDOpen\fP\fR(\fBint drive\fR); -.SH "DESCRIPTION" -.PP -Opens a CD-ROM drive for access\&. It returns a \fI\fBSDL_CD\fR\fR structure on success, or \fBNULL\fP if the drive was invalid or busy\&. This newly opened CD-ROM becomes the default CD used when other CD functions are passed a \fBNULL\fP CD-ROM handle\&. -.PP -Drives are numbered starting with 0\&. Drive 0 is the system default CD-ROM\&. -.SH "EXAMPLES" -.PP -.nf -\f(CWSDL_CD *cdrom; -int cur_track; -int min, sec, frame; -SDL_Init(SDL_INIT_CDROM); -atexit(SDL_Quit); - -/* Check for CD drives */ -if(!SDL_CDNumDrives()){ - /* None found */ - fprintf(stderr, "No CDROM devices available -"); - exit(-1); -} - -/* Open the default drive */ -cdrom=SDL_CDOpen(0); - -/* Did if open? Check if cdrom is NULL */ -if(!cdrom){ - fprintf(stderr, "Couldn\&'t open drive: %s -", SDL_GetError()); - exit(-1); -} - -/* Print Volume info */ -printf("Name: %s -", SDL_CDName(0)); -printf("Tracks: %d -", cdrom->numtracks); -for(cur_track=0;cur_track < cdrom->numtracks; cur_track++){ - FRAMES_TO_MSF(cdrom->track[cur_track]\&.length, &min, &sec, &frame); - printf(" Track %d: Length %d:%d -", cur_track, min, sec); -} - -SDL_CDClose(cdrom);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_CD\fR\fR, \fI\fBSDL_CDtrack\fR\fR, \fI\fBSDL_CDClose\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDPause.3 --- a/docs/man3/SDL_CDPause.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_CDPause" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDPause \- Pauses a CDROM -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_CDPause\fP\fR(\fBSDL_CD *cdrom\fR); -.SH "DESCRIPTION" -.PP -Pauses play on the given \fBcdrom\fR\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on success, or \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDResume\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDPlay.3 --- a/docs/man3/SDL_CDPlay.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_CDPlay" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDPlay \- Play a CD -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_CDPlay\fP\fR(\fBSDL_CD *cdrom, int start, int length\fR); -.SH "DESCRIPTION" -.PP -Plays the given \fBcdrom\fR, starting a frame \fBstart\fR for \fBlength\fR frames\&. -.SH "RETURN VALUES" -.PP -Returns \fB0\fR on success, or \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CDPlayTracks\fP\fR, \fI\fBSDL_CDStop\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDPlayTracks.3 --- a/docs/man3/SDL_CDPlayTracks.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,47 +0,0 @@ -.TH "SDL_CDPlayTracks" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDPlayTracks \- Play the given CD track(s) -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_CDPlayTracks\fP\fR(\fBSDL_CD *cdrom, int start_track, int start_frame, int ntracks, int nframes)\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_CDPlayTracks\fP plays the given CD starting at track \fBstart_track\fR, for \fBntracks\fR tracks\&. -.PP -\fBstart_frame\fR is the frame offset, from the beginning of the \fBstart_track\fR, at which to start\&. \fBnframes\fR is the frame offset, from the beginning of the last track (\fBstart_track\fR+\fBntracks\fR), at which to end playing\&. -.PP -\fBSDL_CDPlayTracks\fP should only be called after calling \fI\fBSDL_CDStatus\fP\fR to get track information about the CD\&. -.PP -.RS -\fBNote: -.PP -Data tracks are ignored\&. -.RE -.SH "RETURN VALUE" -.PP -Returns \fB0\fR, or \fB-1\fR if there was an error\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CW/* assuming cdrom is a previously opened device */ -/* Play the entire CD */ -if(CD_INDRIVE(SDL_CDStatus(cdrom))) - SDL_CDPlayTracks(cdrom, 0, 0, 0, 0); - -/* Play the first track */ -if(CD_INDRIVE(SDL_CDStatus(cdrom))) - SDL_CDPlayTracks(cdrom, 0, 0, 1, 0); - -/* Play first 15 seconds of the 2nd track */ -if(CD_INDRIVE(SDL_CDStatus(cdrom))) - SDL_CDPlayTracks(cdrom, 1, 0, 0, CD_FPS*15);\fR -.fi -.PP - -.SH "SEE ALSO" -.PP -\fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDStatus\fP\fR, \fI\fBSDL_CD\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDResume.3 --- a/docs/man3/SDL_CDResume.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_CDResume" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDResume \- Resumes a CDROM -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_CDResume\fP\fR(\fBSDL_CD *cdrom\fR); -.SH "DESCRIPTION" -.PP -Resumes play on the given \fBcdrom\fR\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on success, or \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDPause\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDStatus.3 --- a/docs/man3/SDL_CDStatus.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,59 +0,0 @@ -.TH "SDL_CDStatus" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDStatus \- Returns the current status of the given drive\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBCDstatus \fBSDL_CDStatus\fP\fR(\fBSDL_CD *cdrom\fR); -\fB/* Given a status, returns true if there\&'s a disk in the drive */ -#define CD_INDRIVE(status) ((int)status > 0) -.SH "DESCRIPTION" -.PP -This function returns the current status of the given drive\&. Status is described like so: -.PP -.nf -\f(CWtypedef enum { - CD_TRAYEMPTY, - CD_STOPPED, - CD_PLAYING, - CD_PAUSED, - CD_ERROR = -1 -} CDstatus;\fR -.fi -.PP -.PP -If the drive has a CD in it, the table of contents of the CD and current play position of the CD will be stored in the SDL_CD structure\&. -.PP -The macro \fBCD_INDRIVE\fP is provided for convenience, and given a status returns true if there\&'s a disk in the drive\&. -.PP -.RS -\fBNote: -.PP -\fBSDL_CDStatus\fP also updates the \fI\fBSDL_CD\fR\fR structure passed to it\&. -.RE -.SH "EXAMPLE" -.PP -.nf -\f(CWint playTrack(int track) -{ - int playing = 0; - - if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) { - /* clamp to the actual number of tracks on the CD */ - if (track >= cdrom->numtracks) { - track = cdrom->numtracks-1; - } - - if ( SDL_CDPlayTracks(cdrom, track, 0, 1, 0) == 0 ) { - playing = 1; - } - } - return playing; -}\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_CD\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDStop.3 --- a/docs/man3/SDL_CDStop.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_CDStop" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDStop \- Stops a CDROM -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_CDStop\fP\fR(\fBSDL_CD *cdrom\fR); -.SH "DESCRIPTION" -.PP -Stops play on the given \fBcdrom\fR\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on success, or \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CDPlay\fP\fR, -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CDtrack.3 --- a/docs/man3/SDL_CDtrack.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,40 +0,0 @@ -.TH "SDL_CDtrack" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CDtrack \- CD Track Information Structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 id; - Uint8 type; - Uint32 length; - Uint32 offset; -} SDL_CDtrack;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBid\fR -Track number (0-99) -.TP 20 -\fBtype\fR -\fBSDL_AUDIO_TRACK\fP or \fBSDL_DATA_TRACK\fP -.TP 20 -\fBlength\fR -Length, in frames, of this track -.TP 20 -\fBoffset\fR -Frame offset to the beginning of this track -.SH "DESCRIPTION" -.PP -\fBSDL_CDtrack\fR stores data on each track on a CD, its fields should be pretty self explainatory\&. It is a member a the \fI\fBSDL_CD\fR\fR structure\&. -.PP -.RS -\fBNote: -.PP -Frames can be converted to standard timings\&. There are \fBCD_FPS\fP frames per second, so \fBSDL_CDtrack\fR\&.\fBlength\fR/\fBCD_FPS\fP=length_in_seconds\&. -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_CD\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CloseAudio.3 --- a/docs/man3/SDL_CloseAudio.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_CloseAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CloseAudio \- Shuts down audio processing and closes the audio device\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_CloseAudio\fP\fR(\fBvoid\fR) -.SH "DESCRIPTION" -.PP -This function shuts down audio processing and closes the audio device\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_Color.3 --- a/docs/man3/SDL_Color.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,34 +0,0 @@ -.TH "SDL_Color" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_Color \- Format independent color description -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 r; - Uint8 g; - Uint8 b; - Uint8 unused; -} SDL_Color;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBr\fR -Red intensity -.TP 20 -\fBg\fR -Green intensity -.TP 20 -\fBb\fR -Blue intensity -.TP 20 -\fBunused\fR -Unused -.SH "DESCRIPTION" -.PP -\fBSDL_Color\fR describes a color in a format independent way\&. You can convert a \fBSDL_Color\fR to a pixel value for a certain pixel format using \fI\fBSDL_MapRGB\fP\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_SetColors\fP\fR, \fI\fBSDL_Palette\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CondBroadcast.3 --- a/docs/man3/SDL_CondBroadcast.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -.TH "SDL_CondBroadcast" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CondBroadcast \- Restart all threads waiting on a condition variable -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBint \fBSDL_CondBroadcast\fP\fR(\fBSDL_cond *cond\fR); -.SH "DESCRIPTION" -.PP -Restarts all threads that are waiting on the condition variable, \fBcond\fR\&. Returns \fB0\fR on success, or \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CondSignal\fP\fR, \fI\fBSDL_CondWait\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CondSignal.3 --- a/docs/man3/SDL_CondSignal.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -.TH "SDL_CondSignal" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CondSignal \- Restart a thread wait on a condition variable -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBint \fBSDL_CondSignal\fP\fR(\fBSDL_cond *cond\fR); -.SH "DESCRIPTION" -.PP -Restart one of the threads that are waiting on the condition variable, \fBcond\fR\&. Returns \fB0\fR on success of \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CondWait\fP\fR, \fI\fBSDL_CondBroadcast\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CondWait.3 --- a/docs/man3/SDL_CondWait.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -.TH "SDL_CondWait" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CondWait \- Wait on a condition variable -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBint \fBSDL_CondWait\fP\fR(\fBSDL_cond *cond, SDL_mutex *mut\fR); -.SH "DESCRIPTION" -.PP -Wait on the condition variable \fBcond\fR and unlock the provided mutex\&. The mutex must the locked before entering this function\&. Returns \fB0\fR when it is signalled, or \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CondWaitTimeout\fP\fR, \fI\fBSDL_CondSignal\fP\fR, \fI\fBSDL_mutexP\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CondWaitTimeout.3 --- a/docs/man3/SDL_CondWaitTimeout.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -.TH "SDL_CondWaitTimeout" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CondWaitTimeout \- Wait on a condition variable, with timeout -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBint \fBSDL_CondWaitTimeout\fP\fR(\fBSDL_cond *cond, SDL_mutex *mutex, Uint32 ms\fR); -.SH "DESCRIPTION" -.PP -Wait on the condition variable \fBcond\fR for, at most, \fBms\fR milliseconds\&. \fBmut\fR is unlocked so it must be locked when the function is called\&. Returns \fBSDL_MUTEX_TIMEDOUT\fP if the condition is not signalled in the allotted time, \fB0\fR if it was signalled or \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CondWait\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_ConvertAudio.3 --- a/docs/man3/SDL_ConvertAudio.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,95 +0,0 @@ -.TH "SDL_ConvertAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_ConvertAudio \- Convert audio data to a desired audio format\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_ConvertAudio\fP\fR(\fBSDL_AudioCVT *cvt\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_ConvertAudio\fP takes one parameter, \fBcvt\fR, which was previously initilized\&. Initilizing a \fI\fBSDL_AudioCVT\fR\fR is a two step process\&. First of all, the structure must be passed to \fI\fBSDL_BuildAudioCVT\fP\fR along with source and destination format parameters\&. Secondly, the \fBcvt\fR->\fBbuf\fR and \fBcvt\fR->\fBlen\fR fields must be setup\&. \fBcvt\fR->\fBbuf\fR should point to the audio data and \fBcvt\fR->\fBlen\fR should be set to the length of the audio data in bytes\&. Remember, the length of the buffer pointed to by \fBbuf\fR show be \fBlen\fR*\fBlen_mult\fR bytes in length\&. -.PP -Once the \fBSDL_AudioCVT\fRstructure is initilized then we can pass it to \fBSDL_ConvertAudio\fP, which will convert the audio data pointer to by \fBcvt\fR->\fBbuf\fR\&. If \fBSDL_ConvertAudio\fP returned \fB0\fR then the conversion was completed successfully, otherwise \fB-1\fR is returned\&. -.PP -If the conversion completed successfully then the converted audio data can be read from \fBcvt\fR->\fBbuf\fR\&. The amount of valid, converted, audio data in the buffer is equal to \fBcvt\fR->\fBlen\fR*\fBcvt\fR->\fBlen_ratio\fR\&. -.SH "EXAMPLES" -.PP -.nf -\f(CW/* Converting some WAV data to hardware format */ -void my_audio_callback(void *userdata, Uint8 *stream, int len); - -SDL_AudioSpec *desired, *obtained; -SDL_AudioSpec wav_spec; -SDL_AudioCVT wav_cvt; -Uint32 wav_len; -Uint8 *wav_buf; -int ret; - -/* Allocated audio specs */ -desired=(SDL_AudioSpec *)malloc(sizeof(SDL_AudioSpec)); -obtained=(SDL_AudioSpec *)malloc(sizeof(SDL_AudioSpec)); - -/* Set desired format */ -desired->freq=22050; -desired->format=AUDIO_S16LSB; -desired->samples=8192; -desired->callback=my_audio_callback; -desired->userdata=NULL; - -/* Open the audio device */ -if ( SDL_OpenAudio(desired, obtained) < 0 ){ - fprintf(stderr, "Couldn\&'t open audio: %s -", SDL_GetError()); - exit(-1); -} - -free(desired); - -/* Load the test\&.wav */ -if( SDL_LoadWAV("test\&.wav", &wav_spec, &wav_buf, &wav_len) == NULL ){ - fprintf(stderr, "Could not open test\&.wav: %s -", SDL_GetError()); - SDL_CloseAudio(); - free(obtained); - exit(-1); -} - -/* Build AudioCVT */ -ret = SDL_BuildAudioCVT(&wav_cvt, - wav_spec\&.format, wav_spec\&.channels, wav_spec\&.freq, - obtained->format, obtained->channels, obtained->freq); - -/* Check that the convert was built */ -if(ret==-1){ - fprintf(stderr, "Couldn\&'t build converter! -"); - SDL_CloseAudio(); - free(obtained); - SDL_FreeWAV(wav_buf); -} - -/* Setup for conversion */ -wav_cvt\&.buf=(Uint8 *)malloc(wav_len*wav_cvt\&.len_mult); -wav_cvt\&.len=wav_len; -memcpy(wav_cvt\&.buf, wav_buf, wav_len); - -/* We can delete to original WAV data now */ -SDL_FreeWAV(wav_buf); - -/* And now we\&'re ready to convert */ -SDL_ConvertAudio(&wav_cvt); - -/* do whatever */ -\&. -\&. -\&. -\&. - -\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_BuildAudioCVT\fP\fR, \fI\fBSDL_AudioCVT\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_ConvertSurface.3 --- a/docs/man3/SDL_ConvertSurface.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,24 +0,0 @@ -.TH "SDL_ConvertSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_ConvertSurface \- Converts a surface to the same format as another surface\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL/SDL\&.h" -.sp -\fBSDL_Surface *\fBSDL_ConvertSurface\fP\fR(\fBSDL_Surface *src, SDL_PixelFormat *fmt, Uint32 flags\fR); -.SH "DESCRIPTION" -.PP -Creates a new surface of the specified format, and then copies and maps the given surface to it\&. If this function fails, it returns \fBNULL\fP\&. -.PP -The \fBflags\fR parameter is passed to \fI\fBSDL_CreateRGBSurface\fP\fR and has those semantics\&. -.PP -This function is used internally by \fI\fBSDL_DisplayFormat\fP\fR\&. -.PP -This function can only be called after SDL_Init\&. -.SH "RETURN VALUE" -.PP -Returns either a pointer to the new surface, or \fBNULL\fP on error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_DisplayFormat\fP\fR, \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CreateCond.3 --- a/docs/man3/SDL_CreateCond.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,31 +0,0 @@ -.TH "SDL_CreateCond" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CreateCond \- Create a condition variable -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBSDL_cond *\fBSDL_CreateCond\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -Creates a condition variable\&. -.SH "EXAMPLES" -.PP -.nf -\f(CWSDL_cond *cond; - -cond=SDL_CreateCond(); -\&. -\&. -/* Do stuff */ - -\&. -\&. -SDL_DestroyCond(cond);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_DestroyCond\fP\fR, \fI\fBSDL_CondWait\fP\fR, \fI\fBSDL_CondSignal\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CreateCursor.3 --- a/docs/man3/SDL_CreateCursor.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,120 +0,0 @@ -.TH "SDL_CreateCursor" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CreateCursor \- Creates a new mouse cursor\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Cursor *\fBSDL_CreateCursor\fP\fR(\fBUint8 *data, Uint8 *mask, int w, int h, int hot_x, int hot_y\fR); -.SH "DESCRIPTION" -.PP -Create a cursor using the specified \fBdata\fR and \fBmask\fR (in MSB format)\&. The cursor width must be a multiple of 8 bits\&. -.PP -The cursor is created in black and white according to the following: -.TP 20 -\fBData / Mask\fR -\fBResulting pixel on screen\fR -.TP 20 -0 / 1 -White -.TP 20 -1 / 1 -Black -.TP 20 -0 / 0 -Transparent -.TP 20 -1 / 0 -Inverted color if possible, black if not\&. -.PP -Cursors created with this function must be freed with \fISDL_FreeCursor\fR\&. -.SH "EXAMPLE" -.PP -.nf -\f(CW/* Stolen from the mailing list */ -/* Creates a new mouse cursor from an XPM */ - - -/* XPM */ -static const char *arrow[] = { - /* width height num_colors chars_per_pixel */ - " 32 32 3 1", - /* colors */ - "X c #000000", - "\&. c #ffffff", - " c None", - /* pixels */ - "X ", - "XX ", - "X\&.X ", - "X\&.\&.X ", - "X\&.\&.\&.X ", - "X\&.\&.\&.\&.X ", - "X\&.\&.\&.\&.\&.X ", - "X\&.\&.\&.\&.\&.\&.X ", - "X\&.\&.\&.\&.\&.\&.\&.X ", - "X\&.\&.\&.\&.\&.\&.\&.\&.X ", - "X\&.\&.\&.\&.\&.XXXXX ", - "X\&.\&.X\&.\&.X ", - "X\&.X X\&.\&.X ", - "XX X\&.\&.X ", - "X X\&.\&.X ", - " X\&.\&.X ", - " X\&.\&.X ", - " X\&.\&.X ", - " XX ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - " ", - "0,0" -}; - -static SDL_Cursor *init_system_cursor(const char *image[]) -{ - int i, row, col; - Uint8 data[4*32]; - Uint8 mask[4*32]; - int hot_x, hot_y; - - i = -1; - for ( row=0; row<32; ++row ) { - for ( col=0; col<32; ++col ) { - if ( col % 8 ) { - data[i] <<= 1; - mask[i] <<= 1; - } else { - ++i; - data[i] = mask[i] = 0; - } - switch (image[4+row][col]) { - case \&'X\&': - data[i] |= 0x01; - k[i] |= 0x01; - break; - case \&'\&.\&': - mask[i] |= 0x01; - break; - case \&' \&': - break; - } - } - } - sscanf(image[4+row], "%d,%d", &hot_x, &hot_y); - return SDL_CreateCursor(data, mask, 32, 32, hot_x, hot_y); -}\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_FreeCursor\fP\fR, \fI\fBSDL_SetCursor\fP\fR, \fI\fBSDL_ShowCursor\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CreateMutex.3 --- a/docs/man3/SDL_CreateMutex.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,43 +0,0 @@ -.TH "SDL_CreateMutex" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CreateMutex \- Create a mutex -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBSDL_mutex *\fBSDL_CreateMutex\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -Create a new, unlocked mutex\&. -.SH "EXAMPLES" -.PP -.nf -\f(CWSDL_mutex *mut; - -mut=SDL_CreateMutex(); -\&. -\&. -if(SDL_mutexP(mut)==-1){ - fprintf(stderr, "Couldn\&'t lock mutex -"); - exit(-1); -} -\&. -/* Do stuff while mutex is locked */ -\&. -\&. -if(SDL_mutexV(mut)==-1){ - fprintf(stderr, "Couldn\&'t unlock mutex -"); - exit(-1); -} - -SDL_DestroyMutex(mut); -\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_mutexP\fP\fR, \fI\fBSDL_mutexV\fP\fR, \fI\fBSDL_DestroyMutex\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CreateRGBSurface.3 --- a/docs/man3/SDL_CreateRGBSurface.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,69 +0,0 @@ -.TH "SDL_CreateRGBSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CreateRGBSurface \- Create an empty SDL_Surface -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Surface *\fBSDL_CreateRGBSurface\fP\fR(\fBUint32 flags, int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask\fR); -.SH "DESCRIPTION" -.PP -Allocate an empty surface (must be called after \fISDL_SetVideoMode\fR) -.PP -If \fBdepth\fR is 8 bits an empty palette is allocated for the surface, otherwise a \&'packed-pixel\&' \fI\fBSDL_PixelFormat\fR\fR is created using the \fB[RGBA]mask\fR\&'s provided (see \fI\fBSDL_PixelFormat\fR\fR)\&. The \fBflags\fR specifies the type of surface that should be created, it is an OR\&'d combination of the following possible values\&. -.TP 20 -\fBSDL_SWSURFACE\fP -SDL will create the surface in system memory\&. This improves the performance of pixel level access, however you may not be able to take advantage of some types of hardware blitting\&. -.TP 20 -\fBSDL_HWSURFACE\fP -SDL will attempt to create the surface in video memory\&. This will allow SDL to take advantage of Video->Video blits (which are often accelerated)\&. -.TP 20 -\fBSDL_SRCCOLORKEY\fP -This flag turns on colourkeying for blits from this surface\&. If \fBSDL_HWSURFACE\fP is also specified and colourkeyed blits are hardware-accelerated, then SDL will attempt to place the surface in video memory\&. Use \fI\fBSDL_SetColorKey\fP\fR to set or clear this flag after surface creation\&. -.TP 20 -\fBSDL_SRCALPHA\fP -This flag turns on alpha-blending for blits from this surface\&. If \fBSDL_HWSURFACE\fP is also specified and alpha-blending blits are hardware-accelerated, then the surface will be placed in video memory if possible\&. Use \fI\fBSDL_SetAlpha\fP\fR to set or clear this flag after surface creation\&. -.PP -.RS -\fBNote: -.PP -If an alpha-channel is specified (that is, if \fBAmask\fR is nonzero), then the \fBSDL_SRCALPHA\fP flag is automatically set\&. You may remove this flag by calling \fI\fBSDL_SetAlpha\fP\fR after surface creation\&. -.RE -.SH "RETURN VALUE" -.PP -Returns the created surface, or \fBNULL\fR upon error\&. -.SH "EXAMPLE" -.PP -.nf -\f(CW /* Create a 32-bit surface with the bytes of each pixel in R,G,B,A order, - as expected by OpenGL for textures */ - SDL_Surface *surface; - Uint32 rmask, gmask, bmask, amask; - - /* SDL interprets each pixel as a 32-bit number, so our masks must depend - on the endianness (byte order) of the machine */ -#if SDL_BYTEORDER == SDL_BIG_ENDIAN - rmask = 0xff000000; - gmask = 0x00ff0000; - bmask = 0x0000ff00; - amask = 0x000000ff; -#else - rmask = 0x000000ff; - gmask = 0x0000ff00; - bmask = 0x00ff0000; - amask = 0xff000000; -#endif - - surface = SDL_CreateRGBSurface(SDL_SWSURFACE, width, height, 32, - rmask, gmask, bmask, amask); - if(surface == NULL) { - fprintf(stderr, "CreateRGBSurface failed: %s -", SDL_GetError()); - exit(1); - }\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateRGBSurfaceFrom\fP\fR, \fI\fBSDL_FreeSurface\fP\fR, \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_Surface\fR\fR \fI\fBSDL_SetAlpha\fP\fR \fI\fBSDL_SetColorKey\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CreateRGBSurfaceFrom.3 --- a/docs/man3/SDL_CreateRGBSurfaceFrom.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -.TH "SDL_CreateRGBSurfaceFrom" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CreateRGBSurfaceFrom \- Create an SDL_Surface from pixel data -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Surface *\fBSDL_CreateRGBSurfaceFrom\fP\fR(\fBvoid *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask\fR); -.SH "DESCRIPTION" -.PP -Creates an SDL_Surface from the provided pixel data\&. -.PP -The data stored in \fBpixels\fR is assumed to be of the \fBdepth\fR specified in the parameter list\&. The pixel data is not copied into the \fBSDL_Surface\fR structure so it should not be freed until the surface has been freed with a called to \fISDL_FreeSurface\fR\&. \fBpitch\fR is the length of each scanline in bytes\&. -.PP -See \fI\fBSDL_CreateRGBSurface\fP\fR for a more detailed description of the other parameters\&. -.SH "RETURN VALUE" -.PP -Returns the created surface, or \fBNULL\fR upon error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_FreeSurface\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CreateSemaphore.3 --- a/docs/man3/SDL_CreateSemaphore.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ -.TH "SDL_CreateSemaphore" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CreateSemaphore \- Creates a new semaphore and assigns an initial value to it\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBSDL_sem *\fBSDL_CreateSemaphore\fP\fR(\fBUint32 initial_value\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_CreateSemaphore()\fP creates a new semaphore and initializes it with the value \fBinitial_value\fR\&. Each locking operation on the semaphore by \fISDL_SemWait\fR, \fISDL_SemTryWait\fR or \fISDL_SemWaitTimeout\fR will atomically decrement the semaphore value\&. The locking operation will be blocked if the semaphore value is not positive (greater than zero)\&. Each unlock operation by \fISDL_SemPost\fR will atomically increment the semaphore value\&. -.SH "RETURN VALUE" -.PP -Returns a pointer to an initialized semaphore or \fBNULL\fR if there was an error\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWSDL_sem *my_sem; - -my_sem = SDL_CreateSemaphore(INITIAL_SEM_VALUE); - -if (my_sem == NULL) { - return CREATE_SEM_FAILED; -}\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CreateThread.3 --- a/docs/man3/SDL_CreateThread.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -.TH "SDL_CreateThread" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CreateThread \- Creates a new thread of execution that shares its parent\&'s properties\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBSDL_Thread *\fBSDL_CreateThread\fP\fR(\fBint (*fn)(void *), void *data\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_CreateThread\fP creates a new thread of execution that shares all of its parent\&'s global memory, signal handlers, file descriptors, etc, and runs the function \fBfn\fR passed the void pointer \fBdata\fR The thread quits when this function returns\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_KillThread\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_CreateYUVOverlay.3 --- a/docs/man3/SDL_CreateYUVOverlay.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -.TH "SDL_CreateYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_CreateYUVOverlay \- Create a YUV video overlay -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Overlay *\fBSDL_CreateYUVOverlay\fP\fR(\fBint width, int height, Uint32 format, SDL_Surface *display\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_CreateYUVOverlay\fP creates a YUV overlay of the specified \fBwidth\fR, \fBheight\fR and \fBformat\fR (see \fI\fBSDL_Overlay\fR\fR for a list of available formats), for the provided \fBdisplay\fR\&. A \fI\fBSDL_Overlay\fR\fR structure is returned\&. -.PP -The term \&'overlay\&' is a misnomer since, unless the overlay is created in hardware, the contents for the display surface underneath the area where the overlay is shown will be overwritten when the overlay is displayed\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Overlay\fR\fR, \fI\fBSDL_DisplayYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_Delay.3 --- a/docs/man3/SDL_Delay.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,21 +0,0 @@ -.TH "SDL_Delay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_Delay \- Wait a specified number of milliseconds before returning\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_Delay\fP\fR(\fBUint32 ms\fR); -.SH "DESCRIPTION" -.PP -Wait a specified number of milliseconds before returning\&. \fBSDL_Delay\fP will wait at \fIleast\fP the specified time, but possible longer due to OS scheduling\&. -.PP -.RS -\fBNote: -.PP -Count on a delay granularity of \fIat least\fP 10 ms\&. Some platforms have shorter clock ticks but this is the most common\&. -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_AddTimer\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_DestroyCond.3 --- a/docs/man3/SDL_DestroyCond.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -.TH "SDL_DestroyCond" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_DestroyCond \- Destroy a condition variable -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBvoid \fBSDL_DestroyCond\fP\fR(\fBSDL_cond *cond\fR); -.SH "DESCRIPTION" -.PP -Destroys a condition variable\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateCond\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_DestroyMutex.3 --- a/docs/man3/SDL_DestroyMutex.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -.TH "SDL_DestroyMutex" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_DestroyMutex \- Destroy a mutex -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBvoid \fBSDL_DestroyMutex\fP\fR(\fBSDL_mutex *mutex\fR); -.SH "DESCRIPTION" -.PP -Destroy a previously \fIcreated\fR mutex\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateMutex\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_DestroySemaphore.3 --- a/docs/man3/SDL_DestroySemaphore.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,26 +0,0 @@ -.TH "SDL_DestroySemaphore" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_DestroySemaphore \- Destroys a semaphore that was created by \fISDL_CreateSemaphore\fR\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBvoid \fBSDL_DestroySemaphore\fP\fR(\fBSDL_sem *sem\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_DestroySemaphore\fP destroys the semaphore pointed to by \fBsem\fR that was created by \fI\fBSDL_CreateSemaphore\fP\fR\&. It is not safe to destroy a semaphore if there are threads currently blocked waiting on it\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWif (my_sem != NULL) { - SDL_DestroySemaphore(my_sem); - my_sem = NULL; -}\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_DisplayFormat.3 --- a/docs/man3/SDL_DisplayFormat.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -.TH "SDL_DisplayFormat" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_DisplayFormat \- Convert a surface to the display format -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Surface *\fBSDL_DisplayFormat\fP\fR(\fBSDL_Surface *surface\fR); -.SH "DESCRIPTION" -.PP -This function takes a surface and copies it to a new surface of the pixel format and colors of the video framebuffer, suitable for fast blitting onto the display surface\&. It calls \fISDL_ConvertSurface\fR -.PP -If you want to take advantage of hardware colorkey or alpha blit acceleration, you should set the colorkey and alpha value before calling this function\&. -.PP -If you want an alpha channel, see \fISDL_DisplayFormatAlpha\fR\&. -.SH "RETURN VALUE" -.PP -If the conversion fails or runs out of memory, it returns \fBNULL\fR -.SH "SEE ALSO" -.PP -\fI\fBSDL_ConvertSurface\fP\fR, \fI\fBSDL_DisplayFormatAlpha\fP\fR \fI\fBSDL_SetAlpha\fP\fR, \fI\fBSDL_SetColorKey\fP\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_DisplayFormatAlpha.3 --- a/docs/man3/SDL_DisplayFormatAlpha.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -.TH "SDL_DisplayFormatAlpha" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_DisplayFormatAlpha \- Convert a surface to the display format -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Surface *\fBSDL_DisplayFormatAlpha\fP\fR(\fBSDL_Surface *surface\fR); -.SH "DESCRIPTION" -.PP -This function takes a surface and copies it to a new surface of the pixel format and colors of the video framebuffer plus an alpha channel, suitable for fast blitting onto the display surface\&. It calls \fISDL_ConvertSurface\fR -.PP -If you want to take advantage of hardware colorkey or alpha blit acceleration, you should set the colorkey and alpha value before calling this function\&. -.PP -This function can be used to convert a colourkey to an alpha channel, if the \fBSDL_SRCCOLORKEY\fP flag is set on the surface\&. The generated surface will then be transparent (alpha=0) where the pixels match the colourkey, and opaque (alpha=255) elsewhere\&. -.SH "RETURN VALUE" -.PP -If the conversion fails or runs out of memory, it returns \fBNULL\fR -.SH "SEE ALSO" -.PP -\fISDL_ConvertSurface\fR, \fISDL_SetAlpha\fR, \fISDL_SetColorKey\fR, \fISDL_DisplayFormat\fR, \fISDL_Surface\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_DisplayYUVOverlay.3 --- a/docs/man3/SDL_DisplayYUVOverlay.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_DisplayYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_DisplayYUVOverlay \- Blit the overlay to the display -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_DisplayYUVOverlay\fP\fR(\fBSDL_Overlay *overlay, SDL_Rect *dstrect\fR); -.SH "DESCRIPTION" -.PP -Blit the \fBoverlay\fR to the surface specified when it was \fIcreated\fR\&. The \fI\fBSDL_Rect\fR\fR structure, \fBdstrect\fR, specifies the position and size of the destination\&. If the \fBdstrect\fR is a larger or smaller than the overlay then the overlay will be scaled, this is optimized for 2x scaling\&. -.SH "RETURN VALUES" -.PP -Returns 0 on success -.SH "SEE ALSO" -.PP -\fI\fBSDL_Overlay\fR\fR, \fI\fBSDL_CreateYUVOverlay\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_EnableKeyRepeat.3 --- a/docs/man3/SDL_EnableKeyRepeat.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -.TH "SDL_EnableKeyRepeat" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_EnableKeyRepeat \- Set keyboard repeat rate\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_EnableKeyRepeat\fP\fR(\fBint delay, int interval\fR); -.SH "DESCRIPTION" -.PP -Enables or disables the keyboard repeat rate\&. \fBdelay\fR specifies how long the key must be pressed before it begins repeating, it then repeats at the speed specified by \fBinterval\fR\&. Both \fBdelay\fR and \fBinterval\fR are expressed in milliseconds\&. -.PP -Setting \fBdelay\fR to 0 disables key repeating completely\&. Good default values are \fBSDL_DEFAULT_REPEAT_DELAY\fP and \fISDL_DEFAULT_REPEAT_INTERVAL\fP\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on success and \fB-1\fR on failure\&. -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_EnableUNICODE.3 --- a/docs/man3/SDL_EnableUNICODE.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,24 +0,0 @@ -.TH "SDL_EnableUNICODE" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_EnableUNICODE \- Enable UNICODE translation -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_EnableUNICODE\fP\fR(\fBint enable\fR); -.SH "DESCRIPTION" -.PP -Enables/Disables Unicode keyboard translation\&. -.PP -To obtain the character codes corresponding to received keyboard events, Unicode translation must first be turned on using this function\&. The translation incurs a slight overhead for each keyboard event and is therefore disabled by default\&. For each subsequently received key down event, the \fBunicode\fR member of the \fI\fBSDL_keysym\fR\fR structure will then contain the corresponding character code, or zero for keysyms that do not correspond to any character code\&. -.PP -A value of 1 for \fBenable\fR enables Unicode translation; 0 disables it, and -1 leaves it unchanged (useful for querying the current translation mode)\&. -.PP -Note that only key press events will be translated, not release events\&. -.SH "RETURN VALUE" -.PP -Returns the previous translation mode (\fB0\fR or \fB1\fR)\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_keysym\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_Event.3 --- a/docs/man3/SDL_Event.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,182 +0,0 @@ -.TH "SDL_Event" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_Event \- General event structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef union{ - Uint8 type; - SDL_ActiveEvent active; - SDL_KeyboardEvent key; - SDL_MouseMotionEvent motion; - SDL_MouseButtonEvent button; - SDL_JoyAxisEvent jaxis; - SDL_JoyBallEvent jball; - SDL_JoyHatEvent jhat; - SDL_JoyButtonEvent jbutton; - SDL_ResizeEvent resize; - SDL_ExposeEvent expose; - SDL_QuitEvent quit; - SDL_UserEvent user; - SDL_SysWMEvent syswm; -} SDL_Event;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -The type of event -.TP 20 -\fBactive\fR -\fIActivation event\fR -.TP 20 -\fBkey\fR -\fIKeyboard event\fR -.TP 20 -\fBmotion\fR -\fIMouse motion event\fR -.TP 20 -\fBbutton\fR -\fIMouse button event\fR -.TP 20 -\fBjaxis\fR -\fIJoystick axis motion event\fR -.TP 20 -\fBjball\fR -\fIJoystick trackball motion event\fR -.TP 20 -\fBjhat\fR -\fIJoystick hat motion event\fR -.TP 20 -\fBjbutton\fR -\fIJoystick button event\fR -.TP 20 -\fBresize\fR -\fIApplication window resize event\fR -.TP 20 -\fBexpose\fR -\fIApplication window expose event\fR -.TP 20 -\fBquit\fR -\fIApplication quit request event\fR -.TP 20 -\fBuser\fR -\fIUser defined event\fR -.TP 20 -\fBsyswm\fR -\fIUndefined window manager event\fR -.SH "DESCRIPTION" -.PP -The \fBSDL_Event\fR union is the core to all event handling is SDL, its probably the most important structure after \fBSDL_Surface\fR\&. \fBSDL_Event\fR is a union of all event structures used in SDL, using it is a simple matter of knowing which union member relates to which event \fBtype\fR\&. -.PP -.TP 20 -\fBEvent \fBtype\fR\fR -\fBEvent Structure\fR -.TP 20 -\fBSDL_ACTIVEEVENT\fP -\fI\fBSDL_ActiveEvent\fR\fR -.TP 20 -\fBSDL_KEYDOWN/UP\fP -\fI\fBSDL_KeyboardEvent\fR\fR -.TP 20 -\fBSDL_MOUSEMOTION\fP -\fI\fBSDL_MouseMotionEvent\fR\fR -.TP 20 -\fBSDL_MOUSEBUTTONDOWN/UP\fP -\fI\fBSDL_MouseButtonEvent\fR\fR -.TP 20 -\fBSDL_JOYAXISMOTION\fP -\fI\fBSDL_JoyAxisEvent\fR\fR -.TP 20 -\fBSDL_JOYBALLMOTION\fP -\fI\fBSDL_JoyBallEvent\fR\fR -.TP 20 -\fBSDL_JOYHATMOTION\fP -\fI\fBSDL_JoyHatEvent\fR\fR -.TP 20 -\fBSDL_JOYBUTTONDOWN/UP\fP -\fI\fBSDL_JoyButtonEvent\fR\fR -.TP 20 -\fBSDL_QUIT\fP -\fI\fBSDL_QuitEvent\fR\fR -.TP 20 -\fBSDL_SYSWMEVENT\fP -\fI\fBSDL_SysWMEvent\fR\fR -.TP 20 -\fBSDL_VIDEORESIZE\fP -\fI\fBSDL_ResizeEvent\fR\fR -.TP 20 -\fBSDL_VIDEOEXPOSE\fP -\fI\fBSDL_ExposeEvent\fR\fR -.TP 20 -\fBSDL_USEREVENT\fP -\fI\fBSDL_UserEvent\fR\fR -.SH "USE" -.PP -The \fBSDL_Event\fR structure has two uses -.IP " \(bu" 6 -Reading events on the event queue -.IP " \(bu" 6 -Placing events on the event queue -.PP -Reading events from the event queue is done with either \fI\fBSDL_PollEvent\fP\fR or \fI\fBSDL_PeepEvents\fP\fR\&. We\&'ll use \fBSDL_PollEvent\fP and step through an example\&. -.PP -First off, we create an empty \fBSDL_Event\fR structure\&. -.PP -.nf -\f(CWSDL_Event test_event;\fR -.fi -.PP - \fBSDL_PollEvent\fP removes the next event from the event queue, if there are no events on the queue it returns \fB0\fR otherwise it returns \fB1\fR\&. We use a \fBwhile\fP loop to process each event in turn\&. -.PP -.nf -\f(CWwhile(SDL_PollEvent(&test_event)) {\fR -.fi -.PP - The \fBSDL_PollEvent\fP function take a pointer to an \fBSDL_Event\fR structure that is to be filled with event information\&. We know that if \fBSDL_PollEvent\fP removes an event from the queue then the event information will be placed in our \fBtest_event\fR structure, but we also know that the \fItype\fP of event will be placed in the \fBtype\fR member of \fBtest_event\fR\&. So to handle each event \fBtype\fR seperately we use a \fBswitch\fP statement\&. -.PP -.nf -\f(CW switch(test_event\&.type) {\fR -.fi -.PP - We need to know what kind of events we\&'re looking for \fIand\fP the event \fBtype\fR\&'s of those events\&. So lets assume we want to detect where the user is moving the mouse pointer within our application\&. We look through our event types and notice that \fBSDL_MOUSEMOTION\fP is, more than likely, the event we\&'re looking for\&. A little \fImore\fR research tells use that \fBSDL_MOUSEMOTION\fP events are handled within the \fI\fBSDL_MouseMotionEvent\fR\fR structure which is the \fBmotion\fR member of \fBSDL_Event\fR\&. We can check for the \fBSDL_MOUSEMOTION\fP event \fBtype\fR within our \fBswitch\fP statement like so: -.PP -.nf -\f(CW case SDL_MOUSEMOTION:\fR -.fi -.PP - All we need do now is read the information out of the \fBmotion\fR member of \fBtest_event\fR\&. -.PP -.nf -\f(CW printf("We got a motion event\&. -"); - printf("Current mouse position is: (%d, %d) -", test_event\&.motion\&.x, test_event\&.motion\&.y); - break; - default: - printf("Unhandled Event! -"); - break; - } -} -printf("Event queue empty\&. -");\fR -.fi -.PP -.PP -It is also possible to push events onto the event queue and so use it as a two-way communication path\&. Both \fI\fBSDL_PushEvent\fP\fR and \fI\fBSDL_PeepEvents\fP\fR allow you to place events onto the event queue\&. This is usually used to place a \fBSDL_USEREVENT\fP on the event queue, however you could use it to post fake input events if you wished\&. Creating your own events is a simple matter of choosing the event type you want, setting the \fBtype\fR member and filling the appropriate member structure with information\&. -.PP -.nf -\f(CWSDL_Event user_event; - -user_event\&.type=SDL_USEREVENT; -user_event\&.user\&.code=2; -user_event\&.user\&.data1=NULL; -user_event\&.user\&.data2=NULL; -SDL_PushEvent(&user_event);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PushEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_EventState.3 --- a/docs/man3/SDL_EventState.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,23 +0,0 @@ -.TH "SDL_EventState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_EventState \- This function allows you to set the state of processing certain events\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint8 \fBSDL_EventState\fP\fR(\fBUint8 type, int state\fR); -.SH "DESCRIPTION" -.PP -This function allows you to set the state of processing certain event \fBtype\fR\&'s\&. -.PP -If \fBstate\fR is set to \fBSDL_IGNORE\fP, that event \fBtype\fR will be automatically dropped from the event queue and will not be filtered\&. -.PP -If \fBstate\fR is set to \fBSDL_ENABLE\fP, that event \fBtype\fR will be processed normally\&. -.PP -If \fBstate\fR is set to \fBSDL_QUERY\fP, \fBSDL_EventState\fP will return the current processing state of the specified event \fBtype\fR\&. -.PP -A list of event \fBtype\fR\&'s can be found in the \fI\fBSDL_Event\fR\fR section\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_ExposeEvent.3 --- a/docs/man3/SDL_ExposeEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,24 +0,0 @@ -.TH "SDL_ExposeEvent" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_ExposeEvent \- Quit requested event -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type -} SDL_ExposeEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_VIDEOEXPOSE\fP -.SH "DESCRIPTION" -.PP -\fBSDL_ExposeEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used whan an event of type \fBSDL_VIDEOEXPOSE\fP is reported\&. -.PP -A VIDEOEXPOSE event is triggered when the screen has been modified outside of the application, usually by the window manager and needs to be redrawn\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetEventFilter\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_FillRect.3 --- a/docs/man3/SDL_FillRect.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -.TH "SDL_FillRect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_FillRect \- This function performs a fast fill of the given rectangle with some color -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_FillRect\fP\fR(\fBSDL_Surface *dst, SDL_Rect *dstrect, Uint32 color\fR); -.SH "DESCRIPTION" -.PP -This function performs a fast fill of the given rectangle with \fBcolor\fR\&. If \fBdstrect\fR is \fBNULL\fP, the whole surface will be filled with \fBcolor\fR\&. -.PP -The color should be a pixel of the format used by the surface, and can be generated by the \fISDL_MapRGB\fR or \fISDL_MapRGBA\fR functions\&. If the color value contains an alpha value then the destination is simply "filled" with that alpha information, no blending takes place\&. -.PP -If there is a clip rectangle set on the destination (set via \fISDL_SetClipRect\fR) then this function will clip based on the intersection of the clip rectangle and the \fBdstrect\fR rectangle and the dstrect rectangle will be modified to represent the area actually filled\&. -.SH "RETURN VALUE" -.PP -This function returns \fB0\fR on success, or \fB-1\fR on error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Rect\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_Flip.3 --- a/docs/man3/SDL_Flip.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,20 +0,0 @@ -.TH "SDL_Flip" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_Flip \- Swaps screen buffers -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_Flip\fP\fR(\fBSDL_Surface *screen\fR); -.SH "DESCRIPTION" -.PP -On hardware that supports double-buffering, this function sets up a flip and returns\&. The hardware will wait for vertical retrace, and then swap video buffers before the next video surface blit or lock will return\&. On hardware that doesn\&'t support double-buffering, this is equivalent to calling \fISDL_UpdateRect\fR\fB(screen, 0, 0, 0, 0)\fR -.PP -The \fBSDL_DOUBLEBUF\fP flag must have been passed to \fISDL_SetVideoMode\fR, when setting the video mode for this function to perform hardware flipping\&. -.SH "RETURN VALUE" -.PP -This function returns \fB0\fR if successful, or \fB-1\fR if there was an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_FreeCursor.3 --- a/docs/man3/SDL_FreeCursor.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_FreeCursor" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_FreeCursor \- Frees a cursor created with SDL_CreateCursor\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_FreeCursor\fP\fR(\fBSDL_Cursor *cursor\fR); -.SH "DESCRIPTION" -.PP -Frees a \fBSDL_Cursor\fR that was created using \fISDL_CreateCursor\fR\&. -.SH "SEE ALSO" -.PP -\fISDL_CreateCursor\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_FreeSurface.3 --- a/docs/man3/SDL_FreeSurface.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_FreeSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_FreeSurface \- Frees (deletes) a SDL_Surface -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_FreeSurface\fP\fR(\fBSDL_Surface *surface\fR); -.SH "DESCRIPTION" -.PP -Frees the resources used by a previously created \fBSDL_Surface\fR\&. If the surface was created using \fISDL_CreateRGBSurfaceFrom\fR then the pixel data is not freed\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateRGBSurface\fP\fR \fI\fBSDL_CreateRGBSurfaceFrom\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_FreeWAV.3 --- a/docs/man3/SDL_FreeWAV.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_FreeWAV" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_FreeWAV \- Frees previously opened WAV data -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_FreeWAV\fP\fR(\fBUint8 *audio_buf\fR); -.SH "DESCRIPTION" -.PP -After a WAVE file has been opened with \fI\fBSDL_LoadWAV\fP\fR its data can eventually be freed with \fBSDL_FreeWAV\fP\&. \fBaudio_buf\fR is a pointer to the buffer created by \fBSDL_LoadWAV\fP\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_LoadWAV\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_FreeYUVOverlay.3 --- a/docs/man3/SDL_FreeYUVOverlay.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_FreeYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_FreeYUVOverlay \- Free a YUV video overlay -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_FreeYUVOverlay\fP\fR(\fBSDL_Overlay *overlay\fR); -.SH "DESCRIPTION" -.PP -Frees and \fI\fBoverlay\fR\fR created by \fI\fBSDL_CreateYUVOverlay\fP\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Overlay\fR\fR, \fI\fBSDL_DisplayYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GL_GetAttribute.3 --- a/docs/man3/SDL_GL_GetAttribute.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_GL_GetAttribute" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GL_GetAttribute \- Get the value of a special SDL/OpenGL attribute -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_GL_GetAttribute\fP\fR(\fBSDLGLattr attr, int *value\fR); -.SH "DESCRIPTION" -.PP -Places the value of the SDL/OpenGL \fIattribute\fR \fBattr\fR into \fBvalue\fR\&. This is useful after a call to \fI\fBSDL_SetVideoMode\fP\fR to check whether your attributes have been \fIset\fR as you expected\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on success, or \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_GL_SetAttribute\fP\fR, \fIGL Attributes\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GL_GetProcAddress.3 --- a/docs/man3/SDL_GL_GetProcAddress.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,48 +0,0 @@ -.TH "SDL_GL_GetProcAddress" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GL_GetProcAddress \- Get the address of a GL function -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid *\fBSDL_GL_GetProcAddress\fP\fR(\fBconst char* proc\fR); -.SH "DESCRIPTION" -.PP -Returns the address of the GL function \fBproc\fR, or \fBNULL\fR if the function is not found\&. If the GL library is loaded at runtime, with \fI\fBSDL_GL_LoadLibrary\fP\fR, then \fIall\fP GL functions must be retrieved this way\&. Usually this is used to retrieve function pointers to OpenGL extensions\&. -.SH "EXAMPLE" -.PP -.nf -\f(CWtypedef void (*GL_ActiveTextureARB_Func)(unsigned int); -GL_ActiveTextureARB_Func glActiveTextureARB_ptr = 0; -int has_multitexture=1; -\&. -\&. -\&. -/* Get function pointer */ -glActiveTextureARB_ptr=(GL_ActiveTextureARB_Func) SDL_GL_GetProcAddress("glActiveTextureARB"); - -/* Check for a valid function ptr */ -if(!glActiveTextureARB_ptr){ - fprintf(stderr, "Multitexture Extensions not present\&. -"); - has_multitexture=0; -} -\&. -\&. -\&. -\&. -if(has_multitexture){ - glActiveTextureARB_ptr(GL_TEXTURE0_ARB); - \&. - \&. -} -else{ - \&. - \&. -}\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_GL_LoadLibrary\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GL_LoadLibrary.3 --- a/docs/man3/SDL_GL_LoadLibrary.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_GL_LoadLibrary" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GL_LoadLibrary \- Specify an OpenGL library -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_GL_LoadLibrary\fP\fR(\fBconst char *path\fR); -.SH "DESCRIPTION" -.PP -If you wish, you may load the OpenGL library at runtime, this must be done before \fI\fBSDL_SetVideoMode\fP\fR is called\&. The \fBpath\fR of the GL library is passed to \fBSDL_GL_LoadLibrary\fP and it returns \fB0\fR on success, or \fB-1\fR on an error\&. You must then use \fI\fBSDL_GL_GetProcAddress\fP\fR to retrieve function pointers to GL functions\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_GL_GetProcAddress\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GL_SetAttribute.3 --- a/docs/man3/SDL_GL_SetAttribute.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,40 +0,0 @@ -.TH "SDL_GL_SetAttribute" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GL_SetAttribute \- Set a special SDL/OpenGL attribute -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_GL_SetAttribute\fP\fR(\fBSDL_GLattr attr, int value\fR); -.SH "DESCRIPTION" -.PP -Sets the OpenGL \fIattribute\fR \fBattr\fR to \fBvalue\fR\&. The attributes you set don\&'t take effect until after a call to \fI\fBSDL_SetVideoMode\fP\fR\&. You should use \fI\fBSDL_GL_GetAttribute\fP\fR to check the values after a \fBSDL_SetVideoMode\fP call\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on success, or \fB-1\fR on error\&. -.SH "EXAMPLE" -.PP -.nf -\f(CWSDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 ); -SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 ); -SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 ); -SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 ); -SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 ); -if ( (screen=SDL_SetVideoMode( 640, 480, 16, SDL_OPENGL )) == NULL ) { - fprintf(stderr, "Couldn\&'t set GL mode: %s -", SDL_GetError()); - SDL_Quit(); - return; -}\fR -.fi -.PP -.PP -.RS -\fBNote: -.PP -The \fBSDL_DOUBLEBUF\fP flag is not required to enable double buffering when setting an OpenGL video mode\&. Double buffering is enabled or disabled using the SDL_GL_DOUBLEBUFFER attribute\&. -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_GL_GetAttribute\fP\fR, \fIGL Attributes\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GL_SwapBuffers.3 --- a/docs/man3/SDL_GL_SwapBuffers.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_GL_SwapBuffers" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GL_SwapBuffers \- Swap OpenGL framebuffers/Update Display -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_GL_SwapBuffers\fP\fR(\fBvoid \fR); -.SH "DESCRIPTION" -.PP -Swap the OpenGL buffers, if double-buffering is supported\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_GL_SetAttribute\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GLattr.3 --- a/docs/man3/SDL_GLattr.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,47 +0,0 @@ -.TH "SDL_GLattr" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GLattr \- SDL GL Attributes -.SH "ATTRIBUTES" -.TP 20 -\fBSDL_GL_RED_SIZE\fP -Size of the framebuffer red component, in bits -.TP 20 -\fBSDL_GL_GREEN_SIZE\fP -Size of the framebuffer green component, in bits -.TP 20 -\fBSDL_GL_BLUE_SIZE\fP -Size of the framebuffer blue component, in bits -.TP 20 -\fBSDL_GL_ALPHA_SIZE\fP -Size of the framebuffer alpha component, in bits -.TP 20 -\fBSDL_GL_DOUBLEBUFFER\fP -0 or 1, enable or disable double buffering -.TP 20 -\fBSDL_GL_BUFFER_SIZE\fP -Size of the framebuffer, in bits -.TP 20 -\fBSDL_GL_DEPTH_SIZE\fP -Size of the depth buffer, in bits -.TP 20 -\fBSDL_GL_STENCIL_SIZE\fP -Size of the stencil buffer, in bits -.TP 20 -\fBSDL_GL_ACCUM_RED_SIZE\fP -Size of the accumulation buffer red component, in bits -.TP 20 -\fBSDL_GL_ACCUM_GREEN_SIZE\fP -Size of the accumulation buffer green component, in bits -.TP 20 -\fBSDL_GL_ACCUM_BLUE_SIZE\fP -Size of the accumulation buffer blue component, in bits -.TP 20 -\fBSDL_GL_ACCUM_ALPHA_SIZE\fP -Size of the accumulation buffer alpha component, in bits -.SH "DESCRIPTION" -.PP -While you can set most OpenGL attributes normally, the attributes list above must be known \fIbefore\fP SDL sets the video mode\&. These attributes a set and read with \fI\fBSDL_GL_SetAttribute\fP\fR and \fI\fBSDL_GL_GetAttribute\fP\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_GL_SetAttribute\fP\fR, \fI\fBSDL_GL_GetAttribute\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetAppState.3 --- a/docs/man3/SDL_GetAppState.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,24 +0,0 @@ -.TH "SDL_GetAppState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -\fBSDL_GetAppState\fP \- Get the state of the application -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint8 \fBSDL_GetAppState\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -This function returns the current state of the application\&. The value returned is a bitwise combination of: -.TP 20 -\fBSDL_APPMOUSEFOCUS\fP -The application has mouse focus\&. -.TP 20 -\fBSDL_APPINPUTFOCUS\fP -The application has keyboard focus -.TP 20 -\fBSDL_APPACTIVE\fP -The application is visible -.SH "SEE ALSO" -.PP -\fI\fBSDL_ActiveEvent\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetAudioStatus.3 --- a/docs/man3/SDL_GetAudioStatus.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,24 +0,0 @@ -.TH "SDL_GetAudioStatus" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetAudioStatus \- Get the current audio state -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_audiostatus\fBSDL_GetAudioStatus\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -.nf -\f(CWtypedef enum{ - SDL_AUDIO_STOPPED, - SDL_AUDIO_PAUSED, - SDL_AUDIO_PLAYING -} SDL_audiostatus;\fR -.fi -.PP -.PP -Returns either \fBSDL_AUDIO_STOPPED\fP, \fBSDL_AUDIO_PAUSED\fP or \fBSDL_AUDIO_PLAYING\fP depending on the current audio state\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_PauseAudio\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetClipRect.3 --- a/docs/man3/SDL_GetClipRect.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -.TH "SDL_GetClipRect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetClipRect \- Gets the clipping rectangle for a surface\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_GetClipRect\fP\fR(\fBSDL_Surface *surface, SDL_Rect *rect\fR); -.SH "DESCRIPTION" -.PP -Gets the clipping rectangle for a surface\&. When this surface is the destination of a blit, only the area within the clip rectangle is drawn into\&. -.PP -The rectangle pointed to by \fBrect\fR will be filled with the clipping rectangle of the surface\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_SetClipRect\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetCursor.3 --- a/docs/man3/SDL_GetCursor.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_GetCursor" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetCursor \- Get the currently active mouse cursor\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Cursor *\fBSDL_GetCursor\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -Returns the currently active mouse cursor\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_SetCursor\fP\fR, \fI\fBSDL_CreateCursor\fP\fR, \fI\fBSDL_ShowCursor\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetError.3 --- a/docs/man3/SDL_GetError.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_GetError" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetError \- Get SDL error string -.SH "SYNOPSIS" -.PP -\fB#include "SDL/SDL\&.h" -.sp -\fBchar *\fBSDL_GetError\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_GetError\fP returns a NULL terminated string containing information about the last internal SDL error\&. -.SH "RETURN VALUE" -.PP -\fBSDL_GetError\fP returns a string containing the last error\&. -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetEventFilter.3 --- a/docs/man3/SDL_GetEventFilter.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,23 +0,0 @@ -.TH "SDL_GetEventFilter" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetEventFilter \- Retrieves a pointer to he event filter -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_EventFilter \fBSDL_GetEventFilter\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -This function retrieces a pointer to the event filter that was previously set using \fI\fBSDL_SetEventFilter\fP\fR\&. An SDL_EventFilter function is defined as: -.PP -.nf -\f(CWtypedef int (*SDL_EventFilter)(const SDL_Event *event);\fR -.fi -.PP -.SH "RETURN VALUE" -.PP -Returns a pointer to the event filter or \fBNULL\fP if no filter has been set\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetEventFilter\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetGamma.3 --- a/docs/man3/SDL_GetGamma.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,21 +0,0 @@ -.TH "SDL_GetGamma" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetGamma \- Gets the gamma of the display -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_GetGamma\fP\fR(\fBfloat *red, float *green, float *blue\fR); -.SH "DESCRIPTION" -.PP -Gets the color gamma of the display\&. The gamma value for each color component will be place in the parameters \fBred\fR, \fBgreen\fR and \fBblue\fR\&. The values can range from 0\&.1 to 10\&. -.PP -.RS -\fBNote: -.PP -This function currently only works on XFreee 4\&.0 and up\&. -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_SetGamma\fP\fR, \fI\fBSDL_SetVideoMode\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetGammaRamp.3 --- a/docs/man3/SDL_GetGammaRamp.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,20 +0,0 @@ -.TH "SDL_GetGammaRamp" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetGammaRamp \- Gets the color gamma lookup tables for the display -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_GetGammaRamp\fP\fR(\fBUint16 *redtable, Uint16 *greentable, Uint16 *bluetable\fR); -.SH "DESCRIPTION" -.PP -Gets the gamma translation lookup tables currently used by the display\&. Each table is an array of 256 Uint16 values\&. -.PP -Not all display hardware is able to change gamma\&. -.SH "RETURN VALUE" -.PP -Returns -1 on error\&. -.SH "SEE ALSO" -.PP -\fISDL_SetGamma\fR \fISDL_SetGammaRamp\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetKeyName.3 --- a/docs/man3/SDL_GetKeyName.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_GetKeyName" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetKeyName \- Get the name of an SDL virtual keysym -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBchar *\fBSDL_GetKeyName\fP\fR(\fBSDLKey key\fR); -.SH "DESCRIPTION" -.PP -Returns the SDL-defined name of the \fI\fBSDLKey\fR\fR \fBkey\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDLKey\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetKeyState.3 --- a/docs/man3/SDL_GetKeyState.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -.TH "SDL_GetKeyState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetKeyState \- Get a snapshot of the current keyboard state -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint8 *\fBSDL_GetKeyState\fP\fR(\fBint *numkeys\fR); -.SH "DESCRIPTION" -.PP -Gets a snapshot of the current keyboard state\&. The current state is return as a pointer to an array, the size of this array is stored in \fBnumkeys\fR\&. The array is indexed by the \fI\fBSDLK_*\fP\fR symbols\&. A value of 1 means the key is pressed and a value of 0 means its not\&. The pointer returned is a pointer to an internal SDL array and should not be freed by the caller\&. -.PP -.RS -\fBNote: -.PP -Use \fI\fBSDL_PumpEvents\fP\fR to update the state array\&. -.RE -.SH "EXAMPLE" -.PP -.PP -.nf -\f(CWUint8 *keystate = SDL_GetKeyState(NULL); -if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed\&. -");\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL Key Symbols\fP\fR, \fI\fBSDL_PumpEvents\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetModState.3 --- a/docs/man3/SDL_GetModState.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,54 +0,0 @@ -.TH "SDL_GetModState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetModState \- Get the state of modifier keys\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDLMod \fBSDL_GetModState\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -Returns the current state of the modifier keys (CTRL, ALT, etc\&.)\&. -.SH "RETURN VALUE" -.PP -The return value can be an OR\&'d combination of the SDLMod enum\&. -.PP -.PP -.RS -\fBSDLMod\fR -.PP -.PP -.nf -\f(CWtypedef enum { - KMOD_NONE = 0x0000, - KMOD_LSHIFT= 0x0001, - KMOD_RSHIFT= 0x0002, - KMOD_LCTRL = 0x0040, - KMOD_RCTRL = 0x0080, - KMOD_LALT = 0x0100, - KMOD_RALT = 0x0200, - KMOD_LMETA = 0x0400, - KMOD_RMETA = 0x0800, - KMOD_NUM = 0x1000, - KMOD_CAPS = 0x2000, - KMOD_MODE = 0x4000, -} SDLMod;\fR -.fi -.PP -.RE - SDL also defines the following symbols for convenience: -.PP -.RS -.PP -.nf -\f(CW#define KMOD_CTRL (KMOD_LCTRL|KMOD_RCTRL) -#define KMOD_SHIFT (KMOD_LSHIFT|KMOD_RSHIFT) -#define KMOD_ALT (KMOD_LALT|KMOD_RALT) -#define KMOD_META (KMOD_LMETA|KMOD_RMETA)\fR -.fi -.PP -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_GetKeyState\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetMouseState.3 --- a/docs/man3/SDL_GetMouseState.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,24 +0,0 @@ -.TH "SDL_GetMouseState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetMouseState \- Retrieve the current state of the mouse -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint8 \fBSDL_GetMouseState\fP\fR(\fBint *x, int *y\fR); -.SH "DESCRIPTION" -.PP -The current button state is returned as a button bitmask, which can be tested using the \fBSDL_BUTTON(X)\fP macros, and \fBx\fR and \fBy\fR are set to the current mouse cursor position\&. You can pass \fBNULL\fP for either \fBx\fR or \fBy\fR\&. -.SH "EXAMPLE" -.PP -.nf -\f(CWSDL_PumpEvents(); -if(SDL_GetMouseState(NULL, NULL)&SDL_BUTTON(1)) - printf("Mouse Button 1(left) is pressed\&. -");\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_GetRelativeMouseState\fP\fR, \fI\fBSDL_PumpEvents\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetRGB.3 --- a/docs/man3/SDL_GetRGB.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -.TH "SDL_GetRGB" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetRGB \- Get RGB values from a pixel in the specified pixel format\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_GetRGB\fP\fR(\fBUint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g, Uint8 *b\fR); -.SH "DESCRIPTION" -.PP -Get RGB component values from a pixel stored in the specified pixel format\&. -.PP -This function uses the entire 8-bit [0\&.\&.255] range when converting color components from pixel formats with less than 8-bits per RGB component (e\&.g\&., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8])\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_GetRGBA\fP\fR, \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_PixelFormat\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetRGBA.3 --- a/docs/man3/SDL_GetRGBA.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,19 +0,0 @@ -.TH "SDL_GetRGBA" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetRGBA \- Get RGBA values from a pixel in the specified pixel format\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_GetRGBA\fP\fR(\fBUint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a\fR); -.SH "DESCRIPTION" -.PP -Get RGBA component values from a pixel stored in the specified pixel format\&. -.PP -This function uses the entire 8-bit [0\&.\&.255] range when converting color components from pixel formats with less than 8-bits per RGB component (e\&.g\&., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8])\&. -.PP -If the surface has no alpha component, the alpha will be returned as 0xff (100% opaque)\&. -.SH "SEE ALSO" -.PP -\fISDL_GetRGB\fR, \fISDL_MapRGB\fR, \fISDL_MapRGBA\fR, \fISDL_PixelFormat\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetRelativeMouseState.3 --- a/docs/man3/SDL_GetRelativeMouseState.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_GetRelativeMouseState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetRelativeMouseState \- Retrieve the current state of the mouse -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint8 \fBSDL_GetRelativeMouseState\fP\fR(\fBint *x, int *y\fR); -.SH "DESCRIPTION" -.PP -The current button state is returned as a button bitmask, which can be tested using the \fBSDL_BUTTON(X)\fP macros, and \fBx\fR and \fBy\fR are set to the change in the mouse position since the last call to \fBSDL_GetRelativeMouseState\fP or since event initialization\&. You can pass \fBNULL\fP for either \fBx\fR or \fBy\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_GetMouseState\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetThreadID.3 --- a/docs/man3/SDL_GetThreadID.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -.TH "SDL_GetThreadID" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetThreadID \- Get the SDL thread ID of a SDL_Thread -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBUint32 \fBSDL_GetThreadID\fP\fR(\fBSDL_Thread *thread\fR); -.SH "DESCRIPTION" -.PP -Returns the ID of a \fBSDL_Thread\fR created by \fISDL_CreateThread\fR\&. -.SH "SEE ALSO" -.PP -\fISDL_CreateThread\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetTicks.3 --- a/docs/man3/SDL_GetTicks.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_GetTicks" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetTicks \- Get the number of milliseconds since the SDL library initialization\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint32 \fBSDL_GetTicks\fP\fR(\fBvoid\fR) -.SH "DESCRIPTION" -.PP -Get the number of milliseconds since the SDL library initialization\&. Note that this value wraps if the program runs for more than ~49 days\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Delay\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetVideoInfo.3 --- a/docs/man3/SDL_GetVideoInfo.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_GetVideoInfo" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetVideoInfo \- returns a pointer to information about the video hardware -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_VideoInfo *\fBSDL_GetVideoInfo\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -This function returns a read-only pointer to \fIinformation\fR about the video hardware\&. If this is called before \fISDL_SetVideoMode\fR, the \fBvfmt\fR member of the returned structure will contain the pixel format of the "best" video mode\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_VideoInfo\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_GetVideoSurface.3 --- a/docs/man3/SDL_GetVideoSurface.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_GetVideoSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_GetVideoSurface \- returns a pointer to the current display surface -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Surface *\fBSDL_GetVideoSurface\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -This function returns a pointer to the current display surface\&. If SDL is doing format conversion on the display surface, this function returns the publicly visible surface, not the real video surface\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_Init.3 --- a/docs/man3/SDL_Init.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,41 +0,0 @@ -.TH "SDL_Init" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_Init \- Initializes SDL -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_Init\fP\fR(\fBUint32 flags\fR); -.SH "DESCRIPTION" -.PP -Initializes SDL\&. This should be called before all other SDL functions\&. The \fBflags\fR parameter specifies what part(s) of SDL to initialize\&. -.TP 20 -\fBSDL_INIT_TIMER\fP -Initializes the \fItimer\fR subsystem\&. -.TP 20 -\fBSDL_INIT_AUDIO\fP -Initializes the \fIaudio\fR subsystem\&. -.TP 20 -\fBSDL_INIT_VIDEO\fP -Initializes the \fIvideo\fR subsystem\&. -.TP 20 -\fBSDL_INIT_CDROM\fP -Initializes the \fIcdrom\fR subsystem\&. -.TP 20 -\fBSDL_INIT_JOYSTICK\fP -Initializes the \fIjoystick\fR subsystem\&. -.TP 20 -\fBSDL_INIT_EVERYTHING\fP -Initialize all of the above\&. -.TP 20 -\fBSDL_INIT_NOPARACHUTE\fP -Prevents SDL from catching fatal signals\&. -.TP 20 -\fBSDL_INIT_EVENTTHREAD\fP -.SH "RETURN VALUE" -.PP -Returns \fB-1\fR on an error or \fB0\fR on success\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Quit\fP\fR, \fI\fBSDL_InitSubSystem\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_InitSubSystem.3 --- a/docs/man3/SDL_InitSubSystem.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,41 +0,0 @@ -.TH "SDL_InitSubSystem" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_InitSubSystem \- Initialize subsystems -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_InitSubSystem\fP\fR(\fBUint32 flags\fR); -.SH "DESCRIPTION" -.PP -After SDL has been initialized with \fI\fBSDL_Init\fP\fR you may initialize uninitialized subsystems with \fBSDL_InitSubSystem\fP\&. The \fBflags\fR parameter is the same as that used in \fI\fBSDL_Init\fP\fR\&. -.SH "EXAMPLES" -.PP -.nf -\f(CW/* Seperating Joystick and Video initialization\&. */ -SDL_Init(SDL_INIT_VIDEO); -\&. -\&. -SDL_SetVideoMode(640, 480, 16, SDL_DOUBLEBUF|SDL_FULLSCREEN); -\&. -/* Do Some Video stuff */ -\&. -\&. -/* Initialize the joystick subsystem */ -SDL_InitSubSystem(SDL_INIT_JOYSTICK); - -/* Do some stuff with video and joystick */ -\&. -\&. -\&. -/* Shut them both down */ -SDL_Quit();\fR -.fi -.PP -.SH "RETURN VALUE" -.PP -Returns \fB-1\fR on an error or \fB0\fR on success\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Init\fP\fR, \fI\fBSDL_Quit\fP\fR, \fI\fBSDL_QuitSubSystem\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoyAxisEvent.3 --- a/docs/man3/SDL_JoyAxisEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,36 +0,0 @@ -.TH "SDL_JoyAxisEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoyAxisEvent \- Joystick axis motion event structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type; - Uint8 which; - Uint8 axis; - Sint16 value; -} SDL_JoyAxisEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_JOYAXISMOTION\fP -.TP 20 -\fBwhich\fR -Joystick device index -.TP 20 -\fBaxis\fR -Joystick axis index -.TP 20 -\fBvalue\fR -Axis value (range: -32768 to 32767) -.SH "DESCRIPTION" -.PP -\fBSDL_JoyAxisEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYAXISMOTION\fP is reported\&. -.PP -A \fBSDL_JOYAXISMOTION\fP event occurs when ever a user moves an axis on the joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBaxis\fR is the index of the axis (for a more detailed explaination see the \fIJoystick section\fR)\&. \fBvalue\fR is the current position of the axis\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetAxis\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoyBallEvent.3 --- a/docs/man3/SDL_JoyBallEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,36 +0,0 @@ -.TH "SDL_JoyBallEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoyBallEvent \- Joystick trackball motion event structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type; - Uint8 which; - Uint8 ball; - Sint16 xrel, yrel; -} SDL_JoyBallEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_JOYBALLMOTION\fP -.TP 20 -\fBwhich\fR -Joystick device index -.TP 20 -\fBball\fR -Joystick trackball index -.TP 20 -\fBxrel\fR, \fByrel\fR -The relative motion in the X/Y direction -.SH "DESCRIPTION" -.PP -\fBSDL_JoyBallEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYBALLMOTION\fP is reported\&. -.PP -A \fBSDL_JOYBALLMOTION\fP event occurs when a user moves a trackball on the joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBball\fR is the index of the trackball (for a more detailed explaination see the \fIJoystick section\fR)\&. Trackballs only return relative motion, this is the change in position on the ball since it was last polled (last cycle of the event loop) and it is stored in \fBxrel\fR and \fByrel\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetBall\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoyButtonEvent.3 --- a/docs/man3/SDL_JoyButtonEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,36 +0,0 @@ -.TH "SDL_JoyButtonEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoyButtonEvent \- Joystick button event structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type; - Uint8 which; - Uint8 button; - Uint8 state; -} SDL_JoyButtonEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP -.TP 20 -\fBwhich\fR -Joystick device index -.TP 20 -\fBbutton\fR -Joystick button index -.TP 20 -\fBstate\fR -\fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP -.SH "DESCRIPTION" -.PP -\fBSDL_JoyButtonEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP is reported\&. -.PP -A \fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP event occurs when ever a user presses or releases a button on a joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBbutton\fR is the index of the button (for a more detailed explaination see the \fIJoystick section\fR)\&. \fBstate\fR is the current state or the button which is either \fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetButton\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoyHatEvent.3 --- a/docs/man3/SDL_JoyHatEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,56 +0,0 @@ -.TH "SDL_JoyHatEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoyHatEvent \- Joystick hat position change event structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type; - Uint8 which; - Uint8 hat; - Uint8 value; -} SDL_JoyHatEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_JOY\fP -.TP 20 -\fBwhich\fR -Joystick device index -.TP 20 -\fBhat\fR -Joystick hat index -.TP 20 -\fBvalue\fR -Hat position -.SH "DESCRIPTION" -.PP -\fBSDL_JoyHatEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_JOYHATMOTION\fP is reported\&. -.PP -A \fBSDL_JOYHATMOTION\fP event occurs when ever a user moves a hat on the joystick\&. The field \fBwhich\fR is the index of the joystick that reported the event and \fBhat\fR is the index of the hat (for a more detailed exlaination see the \fIJoystick section\fR)\&. \fBvalue\fR is the current position of the hat\&. It is a logically OR\&'d combination of the following values (whose meanings should be pretty obvious:) : -.IP "" 10 -\fBSDL_HAT_CENTERED\fP -.IP "" 10 -\fBSDL_HAT_UP\fP -.IP "" 10 -\fBSDL_HAT_RIGHT\fP -.IP "" 10 -\fBSDL_HAT_DOWN\fP -.IP "" 10 -\fBSDL_HAT_LEFT\fP -.PP -The following defines are also provided: -.IP "" 10 -\fBSDL_HAT_RIGHTUP\fP -.IP "" 10 -\fBSDL_HAT_RIGHTDOWN\fP -.IP "" 10 -\fBSDL_HAT_LEFTUP\fP -.IP "" 10 -\fBSDL_HAT_LEFTDOWN\fP -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetHat\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoystickClose.3 --- a/docs/man3/SDL_JoystickClose.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_JoystickClose" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoystickClose \- Closes a previously opened joystick -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_JoystickClose\fP\fR(\fBSDL_Joystick *joystick\fR); -.SH "DESCRIPTION" -.PP -Close a \fBjoystick\fR that was previously opened with \fI\fBSDL_JoystickOpen\fP\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_JoystickOpen\fP\fR, \fI\fBSDL_JoystickOpened\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoystickEventState.3 --- a/docs/man3/SDL_JoystickEventState.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,24 +0,0 @@ -.TH "SDL_JoystickEventState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoystickEventState \- Enable/disable joystick event polling -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_JoystickEventState\fP\fR(\fBint state\fR); -.SH "DESCRIPTION" -.PP -This function is used to enable or disable joystick event processing\&. With joystick event processing disabled you will have to update joystick states with \fI\fBSDL_JoystickUpdate\fP\fR and read the joystick information manually\&. \fBstate\fR is either \fBSDL_QUERY\fP, \fBSDL_ENABLE\fP or \fBSDL_IGNORE\fP\&. -.PP -.RS -\fBNote: -.PP -Joystick event handling is prefered -.RE -.SH "RETURN VALUE" -.PP -If \fBstate\fR is \fBSDL_QUERY\fP then the current state is returned, otherwise the new processing \fBstate\fR is returned\&. -.SH "SEE ALSO" -.PP -\fISDL Joystick Functions\fR, \fI\fBSDL_JoystickUpdate\fP\fR, \fI\fBSDL_JoyAxisEvent\fR\fR, \fI\fBSDL_JoyBallEvent\fR\fR, \fI\fBSDL_JoyButtonEvent\fR\fR, \fI\fBSDL_JoyHatEvent\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoystickGetAxis.3 --- a/docs/man3/SDL_JoystickGetAxis.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ -.TH "SDL_JoystickGetAxis" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoystickGetAxis \- Get the current state of an axis -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSint16 \fBSDL_JoystickGetAxis\fP\fR(\fBSDL_Joystick *joystick, int axis\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_JoystickGetAxis\fP returns the current state of the given \fBaxis\fR on the given \fBjoystick\fR\&. -.PP -On most modern joysticks the X axis is usually represented by \fBaxis\fR 0 and the Y axis by \fBaxis\fR 1\&. The value returned by \fBSDL_JoystickGetAxis\fP is a signed integer (-32768 to 32768) representing the current position of the \fBaxis\fR, it maybe necessary to impose certain tolerances on these values to account for jitter\&. It is worth noting that some joysticks use axes 2 and 3 for extra buttons\&. -.SH "RETURN VALUE" -.PP -Returns a 16-bit signed integer representing the current position of the \fBaxis\fR\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWSint16 x_move, y_move; -SDL_Joystick *joy1; -\&. -\&. -x_move=SDL_JoystickGetAxis(joy1, 0); -y_move=SDL_JoystickGetAxis(joy1, 1);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_JoystickNumAxes\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoystickGetBall.3 --- a/docs/man3/SDL_JoystickGetBall.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,37 +0,0 @@ -.TH "SDL_JoystickGetBall" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoystickGetBall \- Get relative trackball motion -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_JoystickGetBall\fP\fR(\fBSDL_Joystick *joystick, int ball, int *dx, int *dy\fR); -.SH "DESCRIPTION" -.PP -Get the \fBball\fR axis change\&. -.PP -Trackballs can only return relative motion since the last call to \fBSDL_JoystickGetBall\fP, these motion deltas a placed into \fBdx\fR and \fBdy\fR\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on success or \fB-1\fR on failure -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWint delta_x, delta_y; -SDL_Joystick *joy; -\&. -\&. -\&. -SDL_JoystickUpdate(); -if(SDL_JoystickGetBall(joy, 0, &delta_x, &delta_y)==-1) - printf("TrackBall Read Error! -"); -printf("Trackball Delta- X:%d, Y:%d -", delta_x, delta_y);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_JoystickNumBalls\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoystickGetButton.3 --- a/docs/man3/SDL_JoystickGetButton.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_JoystickGetButton" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoystickGetButton \- Get the current state of a given button on a given joystick -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint8 \fBSDL_JoystickGetButton\fP\fR(\fBSDL_Joystick *joystick, int button\fR); -.SH "DESCRIPTION" -.PP -SDL_JoystickGetButton returns the current state of the given \fBbutton\fR on the given \fBjoystick\fR\&. -.SH "RETURN VALUE" -.PP -\fB1\fR if the button is pressed\&. Otherwise, \fB0\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_JoystickNumButtons\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoystickGetHat.3 --- a/docs/man3/SDL_JoystickGetHat.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,36 +0,0 @@ -.TH "SDL_JoystickGetHat" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoystickGetHat \- Get the current state of a joystick hat -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint8 \fBSDL_JoystickGetHat\fP\fR(\fBSDL_Joystick *joystick, int hat\fR); -.SH "DESCRIPTION" -.PP -SDL_JoystickGetHat returns the current state of the given \fBhat\fR on the given \fBjoystick\fR\&. -.SH "RETURN VALUE" -.PP -The current state is returned as a Uint8 which is defined as an OR\&'d combination of one or more of the following -.IP "" 10 -\fBSDL_HAT_CENTERED\fP -.IP "" 10 -\fBSDL_HAT_UP\fP -.IP "" 10 -\fBSDL_HAT_RIGHT\fP -.IP "" 10 -\fBSDL_HAT_DOWN\fP -.IP "" 10 -\fBSDL_HAT_LEFT\fP -.IP "" 10 -\fBSDL_HAT_RIGHTUP\fP -.IP "" 10 -\fBSDL_HAT_RIGHTDOWN\fP -.IP "" 10 -\fBSDL_HAT_LEFTUP\fP -.IP "" 10 -\fBSDL_HAT_LEFTDOWN\fP -.SH "SEE ALSO" -.PP -\fI\fBSDL_JoystickNumHats\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoystickIndex.3 --- a/docs/man3/SDL_JoystickIndex.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_JoystickIndex" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoystickIndex \- Get the index of an SDL_Joystick\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_JoystickIndex\fP\fR(\fBSDL_Joystick *joystick\fR); -.SH "DESCRIPTION" -.PP -Returns the index of a given \fBSDL_Joystick\fR structure\&. -.SH "RETURN VALUE" -.PP -Index number of the joystick\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_JoystickOpen\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoystickName.3 --- a/docs/man3/SDL_JoystickName.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ -.TH "SDL_JoystickName" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoystickName \- Get joystick name\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBconst char *\fBSDL_JoystickName\fP\fR(\fBint index\fR); -.SH "DESCRIPTION" -.PP -Get the implementation dependent name of joystick\&. The \fBindex\fR parameter refers to the N\&'th joystick on the system\&. -.SH "RETURN VALUE" -.PP -Returns a char pointer to the joystick name\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CW/* Print the names of all attached joysticks */ -int num_joy, i; -num_joy=SDL_NumJoysticks(); -printf("%d joysticks found -", num_joy); -for(i=0;i0){ - // Open joystick - joy=SDL_JoystickOpen(0); - - if(joy) - { - printf("Opened Joystick 0 -"); - printf("Name: %s -", SDL_JoystickName(0)); - printf("Number of Axes: %d -", SDL_JoystickNumAxes(joy)); - printf("Number of Buttons: %d -", SDL_JoystickNumButtons(joy)); - printf("Number of Balls: %d -", SDL_JoystickNumBalls(joy)); - } - else - printf("Couldn\&'t open Joystick 0 -"); - - // Close if opened - if(SDL_JoystickOpened(0)) - SDL_JoystickClose(joy); -}\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_JoystickClose\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoystickOpened.3 --- a/docs/man3/SDL_JoystickOpened.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_JoystickOpened" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoystickOpened \- Determine if a joystick has been opened -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_JoystickOpened\fP\fR(\fBint index\fR); -.SH "DESCRIPTION" -.PP -Determines whether a joystick has already been opened within the application\&. \fBindex\fR refers to the N\&'th joystick on the system\&. -.SH "RETURN VALUE" -.PP -Returns \fB1\fR if the joystick has been opened, or \fB0\fR if it has not\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_JoystickOpen\fP\fR, \fI\fBSDL_JoystickClose\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_JoystickUpdate.3 --- a/docs/man3/SDL_JoystickUpdate.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_JoystickUpdate" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_JoystickUpdate \- Updates the state of all joysticks -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_JoystickUpdate\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -Updates the state(position, buttons, etc\&.) of all open joysticks\&. If joystick events have been enabled with \fI\fBSDL_JoystickEventState\fP\fR then this is called automatically in the event loop\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_JoystickEventState\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_KeyboardEvent.3 --- a/docs/man3/SDL_KeyboardEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,38 +0,0 @@ -.TH "SDL_KeyboardEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_KeyboardEvent \- Keyboard event structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type; - Uint8 state; - SDL_keysym keysym; -} SDL_KeyboardEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_KEYDOWN\fP or \fBSDL_KEYUP\fP -.TP 20 -\fBstate\fR -\fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP -.TP 20 -\fBkeysym\fR -Contains key press information -.SH "DESCRIPTION" -.PP -\fBSDL_KeyboardEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_KEYDOWN\fP or \fBSDL_KEYUP\fP is reported\&. -.PP -The \fBtype\fR and \fBstate\fR actually report the same information, they just use different values to do it! A keyboard event occurs when a key is released (\fBtype\fR=\fBSDK_KEYUP\fP or \fBstate\fR=\fBSDL_RELEASED\fP) and when a key is pressed (\fBtype\fR=\fBSDL_KEYDOWN\fP or \fBstate\fR=\fBSDL_PRESSED\fP)\&. The information on what key was pressed or released is in the \fI\fBkeysym\fR\fR structure\&. -.PP -.RS -\fBNote: -.PP -Repeating \fBSDL_KEYDOWN\fP events will occur if key repeat is enabled (see \fI\fBSDL_EnableKeyRepeat\fP\fR)\&. -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_keysym\fR\fR, \fI\fBSDL_EnableKeyRepeat\fP\fR, \fI\fBSDL_EnableUNICODE\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_KillThread.3 --- a/docs/man3/SDL_KillThread.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,16 +0,0 @@ -.TH "SDL_KillThread" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_KillThread \- Gracelessly terminates the thread\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBvoid \fBSDL_KillThread\fP\fR(\fBSDL_Thread *thread\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_KillThread\fP gracelessly terminates the thread associated with \fBthread\fR\&. If possible, you should use some other form of IPC to signal the thread to quit\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateThread\fP\fR, \fI\fBSDL_WaitThread\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_ListModes.3 --- a/docs/man3/SDL_ListModes.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,53 +0,0 @@ -.TH "SDL_ListModes" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_ListModes \- Returns a pointer to an array of available screen dimensions for the given format and video flags -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Rect **\fBSDL_ListModes\fP\fR(\fBSDL_PixelFormat *format, Uint32 flags\fR); -.SH "DESCRIPTION" -.PP -Return a pointer to an array of available screen dimensions for the given format and video flags, sorted largest to smallest\&. Returns \fBNULL\fP if there are no dimensions available for a particular format, or \fB-1\fR if any dimension is okay for the given format\&. -.PP -If \fBformat\fR is \fBNULL\fP, the mode list will be for the format returned by \fISDL_GetVideoInfo()\fR->\fBvfmt\fR\&. The \fBflag\fR parameter is an OR\&'d combination of \fIsurface\fR flags\&. The flags are the same as those used \fI\fBSDL_SetVideoMode\fP\fR and they play a strong role in deciding what modes are valid\&. For instance, if you pass \fBSDL_HWSURFACE\fP as a flag only modes that support hardware video surfaces will be returned\&. -.SH "EXAMPLE" -.PP -.nf -\f(CWSDL_Rect **modes; -int i; -\&. -\&. -\&. - -/* Get available fullscreen/hardware modes */ -modes=SDL_ListModes(NULL, SDL_FULLSCREEN|SDL_HWSURFACE); - -/* Check is there are any modes available */ -if(modes == (SDL_Rect **)0){ - printf("No modes available! -"); - exit(-1); -} - -/* Check if or resolution is restricted */ -if(modes == (SDL_Rect **)-1){ - printf("All resolutions available\&. -"); -} -else{ - /* Print valid modes */ - printf("Available Modes -"); - for(i=0;modes[i];++i) - printf(" %d x %d -", modes[i]->w, modes[i]->h); -} -\&. -\&.\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_GetVideoInfo\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_PixelFormat\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_LoadBMP.3 --- a/docs/man3/SDL_LoadBMP.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_LoadBMP" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_LoadBMP \- Load a Windows BMP file into an SDL_Surface\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Surface *\fBSDL_LoadBMP\fP\fR(\fBconst char *file\fR); -.SH "DESCRIPTION" -.PP -Loads a surface from a named Windows BMP file\&. -.SH "RETURN VALUE" -.PP -Returns the new surface, or \fBNULL\fP if there was an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_SaveBMP\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_LoadWAV.3 --- a/docs/man3/SDL_LoadWAV.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,42 +0,0 @@ -.TH "SDL_LoadWAV" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_LoadWAV \- Load a WAVE file -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_AudioSpec *\fBSDL_LoadWAV\fP\fR(\fBconst char *file, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_LoadWAV\fP This function loads a WAVE \fBfile\fR into memory\&. -.PP -If this function succeeds, it returns the given \fI\fBSDL_AudioSpec\fP\fR, filled with the audio data format of the wave data, and sets \fBaudio_buf\fR to a \fBmalloc\fP\&'d buffer containing the audio data, and sets \fBaudio_len\fR to the length of that audio buffer, in bytes\&. You need to free the audio buffer with \fI\fBSDL_FreeWAV\fP\fR when you are done with it\&. -.PP -This function returns \fBNULL\fP and sets the SDL error message if the wave file cannot be opened, uses an unknown data format, or is corrupt\&. Currently raw, MS-ADPCM and IMA-ADPCM WAVE files are supported\&. -.SH "EXAMPLE" -.PP -.nf -\f(CWSDL_AudioSpec wav_spec; -Uint32 wav_length; -Uint8 *wav_buffer; - -/* Load the WAV */ -if( SDL_LoadWAV("test\&.wav", &wav_spec, &wav_buffer, &wav_length) == NULL ){ - fprintf(stderr, "Could not open test\&.wav: %s -", SDL_GetError()); - exit(-1); -} -\&. -\&. -\&. -/* Do stuff with the WAV */ -\&. -\&. -/* Free It */ -SDL_FreeWAV(wav_buffer);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_AudioSpec\fR\fR, \fI\fBSDL_OpenAudio\fP\fR, \fI\fBSDL_FreeWAV\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_LockAudio.3 --- a/docs/man3/SDL_LockAudio.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_LockAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_LockAudio \- Lock out the callback function -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_LockAudio\fP\fR(\fBvoid\fR) -.SH "DESCRIPTION" -.PP -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\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_LockSurface.3 --- a/docs/man3/SDL_LockSurface.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,48 +0,0 @@ -.TH "SDL_LockSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_LockSurface \- Lock a surface for directly access\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_LockSurface\fP\fR(\fBSDL_Surface *surface\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_LockSurface\fP sets up a surface for directly accessing the pixels\&. Between calls to \fBSDL_LockSurface\fP and \fBSDL_UnlockSurface\fP, you can write to and read from \fBsurface->\fBpixels\fR\fR, using the pixel format stored in \fBsurface->\fBformat\fR\fR\&. Once you are done accessing the surface, you should use \fBSDL_UnlockSurface\fP to release it\&. -.PP -Not all surfaces require locking\&. If \fBSDL_MUSTLOCK\fP(\fBsurface\fR) evaluates to \fB0\fR, then you can read and write to the surface at any time, and the pixel format of the surface will not change\&. -.PP -No operating system or library calls should be made between lock/unlock pairs, as critical system locks may be held during this time\&. -.PP -It should be noted, that since SDL 1\&.1\&.8 surface locks are recursive\&. This means that you can lock a surface multiple times, but each lock must have a match unlock\&. -.PP -.nf -\f(CW \&. - \&. - SDL_LockSurface( surface ); - \&. - /* Surface is locked */ - /* Direct pixel access on surface here */ - \&. - SDL_LockSurface( surface ); - \&. - /* More direct pixel access on surface */ - \&. - SDL_UnlockSurface( surface ); - /* Surface is still locked */ - /* Note: Is versions < 1\&.1\&.8, the surface would have been */ - /* no longer locked at this stage */ - \&. - SDL_UnlockSurface( surface ); - /* Surface is now unlocked */ - \&. - \&.\fR -.fi -.PP -.SH "RETURN VALUE" -.PP -\fBSDL_LockSurface\fP returns \fB0\fR, or \fB-1\fR if the surface couldn\&'t be locked\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_UnlockSurface\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_LockYUVOverlay.3 --- a/docs/man3/SDL_LockYUVOverlay.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_LockYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_LockYUVOverlay \- Lock an overlay -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_LockYUVOverlay\fP\fR(\fBSDL_Overlay *overlay\fR); -.SH "DESCRIPTION" -.PP -Much the same as \fI\fBSDL_LockSurface\fP\fR, \fBSDL_LockYUVOverlay\fP locks the \fI\fBoverlay\fR\fR for direct access to pixel data\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on success, or \fB-1\fR on an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_UnlockYUVOverlay\fP\fR, \fI\fBSDL_CreateYUVOverlay\fP\fR, \fI\fBSDL_Overlay\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_MapRGB.3 --- a/docs/man3/SDL_MapRGB.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -.TH "SDL_MapRGB" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_MapRGB \- Map a RGB color value to a pixel format\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint32 \fBSDL_MapRGB\fP\fR(\fBSDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b\fR); -.SH "DESCRIPTION" -.PP -Maps the RGB color value to the specified pixel format and returns the pixel value as a 32-bit int\&. -.PP -If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned\&. -.PP -If the specified pixel format has an alpha component it will be returned as all 1 bits (fully opaque)\&. -.SH "RETURN VALUE" -.PP -A pixel value best approximating the given RGB color value for a given pixel format\&. If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e\&.g\&., with a 16-bpp format the return value can be assigned to a \fBUint16\fP, and similarly a \fBUint8\fP for an 8-bpp format)\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_GetRGB\fP\fR, \fI\fBSDL_GetRGBA\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_PixelFormat\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_MapRGBA.3 --- a/docs/man3/SDL_MapRGBA.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -.TH "SDL_MapRGBA" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_MapRGBA \- Map a RGBA color value to a pixel format\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint32 \fBSDL_MapRGBA\fP\fR(\fBSDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b, Uint8 a\fR); -.SH "DESCRIPTION" -.PP -Maps the RGBA color value to the specified pixel format and returns the pixel value as a 32-bit int\&. -.PP -If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned\&. -.PP -If the specified pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette)\&. -.SH "RETURN VALUE" -.PP -A pixel value best approximating the given RGBA color value for a given pixel format\&. If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e\&.g\&., with a 16-bpp format the return value can be assigned to a \fBUint16\fP, and similarly a \fBUint8\fP for an 8-bpp format)\&. -.SH "SEE ALSO" -.PP -\fISDL_GetRGB\fR, \fISDL_GetRGBA\fR, \fISDL_MapRGB\fR, \fISDL_PixelFormat\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_MixAudio.3 --- a/docs/man3/SDL_MixAudio.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,21 +0,0 @@ -.TH "SDL_MixAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_MixAudio \- Mix audio data -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_MixAudio\fP\fR(\fBUint8 *dst, Uint8 *src, Uint32 len, int volume\fR); -.SH "DESCRIPTION" -.PP -This function takes two audio buffers of \fBlen\fR bytes each of the playing audio format and mixes them, performing addition, volume adjustment, and overflow clipping\&. The \fBvolume\fR ranges from 0 to \fBSDL_MIX_MAXVOLUME\fP and should be set to the maximum value for full audio volume\&. Note this does not change hardware volume\&. This is provided for convenience -- you can mix your own audio data\&. -.PP -.RS -\fBNote: -.PP -Do not use this function for mixing together more than two streams of sample data\&. The output from repeated application of this function may be distorted by clipping, because there is no accumulator with greater range than the input (not to mention this being an inefficient way of doing it)\&. Use mixing functions from SDL_mixer, OpenAL, or write your own mixer instead\&. -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_MouseButtonEvent.3 --- a/docs/man3/SDL_MouseButtonEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,36 +0,0 @@ -.TH "SDL_MouseButtonEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_MouseButtonEvent \- Mouse button event structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type; - Uint8 button; - Uint8 state; - Uint16 x, y; -} SDL_MouseButtonEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_MOUSEBUTTONDOWN\fP or \fBSDL_MOUSEBUTTONUP\fP -.TP 20 -\fBbutton\fR -The mouse button index (SDL_BUTTON_LEFT, SDL_BUTTON_MIDDLE, SDL_BUTTON_RIGHT) -.TP 20 -\fBstate\fR -\fBSDL_PRESSED\fP or \fBSDL_RELEASED\fP -.TP 20 -\fBx\fR, \fBy\fR -The X/Y coordinates of the mouse at press/release time -.SH "DESCRIPTION" -.PP -\fBSDL_MouseButtonEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_MOUSEBUTTONDOWN\fP or \fBSDL_MOUSEBUTTONUP\fP is reported\&. -.PP -When a mouse button press or release is detected then number of the button pressed (from 1 to 255, with 1 usually being the left button and 2 the right) is placed into \fBbutton\fR, the position of the mouse when this event occured is stored in the \fBx\fR and the \fBy\fR fields\&. Like \fI\fBSDL_KeyboardEvent\fR\fR, information on whether the event was a press or a release event is stored in both the \fBtype\fR and \fBstate\fR fields, but this should be obvious\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_MouseMotionEvent\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_MouseMotionEvent.3 --- a/docs/man3/SDL_MouseMotionEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,38 +0,0 @@ -.TH "SDL_MouseMotionEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_MouseMotionEvent \- Mouse motion event structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type; - Uint8 state; - Uint16 x, y; - Sint16 xrel, yrel; -} SDL_MouseMotionEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_MOUSEMOTION\fP -.TP 20 -\fBstate\fR -The current button state -.TP 20 -\fBx\fR, \fBy\fR -The X/Y coordinates of the mouse -.TP 20 -\fBxrel\fR, \fByrel\fR -Relative motion in the X/Y direction -.SH "DESCRIPTION" -.PP -\fBSDL_MouseMotionEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_MOUSEMOTION\fP is reported\&. -.PP -Simply put, a \fBSDL_MOUSEMOTION\fP type event occurs when a user moves the mouse within the application window or when \fI\fBSDL_WarpMouse\fP\fR is called\&. Both the absolute (\fBx\fR and \fBy\fR) and relative (\fBxrel\fR and \fByrel\fR) coordinates are reported along with the current button states (\fBstate\fR)\&. The button state can be interpreted using the \fBSDL_BUTTON\fP macro (see \fI\fBSDL_GetMouseState\fP\fR)\&. -.PP -If the cursor is hidden (\fI\fBSDL_ShowCursor\fP(0)\fR) and the input is grabbed (\fI\fBSDL_WM_GrabInput\fP(SDL_GRAB_ON)\fR), then the mouse will give relative motion events even when the cursor reaches the edge fo the screen\&. This is currently only implemented on Windows and Linux/Unix-a-likes\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_MouseButtonEvent\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_NumJoysticks.3 --- a/docs/man3/SDL_NumJoysticks.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_NumJoysticks" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_NumJoysticks \- Count available joysticks\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_NumJoysticks\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -Counts the number of joysticks attached to the system\&. -.SH "RETURN VALUE" -.PP -Returns the number of attached joysticks -.SH "SEE ALSO" -.PP -\fI\fBSDL_JoystickName\fP\fR, \fI\fBSDL_JoystickOpen\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_OpenAudio.3 --- a/docs/man3/SDL_OpenAudio.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,97 +0,0 @@ -.TH "SDL_OpenAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_OpenAudio \- Opens the audio device with the desired parameters\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_OpenAudio\fP\fR(\fBSDL_AudioSpec *desired, SDL_AudioSpec *obtained\fR); -.SH "DESCRIPTION" -.PP -This function opens the audio device with the \fBdesired\fR parameters, and returns 0 if successful, placing the actual hardware parameters in the structure pointed to by \fBobtained\fR\&. If \fBobtained\fR is NULL, the audio data passed to the callback function will be guaranteed to be in the requested format, and will be automatically converted to the hardware audio format if necessary\&. This function returns -1 if it failed to open the audio device, or couldn\&'t set up the audio thread\&. -.PP -To open the audio device a \fBdesired\fR \fI\fBSDL_AudioSpec\fR\fR must be created\&. -.PP -.nf -\f(CWSDL_AudioSpec *desired; -\&. -\&. -desired=(SDL_AudioSpec *)malloc(sizeof(SDL_AudioSpec));\fR -.fi -.PP - You must then fill this structure with your desired audio specifications\&. -.IP "\fBdesired\fR->\fBfreq\fR" 10The desired audio frequency in samples-per-second\&. -.IP "\fBdesired\fR->\fBformat\fR" 10The desired audio format (see \fI\fBSDL_AudioSpec\fR\fR) -.IP "\fBdesired\fR->\fBsamples\fR" 10The desired size of the audio buffer in samples\&. This number should be a power of two, and may be adjusted by the audio driver to a value more suitable for the hardware\&. Good values seem to range between 512 and 8192 inclusive, depending on the application and CPU speed\&. Smaller values yield faster response time, but can lead to underflow if the application is doing heavy processing and cannot fill the audio buffer in time\&. A stereo sample consists of both right and left channels in LR ordering\&. Note that the number of samples is directly related to time by the following formula: ms = (samples*1000)/freq -.IP "\fBdesired\fR->\fBcallback\fR" 10This should be set to a function that will be called when the audio device is ready for more data\&. It is passed a pointer to the audio buffer, and the length in bytes of the audio buffer\&. This function usually runs in a separate thread, and so you should protect data structures that it accesses by calling \fI\fBSDL_LockAudio\fP\fR and \fI\fBSDL_UnlockAudio\fP\fR in your code\&. The callback prototype is: -.PP -.nf -\f(CWvoid callback(void *userdata, Uint8 *stream, int len);\fR -.fi -.PP - \fBuserdata\fR is the pointer stored in \fBuserdata\fR field of the \fBSDL_AudioSpec\fR\&. \fBstream\fR is a pointer to the audio buffer you want to fill with information and \fBlen\fR is the length of the audio buffer in bytes\&. -.IP "\fBdesired\fR->\fBuserdata\fR" 10This pointer is passed as the first parameter to the \fBcallback\fP function\&. -.PP -\fBSDL_OpenAudio\fP reads these fields from the \fBdesired\fR \fBSDL_AudioSpec\fR structure pass to the function and attempts to find an audio configuration matching your \fBdesired\fR\&. As mentioned above, if the \fBobtained\fR parameter is \fBNULL\fP then SDL with convert from your \fBdesired\fR audio settings to the hardware settings as it plays\&. -.PP -If \fBobtained\fR is \fBNULL\fP then the \fBdesired\fR \fBSDL_AudioSpec\fR is your working specification, otherwise the \fBobtained\fR \fBSDL_AudioSpec\fR becomes the working specification and the \fBdesirec\fR specification can be deleted\&. The data in the working specification is used when building \fBSDL_AudioCVT\fR\&'s for converting loaded data to the hardware format\&. -.PP -\fBSDL_OpenAudio\fP calculates the \fBsize\fR and \fBsilence\fR fields for both the \fBdesired\fR and \fBobtained\fR specifications\&. The \fBsize\fR field stores the total size of the audio buffer in bytes, while the \fBsilence\fR stores the value used to represent silence in the audio buffer -.PP -The audio device starts out playing \fBsilence\fR when it\&'s opened, and should be enabled for playing by calling \fI\fBSDL_PauseAudio\fP(\fB0\fR)\fR when you are ready for your audio \fBcallback\fR function to be called\&. Since the audio driver may modify the requested \fBsize\fR of the audio buffer, you should allocate any local mixing buffers after you open the audio device\&. -.SH "EXAMPLES" -.PP -.nf -\f(CW/* Prototype of our callback function */ -void my_audio_callback(void *userdata, Uint8 *stream, int len); - -/* Open the audio device */ -SDL_AudioSpec *desired, *obtained; -SDL_AudioSpec *hardware_spec; - -/* Allocate a desired SDL_AudioSpec */ -desired=(SDL_AudioSpec *)malloc(sizeof(SDL_AudioSpec)); - -/* Allocate space for the obtained SDL_AudioSpec */ -obtained=(SDL_AudioSpec *)malloc(sizeof(SDL_AudioSpec)); - -/* 22050Hz - FM Radio quality */ -desired->freq=22050; - -/* 16-bit signed audio */ -desired->format=AUDIO_S16LSB; - -/* Mono */ -desired->channels=0; - -/* Large audio buffer reduces risk of dropouts but increases response time */ -desired->samples=8192; - -/* Our callback function */ -desired->callback=my_audio_callback; - -desired->userdata=NULL; - -/* Open the audio device */ -if ( SDL_OpenAudio(desired, obtained) < 0 ){ - fprintf(stderr, "Couldn\&'t open audio: %s -", SDL_GetError()); - exit(-1); -} -/* desired spec is no longer needed */ -free(desired); -hardware_spec=obtained; -\&. -\&. -/* Prepare callback for playing */ -\&. -\&. -\&. -/* Start playing */ -SDL_PauseAudio(0);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_AudioSpec\fP\fR, \fI\fBSDL_LockAudio\fP\fR, \fI\fBSDL_UnlockAudio\fP\fR, \fI\fBSDL_PauseAudio\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_Overlay.3 --- a/docs/man3/SDL_Overlay.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,52 +0,0 @@ -.TH "SDL_Overlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_Overlay \- YUV video overlay -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint32 format; - int w, h; - int planes; - Uint16 *pitches; - Uint8 **pixels; - Uint32 hw_overlay:1; -} SDL_Overlay;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBformat\fR -Overlay format (see below) -.TP 20 -\fBw, h\fR -Width and height of overlay -.TP 20 -\fBplanes\fR -Number of planes in the overlay\&. Usually either 1 or 3 -.TP 20 -\fBpitches\fR -An array of pitches, one for each plane\&. Pitch is the length of a row in bytes\&. -.TP 20 -\fBpixels\fR -An array of pointers to teh data of each plane\&. The overlay should be locked before these pointers are used\&. -.TP 20 -\fBhw_overlay\fR -This will be set to 1 if the overlay is hardware accelerated\&. -.SH "DESCRIPTION" -.PP -A \fBSDL_Overlay\fR is similar to a \fI\fBSDL_Surface\fR\fR except it stores a YUV overlay\&. All the fields are read only, except for \fBpixels\fR which should be \fIlocked\fR before use\&. The \fBformat\fR field stores the format of the overlay which is one of the following: -.PP -.nf -\f(CW#define SDL_YV12_OVERLAY 0x32315659 /* Planar mode: Y + V + U */ -#define SDL_IYUV_OVERLAY 0x56555949 /* Planar mode: Y + U + V */ -#define SDL_YUY2_OVERLAY 0x32595559 /* Packed mode: Y0+U0+Y1+V0 */ -#define SDL_UYVY_OVERLAY 0x59565955 /* Packed mode: U0+Y0+V0+Y1 */ -#define SDL_YVYU_OVERLAY 0x55595659 /* Packed mode: Y0+V0+Y1+U0 */\fR -.fi -.PP - More information on YUV formats can be found at \fIhttp://www\&.webartz\&.com/fourcc/indexyuv\&.htm (link to URL http://www.webartz.com/fourcc/indexyuv.htm) \fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateYUVOverlay\fP\fR, \fI\fBSDL_LockYUVOverlay\fP\fR, \fI\fBSDL_UnlockYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_Palette.3 --- a/docs/man3/SDL_Palette.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,26 +0,0 @@ -.TH "SDL_Palette" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_Palette \- Color palette for 8-bit pixel formats -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - int ncolors; - SDL_Color *colors; -} SDL_Palette;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBncolors\fR -Number of colors used in this palette -.TP 20 -\fBcolors\fR -Pointer to \fI\fBSDL_Color\fR\fR structures that make up the palette\&. -.SH "DESCRIPTION" -.PP -Each pixel in an 8-bit surface is an index into the \fBcolors\fR field of the \fBSDL_Palette\fR structure store in \fI\fBSDL_PixelFormat\fR\fR\&. A \fBSDL_Palette\fR should never need to be created manually\&. It is automatically created when SDL allocates a \fBSDL_PixelFormat\fR for a surface\&. The colors values of a \fI\fBSDL_Surface\fR\fRs palette can be set with the \fI\fBSDL_SetColors\fP\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Color\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_SetColors\fP\fR \fI\fBSDL_SetPalette\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_PauseAudio.3 --- a/docs/man3/SDL_PauseAudio.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_PauseAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_PauseAudio \- Pauses and unpauses the audio callback processing -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_PauseAudio\fP\fR(\fBint pause_on\fR); -.SH "DESCRIPTION" -.PP -This function pauses and unpauses the audio callback processing\&. It should be called with \fBpause_on\fR=0 after opening the audio device to start playing sound\&. This is so you can safely initialize data for your callback function after opening the audio device\&. Silence will be written to the audio device during the pause\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_GetAudioStatus\fP\fR, \fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_PeepEvents.3 --- a/docs/man3/SDL_PeepEvents.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,26 +0,0 @@ -.TH "SDL_PeepEvents" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_PeepEvents \- Checks the event queue for messages and optionally returns them\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_PeepEvents\fP\fR(\fBSDL_Event *events, int numevents, SDL_eventaction action, Uint32 mask\fR); -.SH "DESCRIPTION" -.PP -Checks the event queue for messages and optionally returns them\&. -.PP -If \fBaction\fR is \fBSDL_ADDEVENT\fP, up to \fBnumevents\fR events will be added to the back of the event queue\&. -.PP -If \fBaction\fR is \fBSDL_PEEKEVENT\fP, up to \fBnumevents\fR events at the front of the event queue, matching \fI\fBmask\fR\fR, will be returned and will not be removed from the queue\&. -.PP -If \fBaction\fR is \fBSDL_GETEVENT\fP, up to \fBnumevents\fR events at the front of the event queue, matching \fI\fBmask\fR\fR, will be returned and will be removed from the queue\&. -.PP -This function is thread-safe\&. -.SH "RETURN VALUE" -.PP -This function returns the number of events actually stored, or \fB-1\fR if there was an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PushEvent\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_PixelFormat.3 --- a/docs/man3/SDL_PixelFormat.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,140 +0,0 @@ -.TH "SDL_PixelFormat" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_PixelFormat \- Stores surface format information -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct SDL_PixelFormat { - SDL_Palette *palette; - Uint8 BitsPerPixel; - Uint8 BytesPerPixel; - Uint8 Rloss, Gloss, Bloss, Aloss; - Uint8 Rshift, Gshift, Bshift, Ashift; - Uint32 Rmask, Gmask, Bmask, Amask; - Uint32 colorkey; - Uint8 alpha; -} SDL_PixelFormat;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBpalette\fR -Pointer to the \fIpalette\fR, or \fBNULL\fP if the \fBBitsPerPixel\fR>8 -.TP 20 -\fBBitsPerPixel\fR -The number of bits used to represent each pixel in a surface\&. Usually 8, 16, 24 or 32\&. -.TP 20 -\fBBytesPerPixel\fR -The number of bytes used to represent each pixel in a surface\&. Usually one to four\&. -.TP 20 -\fB[RGBA]mask\fR -Binary mask used to retrieve individual color values -.TP 20 -\fB[RGBA]loss\fR -Precision loss of each color component (2^[RGBA]loss) -.TP 20 -\fB[RGBA]shift\fR -Binary left shift of each color component in the pixel value -.TP 20 -\fBcolorkey\fR -Pixel value of transparent pixels -.TP 20 -\fBalpha\fR -Overall surface alpha value -.SH "DESCRIPTION" -.PP -A \fBSDL_PixelFormat\fR describes the format of the pixel data stored at the \fBpixels\fR field of a \fI\fBSDL_Surface\fR\fR\&. Every surface stores a \fBSDL_PixelFormat\fR in the \fBformat\fR field\&. -.PP -If you wish to do pixel level modifications on a surface, then understanding how SDL stores its color information is essential\&. -.PP -8-bit pixel formats are the easiest to understand\&. Since its an 8-bit format, we have 8 \fBBitsPerPixel\fR and 1 \fBBytesPerPixel\fR\&. Since \fBBytesPerPixel\fR is 1, all pixels are represented by a Uint8 which contains an index into \fBpalette\fR->\fBcolors\fR\&. So, to determine the color of a pixel in a 8-bit surface: we read the color index from \fBsurface\fR->\fBpixels\fR and we use that index to read the \fI\fBSDL_Color\fR\fR structure from \fBsurface\fR->\fBformat\fR->\fBpalette\fR->\fBcolors\fR\&. Like so: -.PP -.nf -\f(CWSDL_Surface *surface; -SDL_PixelFormat *fmt; -SDL_Color *color; -Uint8 index; - -\&. -\&. - -/* Create surface */ -\&. -\&. -fmt=surface->format; - -/* Check the bitdepth of the surface */ -if(fmt->BitsPerPixel!=8){ - fprintf(stderr, "Not an 8-bit surface\&. -"); - return(-1); -} - -/* Lock the surface */ -SDL_LockSurface(surface); - -/* Get the topleft pixel */ -index=*(Uint8 *)surface->pixels; -color=fmt->palette->colors[index]; - -/* Unlock the surface */ -SDL_UnlockSurface(surface); -printf("Pixel Color-> Red: %d, Green: %d, Blue: %d\&. Index: %d -", - color->r, color->g, color->b, index); -\&. -\&.\fR -.fi -.PP -.PP -Pixel formats above 8-bit are an entirely different experience\&. They are considered to be "TrueColor" formats and the color information is stored in the pixels themselves, not in a palette\&. The mask, shift and loss fields tell us how the color information is encoded\&. The mask fields allow us to isolate each color component, the shift fields tell us the number of bits to the right of each component in the pixel value and the loss fields tell us the number of bits lost from each component when packing 8-bit color component in a pixel\&. -.PP -.nf -\f(CW/* Extracting color components from a 32-bit color value */ -SDL_PixelFormat *fmt; -SDL_Surface *surface; -Uint32 temp, pixel; -Uint8 red, green, blue, alpha; -\&. -\&. -\&. -fmt=surface->format; -SDL_LockSurface(surface); -pixel=*((Uint32*)surface->pixels); -SDL_UnlockSurface(surface); - -/* Get Red component */ -temp=pixel&fmt->Rmask; /* Isolate red component */ -temp=temp>>fmt->Rshift;/* Shift it down to 8-bit */ -temp=temp<Rloss; /* Expand to a full 8-bit number */ -red=(Uint8)temp; - -/* Get Green component */ -temp=pixel&fmt->Gmask; /* Isolate green component */ -temp=temp>>fmt->Gshift;/* Shift it down to 8-bit */ -temp=temp<Gloss; /* Expand to a full 8-bit number */ -green=(Uint8)temp; - -/* Get Blue component */ -temp=pixel&fmt->Bmask; /* Isolate blue component */ -temp=temp>>fmt->Bshift;/* Shift it down to 8-bit */ -temp=temp<Bloss; /* Expand to a full 8-bit number */ -blue=(Uint8)temp; - -/* Get Alpha component */ -temp=pixel&fmt->Amask; /* Isolate alpha component */ -temp=temp>>fmt->Ashift;/* Shift it down to 8-bit */ -temp=temp<Aloss; /* Expand to a full 8-bit number */ -alpha=(Uint8)temp; - -printf("Pixel Color -> R: %d, G: %d, B: %d, A: %d -", red, green, blue, alpha); -\&. -\&. -\&.\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_Surface\fR\fR, \fI\fBSDL_MapRGB\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_PollEvent.3 --- a/docs/man3/SDL_PollEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,44 +0,0 @@ -.TH "SDL_PollEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_PollEvent \- Polls for currently pending events\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_PollEvent\fP\fR(\fBSDL_Event *event\fR); -.SH "DESCRIPTION" -.PP -Polls for currently pending events, and returns \fB1\fR if there are any pending events, or \fB0\fR if there are none available\&. -.PP -If \fBevent\fR is not \fBNULL\fP, the next event is removed from the queue and stored in that area\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWSDL_Event event; /* Event structure */ - -\&. -\&. -\&. -/* Check for events */ -while(SDL_PollEvent(&event)){ /* Loop until there are no events left on the queue */ - switch(event\&.type){ /* Process the appropiate event type */ - case SDL_KEYDOWN: /* Handle a KEYDOWN event */ - printf("Oh! Key press -"); - break; - case SDL_MOUSEMOTION: - \&. - \&. - \&. - default: /* Report an unhandled event */ - printf("I don\&'t know what this event is! -"); - } -}\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_WaitEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_PumpEvents.3 --- a/docs/man3/SDL_PumpEvents.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,23 +0,0 @@ -.TH "SDL_PumpEvents" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_PumpEvents \- Pumps the event loop, gathering events from the input devices\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_PumpEvents\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -Pumps the event loop, gathering events from the input devices\&. -.PP -\fBSDL_PumpEvents\fP gathers all the pending input information from devices and places it on the event queue\&. Without calls to \fBSDL_PumpEvents\fP no events would ever be placed on the queue\&. Often calls the need for \fBSDL_PumpEvents\fP is hidden from the user since \fI\fBSDL_PollEvent\fP\fR and \fI\fBSDL_WaitEvent\fP\fR implicitly call \fBSDL_PumpEvents\fP\&. However, if you are not polling or waiting for events (e\&.g\&. your filtering them), then you must call \fBSDL_PumpEvents\fP to force an event queue update\&. -.PP -.RS -\fBNote: -.PP -You can only call this function in the thread that set the video mode\&. -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_PollEvent\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_PushEvent.3 --- a/docs/man3/SDL_PushEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,27 +0,0 @@ -.TH "SDL_PushEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_PushEvent \- Pushes an event onto the event queue -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_PushEvent\fP\fR(\fBSDL_Event *event\fR); -.SH "DESCRIPTION" -.PP -The event queue can actually be used as a two way communication channel\&. Not only can events be read from the queue, but the user can also push their own events onto it\&. \fBevent\fR is a pointer to the event structure you wish to push onto the queue\&. -.PP -.RS -\fBNote: -.PP -Pushing device input events onto the queue doesn\&'t modify the state of the device within SDL\&. -.RE -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on success or \fB-1\fR if the event couldn\&'t be pushed\&. -.SH "EXAMPLES" -.PP -See \fI\fBSDL_Event\fR\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR, \fI\fBSDL_Event\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_Quit.3 --- a/docs/man3/SDL_Quit.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,29 +0,0 @@ -.TH "SDL_Quit" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_Quit \- Shut down SDL -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_Quit\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_Quit\fP shuts down all SDL subsystems and frees the resources allocated to them\&. This should always be called before you exit\&. For the sake of simplicity you can set \fBSDL_Quit\fP as your \fBatexit\fP call, like: -.PP -.nf -\f(CWSDL_Init(SDL_INIT_VIDEO|SDL_INIT_AUDIO); -atexit(SDL_Quit); -\&. -\&.\fR -.fi -.PP -.PP -.RS -\fBNote: -.PP -While using \fBatexit\fP maybe be fine for small programs, more advanced users should shut down SDL in their own cleanup code\&. Plus, using \fBatexit\fP in a library is a sure way to crash dynamically loaded code -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_QuitSubsystem\fP\fR, \fI\fBSDL_Init\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_QuitEvent.3 --- a/docs/man3/SDL_QuitEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -.TH "SDL_QuitEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_QuitEvent \- Quit requested event -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type -} SDL_QuitEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_QUIT\fP -.SH "DESCRIPTION" -.PP -\fBSDL_QuitEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used whan an event of type \fBSDL_QUIT\fP is reported\&. -.PP -As can be seen, the SDL_QuitEvent structure serves no useful purpose\&. The event itself, on the other hand, is very important\&. If you filter out or ignore a quit event then it is impossible for the user to close the window\&. On the other hand, if you do accept a quit event then the application window will be closed, and screen updates will still report success event though the application will no longer be visible\&. -.PP -.RS -\fBNote: -.PP -The macro \fBSDL_QuitRequested\fP will return non-zero if a quit event is pending -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetEventFilter\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_QuitSubSystem.3 --- a/docs/man3/SDL_QuitSubSystem.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_QuitSubSystem" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_QuitSubSystem \- Shut down a subsystem -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_QuitSubSystem\fP\fR(\fBUint32 flags\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_QuitSubSystem\fP allows you to shut down a subsystem that has been previously initialized by \fI\fBSDL_Init\fP\fR or \fI\fBSDL_InitSubSystem\fP\fR\&. The \fBflags\fR tells \fBSDL_QuitSubSystem\fP which subsystems to shut down, it uses the same values that are passed to \fI\fBSDL_Init\fP\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Quit\fP\fR, \fI\fBSDL_Init\fP\fR, \fI\fBSDL_InitSubSystem\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_RWFromFile.3 --- a/docs/man3/SDL_RWFromFile.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_FunctionName" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_FunctionName \- Short description of function -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBreturn type\fBSDL_FunctionName\fP\fR(\fBparameter\fR); -.SH "DESCRIPTION" -.PP -Full description -.SH "EXAMPLES" -.PP -examples here -.SH "SEE ALSO" -.PP -\fISDL_AnotherFunction\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_Rect.3 --- a/docs/man3/SDL_Rect.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,26 +0,0 @@ -.TH "SDL_Rect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_Rect \- Defines a rectangular area -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Sint16 x, y; - Uint16 w, h; -} SDL_Rect;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBx, y\fR -Position of the upper-left corner of the rectangle -.TP 20 -\fBw, h\fR -The width and height of the rectangle -.SH "DESCRIPTION" -.PP -A \fBSDL_Rect\fR defines a rectangular area of pixels\&. It is used by \fI\fBSDL_BlitSurface\fP\fR to define blitting regions and by several other video functions\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_UpdateRect\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_RemoveTimer.3 --- a/docs/man3/SDL_RemoveTimer.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,25 +0,0 @@ -.TH "SDL_RemoveTimer" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_RemoveTimer \- Remove a timer which was added with \fISDL_AddTimer\fR\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_bool \fBSDL_RemoveTimer\fP\fR(\fBSDL_TimerID id\fR); -.SH "DESCRIPTION" -.PP -Removes a timer callback previously added with \fISDL_AddTimer\fR\&. -.SH "RETURN VALUE" -.PP -Returns a boolean value indicating success\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWSDL_RemoveTimer(my_timer_id);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_AddTimer\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_ResizeEvent.3 --- a/docs/man3/SDL_ResizeEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,28 +0,0 @@ -.TH "SDL_ResizeEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_ResizeEvent \- Window resize event structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type; - int w, h; -} SDL_ResizeEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_VIDEORESIZE\fP -.TP 20 -\fBw\fR, \fBh\fR -New width and height of the window -.SH "DESCRIPTION" -.PP -\fBSDL_ResizeEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_VIDEORESIZE\fP is reported\&. -.PP -When \fBSDL_RESIZABLE\fP is passed as a \fBflag\fR to \fI\fBSDL_SetVideoMode\fP\fR the user is allowed to resize the applications window\&. When the window is resized an \fBSDL_VIDEORESIZE\fP is report, with the new window width and height values stored in \fBw\fR and \fBh\fR, respectively\&. When an \fBSDL_VIDEORESIZE\fP is received the window should be resized to the new dimensions using \fI\fBSDL_SetVideoMode\fP\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetVideoMode\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SaveBMP.3 --- a/docs/man3/SDL_SaveBMP.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_SaveBMP" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SaveBMP \- Save an SDL_Surface as a Windows BMP file\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_SaveBMP\fP\fR(\fBSDL_Surface *surface, const char *file\fR); -.SH "DESCRIPTION" -.PP -Saves the \fBSDL_Surface\fR \fBsurface\fR as a Windows BMP file named \fBfile\fR\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR if successful or \fB-1\fR if there was an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_LoadBMP\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SemPost.3 --- a/docs/man3/SDL_SemPost.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,28 +0,0 @@ -.TH "SDL_SemPost" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SemPost \- Unlock a semaphore\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBint \fBSDL_SemPost\fP\fR(\fBSDL_sem *sem\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_SemPost\fP unlocks the semaphore pointed to by \fBsem\fR and atomically increments the semaphores value\&. Threads that were blocking on the semaphore may be scheduled after this call succeeds\&. -.PP -\fBSDL_SemPost\fP should be called after a semaphore is locked by a successful call to \fISDL_SemWait\fR, \fISDL_SemTryWait\fR or \fISDL_SemWaitTimeout\fR\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR if successful or \fB-1\fR if there was an error (leaving the semaphore unchanged)\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWSDL_SemPost(my_sem);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SemTryWait.3 --- a/docs/man3/SDL_SemTryWait.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,41 +0,0 @@ -.TH "SDL_SemTryWait" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SemTryWait \- Attempt to lock a semaphore but don\&'t suspend the thread\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBint \fBSDL_SemTryWait\fP\fR(\fBSDL_sem *sem\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_SemTryWait\fP is a non-blocking varient of \fI\fBSDL_SemWait\fP\fR\&. If the value of the semaphore pointed to by \fBsem\fR is positive it will atomically decrement the semaphore value and return 0, otherwise it will return \fBSDL_MUTEX_TIMEOUT\fR instead of suspending the thread\&. -.PP -After \fBSDL_SemTryWait\fP is successful, the semaphore can be released and its count atomically incremented by a successful call to \fISDL_SemPost\fR\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR if the semaphore was successfully locked or either \fBSDL_MUTEX_TIMEOUT\fR or \fB-1\fR if the thread would have suspended or there was an error, respectivly\&. -.PP -If the semaphore was not successfully locked, the semaphore will be unchanged\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWres = SDL_SemTryWait(my_sem); - -if (res == SDL_MUTEX_TIMEOUT) { - return TRY_AGAIN; -} -if (res == -1) { - return WAIT_ERROR; -} - -\&.\&.\&. - -SDL_SemPost(my_sem);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SemValue.3 --- a/docs/man3/SDL_SemValue.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,26 +0,0 @@ -.TH "SDL_SemValue" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SemValue \- Return the current value of a semaphore\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL/SDL_thread\&.h" -.sp -\fBUint32 \fBSDL_SemValue\fP\fR(\fBSDL_sem *sem\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_SemValue()\fP returns the current semaphore value from the semaphore pointed to by \fBsem\fR\&. -.SH "RETURN VALUE" -.PP -Returns current value of the semaphore\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CW sem_value = SDL_SemValue(my_sem);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SemWait.3 --- a/docs/man3/SDL_SemWait.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,34 +0,0 @@ -.TH "SDL_SemWait" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SemWait \- Lock a semaphore and suspend the thread if the semaphore value is zero\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBint \fBSDL_SemWait\fP\fR(\fBSDL_sem *sem\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_SemWait()\fP suspends the calling thread until either the semaphore pointed to by \fBsem\fR has a positive value, the call is interrupted by a signal or error\&. If the call is successful it will atomically decrement the semaphore value\&. -.PP -After \fBSDL_SemWait()\fP is successful, the semaphore can be released and its count atomically incremented by a successful call to \fISDL_SemPost\fR\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR if successful or \fB-1\fR if there was an error (leaving the semaphore unchanged)\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWif (SDL_SemWait(my_sem) == -1) { - return WAIT_FAILED; -} - -\&.\&.\&. - -SDL_SemPost(my_sem);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SemWaitTimeout.3 --- a/docs/man3/SDL_SemWaitTimeout.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,41 +0,0 @@ -.TH "SDL_SemWaitTimeout" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SemWaitTimeout \- Lock a semaphore, but only wait up to a specified maximum time\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBint \fBSDL_SemWaitTimeout\fP\fR(\fBSDL_sem *sem, Uint32 timeout\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_SemWaitTimeout()\fP is a varient of \fISDL_SemWait\fR with a maximum timeout value\&. If the value of the semaphore pointed to by \fBsem\fR is positive (greater than zero) it will atomically decrement the semaphore value and return 0, otherwise it will wait up to \fBtimeout\fR milliseconds trying to lock the semaphore\&. This function is to be avoided if possible since on some platforms it is implemented by polling the semaphore every millisecond in a busy loop\&. -.PP -After \fBSDL_SemWaitTimeout()\fP is successful, the semaphore can be released and its count atomically incremented by a successful call to \fISDL_SemPost\fR\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR if the semaphore was successfully locked or either \fBSDL_MUTEX_TIMEOUT\fR or \fB-1\fR if the timeout period was exceeded or there was an error, respectivly\&. -.PP -If the semaphore was not successfully locked, the semaphore will be unchanged\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWres = SDL_SemWaitTimeout(my_sem, WAIT_TIMEOUT_MILLISEC); - -if (res == SDL_MUTEX_TIMEOUT) { - return TRY_AGAIN; -} -if (res == -1) { - return WAIT_ERROR; -} - -\&.\&.\&. - -SDL_SemPost(my_sem);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetAlpha.3 --- a/docs/man3/SDL_SetAlpha.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,66 +0,0 @@ -.TH "SDL_SetAlpha" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetAlpha \- Adjust the alpha properties of a surface -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_SetAlpha\fP\fR(\fBSDL_Surface *surface, Uint32 flag, Uint8 alpha\fR); -.SH "DESCRIPTION" -.PP -.RS -\fBNote: -.PP -This function and the semantics of SDL alpha blending have changed since version 1\&.1\&.4\&. Up until version 1\&.1\&.5, an alpha value of 0 was considered opaque and a value of 255 was considered transparent\&. This has now been inverted: 0 (\fBSDL_ALPHA_TRANSPARENT\fP) is now considered transparent and 255 (\fBSDL_ALPHA_OPAQUE\fP) is now considered opaque\&. -.RE -.PP -\fBSDL_SetAlpha\fP is used for setting the per-surface alpha value and/or enabling and disabling alpha blending\&. -.PP -The\fBsurface\fR parameter specifies which surface whose alpha attributes you wish to adjust\&. \fBflags\fR is used to specify whether alpha blending should be used (\fBSDL_SRCALPHA\fP) and whether the surface should use RLE acceleration for blitting (\fBSDL_RLEACCEL\fP)\&. \fBflags\fR can be an OR\&'d combination of these two options, one of these options or 0\&. If \fBSDL_SRCALPHA\fP is not passed as a flag then all alpha information is ignored when blitting the surface\&. The \fBalpha\fR parameter is the per-surface alpha value; a surface need not have an alpha channel to use per-surface alpha and blitting can still be accelerated with \fBSDL_RLEACCEL\fP\&. -.PP -.RS -\fBNote: -.PP -The per-surface alpha value of 128 is considered a special case and is optimised, so it\&'s much faster than other per-surface values\&. -.RE -.PP -Alpha effects surface blitting in the following ways: -.TP 20 -RGBA->RGB with \fBSDL_SRCALPHA\fP -The source is alpha-blended with the destination, using the alpha channel\&. \fBSDL_SRCCOLORKEY\fP and the per-surface alpha are ignored\&. -.TP 20 -RGBA->RGB without \fBSDL_SRCALPHA\fP -The RGB data is copied from the source\&. The source alpha channel and the per-surface alpha value are ignored\&. -.TP 20 -RGB->RGBA with \fBSDL_SRCALPHA\fP -The source is alpha-blended with the destination using the per-surface alpha value\&. If \fBSDL_SRCCOLORKEY\fP is set, only the pixels not matching the colorkey value are copied\&. The alpha channel of the copied pixels is set to opaque\&. -.TP 20 -RGB->RGBA without \fBSDL_SRCALPHA\fP -The RGB data is copied from the source and the alpha value of the copied pixels is set to opaque\&. If \fBSDL_SRCCOLORKEY\fP is set, only the pixels not matching the colorkey value are copied\&. -.TP 20 -RGBA->RGBA with \fBSDL_SRCALPHA\fP -The source is alpha-blended with the destination using the source alpha channel\&. The alpha channel in the destination surface is left untouched\&. \fBSDL_SRCCOLORKEY\fP is ignored\&. -.TP 20 -RGBA->RGBA without \fBSDL_SRCALPHA\fP -The RGBA data is copied to the destination surface\&. If \fBSDL_SRCCOLORKEY\fP is set, only the pixels not matching the colorkey value are copied\&. -.TP 20 -RGB->RGB with \fBSDL_SRCALPHA\fP -The source is alpha-blended with the destination using the per-surface alpha value\&. If \fBSDL_SRCCOLORKEY\fP is set, only the pixels not matching the colorkey value are copied\&. -.TP 20 -RGB->RGB without \fBSDL_SRCALPHA\fP -The RGB data is copied from the source\&. If \fBSDL_SRCCOLORKEY\fP is set, only the pixels not matching the colorkey value are copied\&. -.PP -.RS -\fBNote: -.PP - Note that RGBA->RGBA blits (with SDL_SRCALPHA set) keep the alpha of the destination surface\&. This means that you cannot compose two arbitrary RGBA surfaces this way and get the result you would expect from "overlaying" them; the destination alpha will work as a mask\&. -.PP -Also note that per-pixel and per-surface alpha cannot be combined; the per-pixel alpha is always used if available -.RE -.SH "RETURN VALUE" -.PP -This function returns \fB0\fR, or \fB-1\fR if there was an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_GetRGBA\fP\fR, \fI\fBSDL_DisplayFormatAlpha\fP\fR, \fI\fBSDL_BlitSurface\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetClipRect.3 --- a/docs/man3/SDL_SetClipRect.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,19 +0,0 @@ -.TH "SDL_SetClipRect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetClipRect \- Sets the clipping rectangle for a surface\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_SetClipRect\fP\fR(\fBSDL_Surface *surface, SDL_Rect *rect\fR); -.SH "DESCRIPTION" -.PP -Sets the clipping rectangle for a surface\&. When this surface is the destination of a blit, only the area within the clip rectangle will be drawn into\&. -.PP -The rectangle pointed to by \fBrect\fR will be clipped to the edges of the surface so that the clip rectangle for a surface can never fall outside the edges of the surface\&. -.PP -If \fBrect\fR is \fBNULL\fP the clipping rectangle will be set to the full size of the surface\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_GetClipRect\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetColorKey.3 --- a/docs/man3/SDL_SetColorKey.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,26 +0,0 @@ -.TH "SDL_SetColorKey" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetColorKey \- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_SetColorKey\fP\fR(\fBSDL_Surface *surface, Uint32 flag, Uint32 key\fR); -.SH "DESCRIPTION" -.PP - Sets the color key (transparent pixel) in a blittable surface and enables or disables RLE blit acceleration\&. -.PP -RLE acceleration can substantially speed up blitting of images with large horizontal runs of transparent pixels (i\&.e\&., pixels that match the \fBkey\fR value)\&. The \fBkey\fR must be of the same pixel format as the \fBsurface\fR, \fI\fBSDL_MapRGB\fP\fR is often useful for obtaining an acceptable value\&. -.PP -If \fBflag\fR is \fBSDL_SRCCOLORKEY\fP then \fBkey\fR is the transparent pixel value in the source image of a blit\&. -.PP -If \fBflag\fR is OR\&'d with \fBSDL_RLEACCEL\fP then the surface will be draw using RLE acceleration when drawn with \fISDL_BlitSurface\fR\&. The surface will actually be encoded for RLE acceleration the first time \fISDL_BlitSurface\fR or \fISDL_DisplayFormat\fR is called on the surface\&. -.PP -If \fBflag\fR is 0, this function clears any current color key\&. -.SH "RETURN VALUE" -.PP -This function returns \fB0\fR, or \fB-1\fR if there was an error\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_DisplayFormat\fP\fR, \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_SetAlpha\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetColors.3 --- a/docs/man3/SDL_SetColors.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,57 +0,0 @@ -.TH "SDL_SetColors" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetColors \- Sets a portion of the colormap for the given 8-bit surface\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_SetColors\fP\fR(\fBSDL_Surface *surface, SDL_Color *colors, int firstcolor, int ncolors\fR); -.SH "DESCRIPTION" -.PP -Sets a portion of the colormap for the given 8-bit surface\&. -.PP -When \fBsurface\fR is the surface associated with the current display, the display colormap will be updated with the requested colors\&. If \fBSDL_HWPALETTE\fP was set in \fISDL_SetVideoMode\fR flags, \fBSDL_SetColors\fP will always return \fB1\fR, and the palette is guaranteed to be set the way you desire, even if the window colormap has to be warped or run under emulation\&. -.PP -The color components of a \fI\fBSDL_Color\fR\fR structure are 8-bits in size, giving you a total of 256^3 =16777216 colors\&. -.PP -Palettized (8-bit) screen surfaces with the \fBSDL_HWPALETTE\fP flag have two palettes, a logical palette that is used for mapping blits to/from the surface and a physical palette (that determines how the hardware will map the colors to the display)\&. \fBSDL_SetColors\fP modifies both palettes (if present), and is equivalent to calling \fISDL_SetPalette\fR with the \fBflags\fR set to \fB(SDL_LOGPAL | SDL_PHYSPAL)\fP\&. -.SH "RETURN VALUE" -.PP -If \fBsurface\fR is not a palettized surface, this function does nothing, returning \fB0\fR\&. If all of the colors were set as passed to \fBSDL_SetColors\fP, it will return \fB1\fR\&. If not all the color entries were set exactly as given, it will return \fB0\fR, and you should look at the surface palette to determine the actual color palette\&. -.SH "EXAMPLE" -.PP -.nf -\f(CW/* Create a display surface with a grayscale palette */ -SDL_Surface *screen; -SDL_Color colors[256]; -int i; -\&. -\&. -\&. -/* Fill colors with color information */ -for(i=0;i<256;i++){ - colors[i]\&.r=i; - colors[i]\&.g=i; - colors[i]\&.b=i; -} - -/* Create display */ -screen=SDL_SetVideoMode(640, 480, 8, SDL_HWPALETTE); -if(!screen){ - printf("Couldn\&'t set video mode: %s -", SDL_GetError()); - exit(-1); -} - -/* Set palette */ -SDL_SetColors(screen, colors, 0, 256); -\&. -\&. -\&. -\&.\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_Color\fR\fR \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_SetPalette\fP\fR, \fI\fBSDL_SetVideoMode\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetCursor.3 --- a/docs/man3/SDL_SetCursor.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_SetCursor" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetCursor \- Set the currently active mouse cursor\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_SetCursor\fP\fR(\fBSDL_Cursor *cursor\fR); -.SH "DESCRIPTION" -.PP -Sets the currently active cursor to the specified one\&. If the cursor is currently visible, the change will be immediately represented on the display\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_GetCursor\fP\fR, \fI\fBSDL_CreateCursor\fP\fR, \fI\fBSDL_ShowCursor\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetEventFilter.3 --- a/docs/man3/SDL_SetEventFilter.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,35 +0,0 @@ -.TH "SDL_SetEventFilter" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetEventFilter \- Sets up a filter to process all events before they are posted to the event queue\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_SetEventFilter\fP\fR(\fBSDL_EventFilter filter\fR); -.SH "DESCRIPTION" -.PP -This function sets up a filter to process all events before they are posted to the event queue\&. This is a very powerful and flexible feature\&. The filter is prototyped as: -.PP -.nf -\f(CWtypedef int (*SDL_EventFilter)(const SDL_Event *event);\fR -.fi -.PP - If the filter returns \fB1\fR, then the event will be added to the internal queue\&. If it returns \fB0\fR, then the event will be dropped from the queue\&. This allows selective filtering of dynamically\&. -.PP -There is one caveat when dealing with the \fBSDL_QUITEVENT\fP event type\&. The event filter is only called when the window manager desires to close the application window\&. If the event filter returns 1, then the window will be closed, otherwise the window will remain open if possible\&. If the quit event is generated by an interrupt signal, it will bypass the internal queue and be delivered to the application at the next event poll\&. -.PP -.RS -\fBNote: -.PP -Events pushed onto the queue with \fI\fBSDL_PushEvent\fP\fR or \fI\fBSDL_PeepEvents\fP\fR do not get passed through the event filter\&. -.RE -.PP -.RS -\fBNote: -.PP -\fIBe Careful!\fP The event filter function may run in a different thread so be careful what you do within it\&. -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_GetEventFilter\fP\fR, \fI\fBSDL_PushEvent\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetGamma.3 --- a/docs/man3/SDL_SetGamma.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -.TH "SDL_SetGamma" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetGamma \- Sets the color gamma function for the display -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_SetGamma\fP\fR(\fBfloat redgamma, float greengamma, float bluegamma\fR); -.SH "DESCRIPTION" -.PP -Sets the "gamma function" for the display of each color component\&. Gamma controls the brightness/contrast of colors displayed on the screen\&. A gamma value of 1\&.0 is identity (i\&.e\&., no adjustment is made)\&. -.PP -This function adjusts the gamma based on the "gamma function" parameter, you can directly specify lookup tables for gamma adjustment with \fISDL_SetGammaRamp\fR\&. -.PP -Not all display hardware is able to change gamma\&. -.SH "RETURN VALUE" -.PP -Returns -1 on error (or if gamma adjustment is not supported)\&. -.SH "SEE ALSO" -.PP -\fISDL_GetGammaRamp\fR \fISDL_SetGammaRamp\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetGammaRamp.3 --- a/docs/man3/SDL_SetGammaRamp.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,22 +0,0 @@ -.TH "SDL_SetGammaRamp" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetGammaRamp \- Sets the color gamma lookup tables for the display -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_SetGammaRamp\fP\fR(\fBUint16 *redtable, Uint16 *greentable, Uint16 *bluetable\fR); -.SH "DESCRIPTION" -.PP -Sets the gamma lookup tables for the display for each color component\&. Each table is an array of 256 Uint16 values, representing a mapping between the input and output for that channel\&. The input is the index into the array, and the output is the 16-bit gamma value at that index, scaled to the output color precision\&. You may pass NULL to any of the channels to leave them unchanged\&. -.PP -This function adjusts the gamma based on lookup tables, you can also have the gamma calculated based on a "gamma function" parameter with \fISDL_SetGamma\fR\&. -.PP -Not all display hardware is able to change gamma\&. -.SH "RETURN VALUE" -.PP -Returns -1 on error (or if gamma adjustment is not supported)\&. -.SH "SEE ALSO" -.PP -\fISDL_SetGamma\fR \fISDL_GetGammaRamp\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetModState.3 --- a/docs/man3/SDL_SetModState.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,35 +0,0 @@ -.TH "SDL_SetModState" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetModState \- Set the current key modifier state -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_SetModState\fP\fR(\fBSDLMod modstate\fR); -.SH "DESCRIPTION" -.PP -The inverse of \fI\fBSDL_GetModState\fP\fR, \fBSDL_SetModState\fP allows you to impose modifier key states on your application\&. -.PP -Simply pass your desired modifier states into \fBmodstate\fR\&. This value my be a logical OR\&'d combination of the following: -.PP -.nf -\f(CWtypedef enum { - KMOD_NONE = 0x0000, - KMOD_LSHIFT= 0x0001, - KMOD_RSHIFT= 0x0002, - KMOD_LCTRL = 0x0040, - KMOD_RCTRL = 0x0080, - KMOD_LALT = 0x0100, - KMOD_RALT = 0x0200, - KMOD_LMETA = 0x0400, - KMOD_RMETA = 0x0800, - KMOD_NUM = 0x1000, - KMOD_CAPS = 0x2000, - KMOD_MODE = 0x4000, -} SDLMod;\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_GetModState\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetPalette.3 --- a/docs/man3/SDL_SetPalette.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,59 +0,0 @@ -.TH "SDL_SetPalette" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetPalette \- Sets the colors in the palette of an 8-bit surface\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_SetPalette\fP\fR(\fBSDL_Surface *surface, int flags, SDL_Color *colors, int firstcolor, int ncolors\fR); -.SH "DESCRIPTION" -.PP -Sets a portion of the palette for the given 8-bit surface\&. -.PP -Palettized (8-bit) screen surfaces with the \fBSDL_HWPALETTE\fP flag have two palettes, a logical palette that is used for mapping blits to/from the surface and a physical palette (that determines how the hardware will map the colors to the display)\&. \fISDL_BlitSurface\fR always uses the logical palette when blitting surfaces (if it has to convert between surface pixel formats)\&. Because of this, it is often useful to modify only one or the other palette to achieve various special color effects (e\&.g\&., screen fading, color flashes, screen dimming)\&. -.PP -This function can modify either the logical or physical palette by specifing \fBSDL_LOGPAL\fP or \fBSDL_PHYSPAL\fPthe in the \fBflags\fR parameter\&. -.PP -When \fBsurface\fR is the surface associated with the current display, the display colormap will be updated with the requested colors\&. If \fBSDL_HWPALETTE\fP was set in \fISDL_SetVideoMode\fR flags, \fBSDL_SetPalette\fP will always return \fB1\fR, and the palette is guaranteed to be set the way you desire, even if the window colormap has to be warped or run under emulation\&. -.PP -The color components of a \fI\fBSDL_Color\fR\fR structure are 8-bits in size, giving you a total of 256^3=16777216 colors\&. -.SH "RETURN VALUE" -.PP -If \fBsurface\fR is not a palettized surface, this function does nothing, returning \fB0\fR\&. If all of the colors were set as passed to \fBSDL_SetPalette\fP, it will return \fB1\fR\&. If not all the color entries were set exactly as given, it will return \fB0\fR, and you should look at the surface palette to determine the actual color palette\&. -.SH "EXAMPLE" -.PP -.nf -\f(CW /* Create a display surface with a grayscale palette */ - SDL_Surface *screen; - SDL_Color colors[256]; - int i; - \&. - \&. - \&. - /* Fill colors with color information */ - for(i=0;i<256;i++){ - colors[i]\&.r=i; - colors[i]\&.g=i; - colors[i]\&.b=i; - } - - /* Create display */ - screen=SDL_SetVideoMode(640, 480, 8, SDL_HWPALETTE); - if(!screen){ - printf("Couldn\&'t set video mode: %s -", SDL_GetError()); - exit(-1); - } - - /* Set palette */ - SDL_SetPalette(screen, SDL_LOGPAL|SDL_PHYSPAL, colors, 0, 256); - \&. - \&. - \&. - \&.\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fISDL_SetColors\fR, \fISDL_SetVideoMode\fR, \fISDL_Surface\fR, \fISDL_Color\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetTimer.3 --- a/docs/man3/SDL_SetTimer.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,39 +0,0 @@ -.TH "SDL_SetTimer" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetTimer \- Set a callback to run after the specified number of milliseconds has elapsed\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_SetTimer\fP\fR(\fBUint32 interval, SDL_TimerCallback callback\fR); -.SH "CALLBACK" -.PP -/* Function prototype for the timer callback function */ typedef Uint32 (*SDL_TimerCallback)(Uint32 interval); -.SH "DESCRIPTION" -.PP -Set a callback to run after the specified number of milliseconds has elapsed\&. The callback function is passed the current timer interval and returns the next timer interval\&. If the returned value is the same as the one passed in, the periodic alarm continues, otherwise a new alarm is scheduled\&. -.PP -To cancel a currently running timer, call \fBSDL_SetTimer(0, NULL);\fP -.PP -The timer callback function may run in a different thread than your main constant, and so shouldn\&'t call any functions from within itself\&. -.PP -The maximum resolution of this timer is 10 ms, which means that if you request a 16 ms timer, your callback will run approximately 20 ms later on an unloaded system\&. If you wanted to set a flag signaling a frame update at 30 frames per second (every 33 ms), you might set a timer for 30 ms (see example below)\&. -.PP -If you use this function, you need to pass \fBSDL_INIT_TIMER\fP to \fBSDL_Init()\fP\&. -.PP -.RS -\fBNote: -.PP -This function is kept for compatibility but has been superseded by the new timer functions \fISDL_AddTimer\fR and \fISDL_RemoveTimer\fR which support multiple timers\&. -.RE -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWSDL_SetTimer((33/10)*10, my_callback);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_AddTimer\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SetVideoMode.3 --- a/docs/man3/SDL_SetVideoMode.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,67 +0,0 @@ -.TH "SDL_SetVideoMode" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SetVideoMode \- Set up a video mode with the specified width, height and bits-per-pixel\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_Surface *\fBSDL_SetVideoMode\fP\fR(\fBint width, int height, int bpp, Uint32 flags\fR); -.SH "DESCRIPTION" -.PP -Set up a video mode with the specified width, height and bits-per-pixel\&. -.PP -If \fBbpp\fR is 0, it is treated as the current display bits per pixel\&. -.PP -The \fBflags\fR parameter is the same as the \fBflags\fR field of the \fI\fBSDL_Surface\fR\fR structure\&. OR\&'d combinations of the following values are valid\&. -.TP 20 -\fBSDL_SWSURFACE\fP -Create the video surface in system memory -.TP 20 -\fBSDL_HWSURFACE\fP -Create the video surface in video memory -.TP 20 -\fBSDL_ASYNCBLIT\fP -Enables the use of asynchronous updates of the display surface\&. This will usually slow down blitting on single CPU machines, but may provide a speed increase on SMP systems\&. -.TP 20 -\fBSDL_ANYFORMAT\fP -Normally, if a video surface of the requested bits-per-pixel (\fBbpp\fR) is not available, SDL will emulate one with a shadow surface\&. Passing \fBSDL_ANYFORMAT\fP prevents this and causes SDL to use the video surface, regardless of its pixel depth\&. -.TP 20 -\fBSDL_HWPALETTE\fP -Give SDL exclusive palette access\&. Without this flag you may not always get the the colors you request with \fI\fBSDL_SetColors\fP\fR or \fI\fBSDL_SetPalette\fP\fR\&. -.TP 20 -\fBSDL_DOUBLEBUF\fP -Enable hardware double buffering; only valid with SDL_HWSURFACE\&. Calling \fI\fBSDL_Flip\fP\fR will flip the buffers and update the screen\&. All drawing will take place on the surface that is not displayed at the moment\&. If double buffering could not be enabled then \fBSDL_Flip\fP will just perform a \fI\fBSDL_UpdateRect\fP\fR on the entire screen\&. -.TP 20 -\fBSDL_FULLSCREEN\fP -SDL will attempt to use a fullscreen mode\&. If a hardware resolution change is not possible (for whatever reason), the next higher resolution will be used and the display window centered on a black background\&. -.TP 20 -\fBSDL_OPENGL\fP -Create an OpenGL rendering context\&. You should have previously set OpenGL video attributes with \fI\fBSDL_GL_SetAttribute\fP\fR\&. -.TP 20 -\fBSDL_OPENGLBLIT\fP -Create an OpenGL rendering context, like above, but allow normal blitting operations\&. The screen (2D) surface may have an alpha channel, and \fI\fBSDL_UpdateRects\fP\fR must be used for updating changes to the screen surface\&. -.TP 20 -\fBSDL_RESIZABLE\fP -Create a resizable window\&. When the window is resized by the user a \fI\fBSDL_VIDEORESIZE\fP\fR event is generated and \fBSDL_SetVideoMode\fP can be called again with the new size\&. -.TP 20 -\fBSDL_NOFRAME\fP -If possible, \fBSDL_NOFRAME\fP causes SDL to create a window with no title bar or frame decoration\&. Fullscreen modes automatically have this flag set\&. -.PP -.RS -\fBNote: -.PP -Whatever \fBflags\fR \fBSDL_SetVideoMode\fP could satisfy are set in the \fBflags\fR member of the returned surface\&. -.RE -.PP -.RS -\fBNote: -.PP -The \fBbpp\fR parameter is the number of bits per pixel, so a \fBbpp\fR of 24 uses the packed representation of 3 bytes/pixel\&. For the more common 4 bytes/pixel mode, use a \fBbpp\fR of 32\&. Somewhat oddly, both 15 and 16 will request a 2 bytes/pixel mode, but different pixel formats\&. -.RE -.SH "RETURN VALUE" -.PP -The framebuffer surface, or \fBNULL\fR if it fails\&. The surface returned is freed by SDL_Quit() and should nt be freed by the caller\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_SetColors\fP\fR, \fI\fBSDL_Flip\fP\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_ShowCursor.3 --- a/docs/man3/SDL_ShowCursor.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,20 +0,0 @@ -.TH "SDL_ShowCursor" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_ShowCursor \- Toggle whether or not the cursor is shown on the screen\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_ShowCursor\fP\fR(\fBint toggle\fR); -.SH "DESCRIPTION" -.PP -Toggle whether or not the cursor is shown on the screen\&. Passing \fBSDL_ENABLE\fP displays the cursor and passing \fBSDL_DISABLE\fP hides it\&. The current state of the mouse cursor can be queried by passing \fBSDL_QUERY\fP, either \fBSDL_DISABLE\fP or \fBSDL_ENABLE\fP will be returned\&. -.PP -The cursor starts off displayed, but can be turned off\&. -.SH "RETURN VALUE" -.PP -Returns the current state of the cursor\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateCursor\fP\fR, \fI\fBSDL_SetCursor\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_Surface.3 --- a/docs/man3/SDL_Surface.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,96 +0,0 @@ -.TH "SDL_Surface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_Surface \- Graphical Surface Structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct SDL_Surface { - Uint32 flags; /* Read-only */ - SDL_PixelFormat *format; /* Read-only */ - int w, h; /* Read-only */ - Uint16 pitch; /* Read-only */ - void *pixels; /* Read-write */ - - /* clipping information */ - SDL_Rect clip_rect; /* Read-only */ - - /* Reference count -- used when freeing surface */ - int refcount; /* Read-mostly */ - - /* This structure also contains private fields not shown here */ -} SDL_Surface;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBflags\fR -Surface flags -.TP 20 -\fBformat\fR -Pixel \fIformat\fR -.TP 20 -\fBw, h\fR -Width and height of the surface -.TP 20 -\fBpitch\fR -Length of a surface scanline in bytes -.TP 20 -\fBpixels\fR -Pointer to the actual pixel data -.TP 20 -\fBclip_rect\fR -surface clip \fIrectangle\fR -.SH "DESCRIPTION" -.PP -\fBSDL_Surface\fR\&'s represent areas of "graphical" memory, memory that can be drawn to\&. The video framebuffer is returned as a \fBSDL_Surface\fR by \fI\fBSDL_SetVideoMode\fP\fR and \fI\fBSDL_GetVideoSurface\fP\fR\&. Most of the fields should be pretty obvious\&. \fBw\fR and \fBh\fR are the width and height of the surface in pixels\&. \fBpixels\fR is a pointer to the actual pixel data, the surface should be \fIlocked\fR before accessing this field\&. The \fBclip_rect\fR field is the clipping rectangle as set by \fI\fBSDL_SetClipRect\fP\fR\&. -.PP -The following are supported in the \fBflags\fR field\&. -.TP 20 -\fBSDL_SWSURFACE\fP -Surface is stored in system memory -.TP 20 -\fBSDL_HWSURFACE\fP -Surface is stored in video memory -.TP 20 -\fBSDL_ASYNCBLIT\fP -Surface uses asynchronous blits if possible -.TP 20 -\fBSDL_ANYFORMAT\fP -Allows any pixel-format (Display surface) -.TP 20 -\fBSDL_HWPALETTE\fP -Surface has exclusive palette -.TP 20 -\fBSDL_DOUBLEBUF\fP -Surface is double buffered (Display surface) -.TP 20 -\fBSDL_FULLSCREEN\fP -Surface is full screen (Display Surface) -.TP 20 -\fBSDL_OPENGL\fP -Surface has an OpenGL context (Display Surface) -.TP 20 -\fBSDL_OPENGLBLIT\fP -Surface supports OpenGL blitting (Display Surface) -.TP 20 -\fBSDL_RESIZABLE\fP -Surface is resizable (Display Surface) -.TP 20 -\fBSDL_HWACCEL\fP -Surface blit uses hardware acceleration -.TP 20 -\fBSDL_SRCCOLORKEY\fP -Surface use colorkey blitting -.TP 20 -\fBSDL_RLEACCEL\fP -Colorkey blitting is accelerated with RLE -.TP 20 -\fBSDL_SRCALPHA\fP -Surface blit uses alpha blending -.TP 20 -\fBSDL_PREALLOC\fP -Surface uses preallocated memory -.SH "SEE ALSO" -.PP -\fI\fBSDL_PixelFormat\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_SysWMEvent.3 --- a/docs/man3/SDL_SysWMEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,21 +0,0 @@ -.TH "SDL_SysWMEvent" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_SysWMEvent \- Platform-dependent window manager event\&. -.SH "DESCRIPTION" -.PP -The system window manager event contains a pointer to system-specific information about unknown window manager events\&. If you enable this event using \fI\fBSDL_EventState()\fP\fR, it will be generated whenever unhandled events are received from the window manager\&. This can be used, for example, to implement cut-and-paste in your application\&. -.PP -.nf -\f(CWtypedef struct { - Uint8 type; /* Always SDL_SysWM */ - } SDL_SysWMEvent;\fR -.fi -.PP - If you want to obtain system-specific information about the window manager, you can fill the version member of a \fBSDL_SysWMinfo\fR structure (details can be found in \fBSDL_syswm\&.h\fP, which must be included) using the \fBSDL_VERSION()\fP macro found in \fBSDL_version\&.h\fP, and pass it to the function: -.PP -.sp -\fBint \fBSDL_GetWMInfo\fP\fR(\fBSDL_SysWMinfo *info\fR); -.SH "SEE ALSO" -.PP -\fI\fBSDL_EventState\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_ThreadID.3 --- a/docs/man3/SDL_ThreadID.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,13 +0,0 @@ -.TH "SDL_ThreadID" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_ThreadID \- Get the 32-bit thread identifier for the current thread\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBUint32 \fBSDL_ThreadID\fP\fR(\fBvoid\fR) -.SH "DESCRIPTION" -.PP -Get the 32-bit thread identifier for the current thread\&. -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_UnlockAudio.3 --- a/docs/man3/SDL_UnlockAudio.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_UnlockAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" -.SH "NAME" -SDL_UnlockAudio \- Unlock the callback function -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_UnlockAudio\fP\fR(\fBvoid\fR) -.SH "DESCRIPTION" -.PP -Unlocks a previous \fI\fBSDL_LockAudio\fP\fR call\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_UnlockSurface.3 --- a/docs/man3/SDL_UnlockSurface.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -.TH "SDL_UnlockSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_UnlockSurface \- Unlocks a previously locked surface\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_UnlockSurface\fP\fR(\fBSDL_Surface *surface\fR); -.SH "DESCRIPTION" -.PP -Surfaces that were previously locked using \fBSDL_LockSurface\fP must be unlocked with \fBSDL_UnlockSurface\fP\&. Surfaces should be unlocked as soon as possible\&. -.PP -It should be noted that since 1\&.1\&.8, surface locks are recursive\&. See \fI\fBSDL_LockSurface\fP\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_LockSurface\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_UnlockYUVOverlay.3 --- a/docs/man3/SDL_UnlockYUVOverlay.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_UnlockYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_UnlockYUVOverlay \- Unlock an overlay -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_UnlockYUVOverlay\fP\fR(\fBSDL_Overlay *overlay\fR); -.SH "DESCRIPTION" -.PP -The opposite to \fI\fBSDL_LockYUVOverlay\fP\fR\&. Unlocks a previously locked overlay\&. An overlay must be unlocked before it can be displayed\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_UnlockYUVOverlay\fP\fR, \fI\fBSDL_CreateYUVOverlay\fP\fR, \fI\fBSDL_Overlay\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_UpdateRect.3 --- a/docs/man3/SDL_UpdateRect.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,19 +0,0 @@ -.TH "SDL_UpdateRect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_UpdateRect \- Makes sure the given area is updated on the given screen\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_UpdateRect\fP\fR(\fBSDL_Surface *screen, Sint32 x, Sint32 y, Sint32 w, Sint32 h\fR); -.SH "DESCRIPTION" -.PP -Makes sure the given area is updated on the given screen\&. The rectangle must be confined within the screen boundaries (no clipping is done)\&. -.PP -If \&'\fBx\fR\&', \&'\fBy\fR\&', \&'\fBw\fR\&' and \&'\fBh\fR\&' are all 0, \fBSDL_UpdateRect\fP will update the entire screen\&. -.PP -This function should not be called while \&'\fBscreen\fR\&' is \fIlocked\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_UpdateRects\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_LockSurface\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_UpdateRects.3 --- a/docs/man3/SDL_UpdateRects.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,25 +0,0 @@ -.TH "SDL_UpdateRects" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_UpdateRects \- Makes sure the given list of rectangles is updated on the given screen\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_UpdateRects\fP\fR(\fBSDL_Surface *screen, int numrects, SDL_Rect *rects\fR); -.SH "DESCRIPTION" -.PP -Makes sure the given list of rectangles is updated on the given screen\&. The rectangles must all be confined within the screen boundaries (no clipping is done)\&. -.PP -This function should not be called while \fBscreen\fR is \fIlocked\fR\&. -.PP -.RS -\fBNote: -.PP -It is adviced to call this function only once per frame, since each call has some processing overhead\&. This is no restriction since you can pass any number of rectangles each time\&. -.PP -The rectangles are not automatically merged or checked for overlap\&. In general, the programmer can use his knowledge about his particular rectangles to merge them in an efficient way, to avoid overdraw\&. -.RE -.SH "SEE ALSO" -.PP -\fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_LockSurface\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_UserEvent.3 --- a/docs/man3/SDL_UserEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,47 +0,0 @@ -.TH "SDL_UserEvent" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_UserEvent \- A user-defined event type -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 type; - int code; - void *data1; - void *data2; -} SDL_UserEvent;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBtype\fR -\fBSDL_USEREVENT\fP through to \fBSDL_NUMEVENTS-1\fP -.TP 20 -\fBcode\fR -User defined event code -.TP 20 -\fBdata1\fR -User defined data pointer -.TP 20 -\fBdata2\fR -User defined data pointer -.SH "DESCRIPTION" -.PP -\fBSDL_UserEvent\fR is in the \fBuser\fR member of the structure \fI\fBSDL_Event\fR\fR\&. This event is unique, it is never created by SDL but only by the user\&. The event can be pushed onto the event queue using \fI\fBSDL_PushEvent\fP\fR\&. The contents of the structure members or completely up to the programmer, the only requirement is that \fBtype\fR is a value from \fBSDL_USEREVENT\fP to \fBSDL_NUMEVENTS-1\fP (inclusive)\&. -.SH "EXAMPLES" -.PP -.PP -.nf -\f(CWSDL_Event event; - -event\&.type = SDL_USEREVENT; -event\&.user\&.code = my_event_code; -event\&.user\&.data1 = significant_data; -event\&.user\&.data2 = 0; -SDL_PushEvent(&event);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_PushEvent\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_VideoDriverName.3 --- a/docs/man3/SDL_VideoDriverName.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_VideoDriverName" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_VideoDriverName \- Obtain the name of the video driver -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBchar *\fBSDL_VideoDriverName\fP\fR(\fBchar *namebuf, int maxlen\fR); -.SH "DESCRIPTION" -.PP -The buffer pointed to by \fBnamebuf\fR is filled up to a maximum of \fBmaxlen\fR characters (include the NULL terminator) with the name of the initialised video driver\&. The driver name is a simple one word identifier like "x11" or "windib"\&. -.SH "RETURN VALUE" -.PP -Returns \fBNULL\fP if video has not been initialised with \fBSDL_Init\fP or a pointer to \fBnamebuf\fR otherwise\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Init\fP\fR \fI\fBSDL_InitSubSystem\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_VideoInfo.3 --- a/docs/man3/SDL_VideoInfo.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,62 +0,0 @@ -.TH "SDL_VideoInfo" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_VideoInfo \- Video Target information -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint32 hw_available:1; - Uint32 wm_available:1; - Uint32 blit_hw:1; - Uint32 blit_hw_CC:1; - Uint32 blit_hw_A:1; - Uint32 blit_sw:1; - Uint32 blit_sw_CC:1; - Uint32 blit_sw_A:1; - Uint32 blit_fill; - Uint32 video_mem; - SDL_PixelFormat *vfmt; -} SDL_VideoInfo;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBhw_available\fR -Is it possible to create hardware surfaces? -.TP 20 -\fBwm_available\fR -Is there a window manager available -.TP 20 -\fBblit_hw\fR -Are hardware to hardware blits accelerated? -.TP 20 -\fBblit_hw_CC\fR -Are hardware to hardware colorkey blits accelerated? -.TP 20 -\fBblit_hw_A\fR -Are hardware to hardware alpha blits accelerated? -.TP 20 -\fBblit_sw\fR -Are software to hardware blits accelerated? -.TP 20 -\fBblit_sw_CC\fR -Are software to hardware colorkey blits accelerated? -.TP 20 -\fBblit_sw_A\fR -Are software to hardware alpha blits accelerated? -.TP 20 -\fBblit_fill\fR -Are color fills accelerated? -.TP 20 -\fBvideo_mem\fR -Total amount of video memory in Kilobytes -.TP 20 -\fBvfmt\fR -\fIPixel format\fR of the video device -.SH "DESCRIPTION" -.PP -This (read-only) structure is returned by \fI\fBSDL_GetVideoInfo\fP\fR\&. It contains information on either the \&'best\&' available mode (if called before \fI\fBSDL_SetVideoMode\fP\fR) or the current video mode\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_GetVideoInfo\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_VideoModeOK.3 --- a/docs/man3/SDL_VideoModeOK.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,44 +0,0 @@ -.TH "SDL_VideoModeOK" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_VideoModeOK \- Check to see if a particular video mode is supported\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_VideoModeOK\fP\fR(\fBint width, int height, int bpp, Uint32 flags\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_VideoModeOK\fP returns \fB0\fR if the requested mode is not supported under any bit depth, or returns the bits-per-pixel of the closest available mode with the given width, height and requested \fIsurface\fR flags (see \fI\fBSDL_SetVideoMode\fP\fR)\&. -.PP -The bits-per-pixel value returned is only a suggested mode\&. You can usually request and bpp you want when \fIsetting\fR the video mode and SDL will emulate that color depth with a shadow video surface\&. -.PP -The arguments to \fBSDL_VideoModeOK\fP are the same ones you would pass to \fISDL_SetVideoMode\fR -.SH "EXAMPLE" -.PP -.nf -\f(CWSDL_Surface *screen; -Uint32 bpp; -\&. -\&. -\&. -printf("Checking mode 640x480@16bpp\&. -"); -bpp=SDL_VideoModeOK(640, 480, 16, SDL_HWSURFACE); - -if(!bpp){ - printf("Mode not available\&. -"); - exit(-1); -} - -printf("SDL Recommends 640x480@%dbpp\&. -", bpp); -screen=SDL_SetVideoMode(640, 480, bpp, SDL_HWSURFACE); -\&. -\&.\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_GetVideoInfo\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_WM_GetCaption.3 --- a/docs/man3/SDL_WM_GetCaption.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_WM_GetCaption" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_WM_GetCaption \- Gets the window title and icon name\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_WM_GetCaption\fP\fR(\fBchar **title, char **icon\fR); -.SH "DESCRIPTION" -.PP -Set pointers to the window \fBtitle\fR and \fBicon\fR name\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_WM_SetCaption\fP\fR, \fI\fBSDL_WM_SetIcon\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_WM_GrabInput.3 --- a/docs/man3/SDL_WM_GrabInput.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,28 +0,0 @@ -.TH "SDL_WM_GrabInput" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_WM_GrabInput \- Grabs mouse and keyboard input\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBSDL_GrabMode \fBSDL_WM_GrabInput\fP\fR(\fBSDL_GrabMode mode\fR); -.SH "DESCRIPTION" -.PP -Grabbing means that the mouse is confined to the application window, and nearly all keyboard input is passed directly to the application, and not interpreted by a window manager, if any\&. -.PP -When \fBmode\fR is \fBSDL_GRAB_QUERY\fP the grab mode is not changed, but the current grab mode is returned\&. -.PP -.PP -.nf -\f(CWtypedef enum { - SDL_GRAB_QUERY, - SDL_GRAB_OFF, - SDL_GRAB_ON -} SDL_GrabMode;\fR -.fi -.PP - -.SH "RETURN VALUE" -.PP -The current/new \fBSDL_GrabMode\fR\&. -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_WM_IconifyWindow.3 --- a/docs/man3/SDL_WM_IconifyWindow.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_WM_IconifyWindow" "3" "Tue 11 Sep 2001, 23:02" "SDL" "SDL API Reference" -.SH "NAME" -SDL_WM_IconifyWindow \- Iconify/Minimise the window -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_WM_IconifyWindow\fP\fR(\fBvoid\fR); -.SH "DESCRIPTION" -.PP -If the application is running in a window managed environment SDL attempts to iconify/minimise it\&. If \fBSDL_WM_IconifyWindow\fP is successful, the application will receive a \fI\fBSDL_APPACTIVE\fP\fR loss event\&. -.SH "RETURN VALUE" -.PP -Returns non-zero on success or \fB0\fR if iconification is not support or was refused by the window manager\&. -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:02 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_WM_SetCaption.3 --- a/docs/man3/SDL_WM_SetCaption.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_WM_SetCaption" "3" "Tue 11 Sep 2001, 23:02" "SDL" "SDL API Reference" -.SH "NAME" -SDL_WM_SetCaption \- Sets the window tile and icon name\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_WM_SetCaption\fP\fR(\fBconst char *title, const char *icon\fR); -.SH "DESCRIPTION" -.PP -Sets the title-bar and icon name of the display window\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_WM_GetCaption\fP\fR, \fI\fBSDL_WM_SetIcon\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:02 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_WM_SetIcon.3 --- a/docs/man3/SDL_WM_SetIcon.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,27 +0,0 @@ -.TH "SDL_WM_SetIcon" "3" "Tue 11 Sep 2001, 23:02" "SDL" "SDL API Reference" -.SH "NAME" -SDL_WM_SetIcon \- Sets the icon for the display window\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_WM_SetIcon\fP\fR(\fBSDL_Surface *icon, Uint8 *mask\fR); -.SH "DESCRIPTION" -.PP -Sets the icon for the display window\&. Win32 icons must be 32x32\&. -.PP -This function must be called before the first call to \fISDL_SetVideoMode\fR\&. -.PP -It takes an \fBicon\fR surface, and a \fBmask\fR in MSB format\&. -.PP -If \fBmask\fR is \fBNULL\fP, the entire icon surface will be used as the icon\&. -.SH "EXAMPLE" -.PP -.nf -\f(CWSDL_WM_SetIcon(SDL_LoadBMP("icon\&.bmp"), NULL);\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_WM_SetCaption\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:02 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_WM_ToggleFullScreen.3 --- a/docs/man3/SDL_WM_ToggleFullScreen.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_WM_ToggleFullScreen" "3" "Tue 11 Sep 2001, 23:02" "SDL" "SDL API Reference" -.SH "NAME" -SDL_WM_ToggleFullScreen \- Toggles fullscreen mode -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_WM_ToggleFullScreen\fP\fR(\fBSDL_Surface *surface\fR); -.SH "DESCRIPTION" -.PP -Toggles the application between windowed and fullscreen mode, if supported\&. (X11 is the only target currently supported, BeOS support is experimental)\&. -.SH "RETURN VALUE" -.PP -Returns \fB0\fR on failure or \fB1\fR on success\&. -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:02 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_WaitEvent.3 --- a/docs/man3/SDL_WaitEvent.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -.TH "SDL_WaitEvent" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_WaitEvent \- Waits indefinitely for the next available event\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBint \fBSDL_WaitEvent\fP\fR(\fBSDL_Event *event\fR); -.SH "DESCRIPTION" -.PP -Waits indefinitely for the next available event, returning \fB1\fR, or \fB0\fR if there was an error while waiting for events\&. -.PP -If \fBevent\fR is not \fBNULL\fP, the next event is removed from the queue and stored in that area\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_Event\fR\fR, \fI\fBSDL_PollEvent\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_WaitThread.3 --- a/docs/man3/SDL_WaitThread.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,19 +0,0 @@ -.TH "SDL_WaitThread" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_WaitThread \- Wait for a thread to finish\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBvoid \fBSDL_WaitThread\fP\fR(\fBSDL_Thread *thread, int *status\fR); -.SH "DESCRIPTION" -.PP -Wait for a thread to finish (timeouts are not supported)\&. -.SH "RETURN VALUE" -.PP -The return code for the thread function is placed in the area pointed to by \fBstatus\fR, if \fBstatus\fR is not \fBNULL\fR\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateThread\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_WarpMouse.3 --- a/docs/man3/SDL_WarpMouse.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -.TH "SDL_WarpMouse" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_WarpMouse \- Set the position of the mouse cursor\&. -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBvoid \fBSDL_WarpMouse\fP\fR(\fBUint16 x, Uint16 y\fR); -.SH "DESCRIPTION" -.PP -Set the position of the mouse cursor (generates a mouse motion event)\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_MouseMotionEvent\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_WasInit.3 --- a/docs/man3/SDL_WasInit.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,63 +0,0 @@ -.TH "SDL_WasInit" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_WasInit \- Check which subsystems are initialized -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -.sp -\fBUint32 \fBSDL_WasInit\fP\fR(\fBUint32 flags\fR); -.SH "DESCRIPTION" -.PP -\fBSDL_WasInit\fP allows you to see which SDL subsytems have been \fIinitialized\fR\&. \fBflags\fR is a bitwise OR\&'d combination of the subsystems you wish to check (see \fI\fBSDL_Init\fP\fR for a list of subsystem flags)\&. -.SH "RETURN VALUE" -.PP -\fBSDL_WasInit\fP returns a bitwised OR\&'d combination of the initialized subsystems\&. -.SH "EXAMPLES" -.PP -.nf -\f(CW -/* Here are several ways you can use SDL_WasInit() */ - -/* Get init data on all the subsystems */ -Uint32 subsystem_init; - -subsystem_init=SDL_WasInit(SDL_INIT_EVERYTHING); - -if(subsystem_init&SDL_INIT_VIDEO) - printf("Video is initialized\&. -"); -else - printf("Video is not initialized\&. -"); - - - -/* Just check for one specfic subsystem */ - -if(SDL_WasInit(SDL_INIT_VIDEO)!=0) - printf("Video is initialized\&. -"); -else - printf("Video is not initialized\&. -"); - - - - -/* Check for two subsystems */ - -Uint32 subsystem_mask=SDL_INIT_VIDEO|SDL_INIT_AUDIO; - -if(SDL_WasInit(subsystem_mask)==subsystem_mask) - printf("Video and Audio initialized\&. -"); -else - printf("Video and Audio not initialized\&. -"); -\fR -.fi -.PP -.SH "SEE ALSO" -.PP -\fI\fBSDL_Init\fP\fR, \fI\fBSDL_Subsystem\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_keysym.3 --- a/docs/man3/SDL_keysym.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,69 +0,0 @@ -.TH "SDL_keysym" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" -.SH "NAME" -SDL_keysym \- Keysym structure -.SH "STRUCTURE DEFINITION" -.PP -.nf -\f(CWtypedef struct{ - Uint8 scancode; - SDLKey sym; - SDLMod mod; - Uint16 unicode; -} SDL_keysym;\fR -.fi -.PP -.SH "STRUCTURE DATA" -.TP 20 -\fBscancode\fR -Hardware specific scancode -.TP 20 -\fBsym\fR -SDL virtual keysym -.TP 20 -\fBmod\fR -Current key modifiers -.TP 20 -\fBunicode\fR -Translated character -.SH "DESCRIPTION" -.PP -The \fBSDL_keysym\fR structure is used by reporting key presses and releases since it is a part of the \fI\fBSDL_KeyboardEvent\fR\fR\&. -.PP -The \fBscancode\fR field should generally be left alone, it is the hardware dependent scancode returned by the keyboard\&. The \fBsym\fR field is extremely useful\&. It is the SDL-defined value of the key (see \fISDL Key Syms\fR\&. This field is very useful when you are checking for certain key presses, like so: -.PP -.nf -\f(CW\&. -\&. -while(SDL_PollEvent(&event)){ - switch(event\&.type){ - case SDL_KEYDOWN: - if(event\&.key\&.keysym\&.sym==SDLK_LEFT) - move_left(); - break; - \&. - \&. - \&. - } -} -\&. -\&.\fR -.fi -.PP - \fBmod\fR stores the current state of the keyboard modifiers as explained in \fI\fBSDL_GetModState\fP\fR\&. The \fBunicode\fR is only used when UNICODE translation is enabled with \fI\fBSDL_EnableUNICODE\fP\fR\&. If \fBunicode\fR is non-zero then this a the UNICODE character corresponding to the keypress\&. If the high 9 bits of the character are 0, then this maps to the equivalent ASCII character: -.PP -.nf -\f(CWchar ch; -if ( (keysym\&.unicode & 0xFF80) == 0 ) { - ch = keysym\&.unicode & 0x7F; -} -else { - printf("An International Character\&. -"); -}\fR -.fi -.PP - UNICODE translation does have a slight overhead so don\&'t enable it unless its needed\&. -.SH "SEE ALSO" -.PP -\fI\fBSDLKey\fR\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_mutexP.3 --- a/docs/man3/SDL_mutexP.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_mutexP" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_mutexP \- Lock a mutex -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBint \fBSDL_mutexP\fP\fR(\fBSDL_mutex *mutex\fR); -.SH "DESCRIPTION" -.PP -Locks the \fBmutex\fR, which was previously created with \fI\fBSDL_CreateMutex\fP\fR\&. If the mutex is already locked then \fBSDL_mutexP\fP will not return until it is \fIunlocked\fR\&. Returns \fB0\fR on success, or \fB-1\fR on an error\&. -.PP -SDL also defines a macro \fB#define SDL_LockMutex(m) SDL_mutexP(m)\fP\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateMutex\fP\fR, \fI\fBSDL_mutexV\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff -r 8e0182c236d8 -r 6dc250ebdd80 docs/man3/SDL_mutexV.3 --- a/docs/man3/SDL_mutexV.3 Wed Oct 07 06:11:53 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,18 +0,0 @@ -.TH "SDL_mutexV" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" -.SH "NAME" -SDL_mutexV \- Unlock a mutex -.SH "SYNOPSIS" -.PP -\fB#include "SDL\&.h" -#include "SDL_thread\&.h" -.sp -\fBint \fBSDL_mutexV\fP\fR(\fBSDL_mutex *mutex\fR); -.SH "DESCRIPTION" -.PP -Unlocks the \fBmutex\fR, which was previously created with \fI\fBSDL_CreateMutex\fP\fR\&. Returns \fB0\fR on success, or \fB-1\fR on an error\&. -.PP -SDL also defines a macro \fB#define SDL_UnlockMutex(m) SDL_mutexV(m)\fP\&. -.SH "SEE ALSO" -.PP -\fI\fBSDL_CreateMutex\fP\fR, \fI\fBSDL_mutexP\fP\fR -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

API Documentation

Online Documentation

SDL 1.2.10 Release Notes

Chapter 10. Audio

Chapter 11. CD-ROM

Chapter 8. Events

Introduction

Event Functions.

SDL Event Structures.

Chapter 5. General

I. SDL Guide

About SDLdoc

Audio Examples

Opening the audio device

Playing audio

Initializing SDL

CDROM Examples

Listing CD-ROM drives

Opening the default drive

Listing the tracks on a CD

Play an entire CD

Credits

Event Examples

Filtering and Handling Events

Chapter 4. Examples

Introduction

Chapter 3. Input handling

Handling Joysticks

Initialization

Querying

Opening a Joystick and Receiving Joystick Events

Advanced Joystick Functions

Handling the Keyboard

Keyboard Related Structures

SDLKey

SDLMod

SDL_keysym

SDL_KeyboardEvent

Reading Keyboard Events

A More Detailed Look

Game-type Input

Preface

About SDL

Chapter 1. The Basics

Introduction

Time Examples

Time based game loop

Chapter 2. Graphics and Video

Introduction to SDL Video

Initializing the Video Display

Initializing the Best Video Mode

Loading and Displaying a BMP File

Drawing Directly to the Display

Using OpenGL With SDL

Initialisation

Drawing

Chapter 9. Joystick

II. SDL Reference

SDL_ActiveEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_AddTimer

Name

Synopsis

Callback

Description

Return Value

Examples

See Also

SDL_AudioCVT

Name

Structure Definition

Structure Data

Description

See Also

SDL_AudioSpec

Name