Mercurial > sdl-ios-xcode
view docs/man3/SDL_AudioSpec.3 @ 2268:4baee598306d
Date: Thu, 05 Jul 2007 14:02:33 -0700
From: Sam Lantinga
Subject: SDL 1.3 keyboard plan
After lots of discussion with Christian, this is what we came up with:
> So, to sum up...
> SDLK_* become the physical keys, starting at > (1<<21)
> We create a macro SDLK_INDEX(X)
> We have two functions SDL_GetLayoutKey(SDLKey) and SDL_GetKeyName()
> SDL_GetLayoutKey maps to UCS4 for printable characters, and SDLK* for
non-printable characters
> and does so based on the OS's current keyboard layout
> SDL_GetKeyName() handles both SDLK_* and UCS4, converting UCS4 to UTF-8 and
converting SDLK_* into our names, which are UTF-8 for printable characters.
> WASD folks use SDLK_*, and 'I' folks use SDL_GetLayoutKey(SDLK_*)
Here is the patch he came up with, and his e-mail about it:
Date: Fri, 17 Aug 2007 19:50:28 +0200
From: Christian Walther
Subject: Re: SDL 1.3 keyboard plan
> Sounds great, go ahead and send me a patch.
Here goes! Thanks for having a look. Don't hesitate to comment if
anything does not conform to your ideas.
One caveat: Committing this now may break compilability of some video
drivers - specifically, if they use any of the SDLK_* codes that were
obsoleted and moved into SDL_compat.h. I only tried Cocoa (which did
break, but is already fixed) and X11 (which didn't, but then its key
handling is #iffed out). If that's a problem, it may need to go into
a branch.
-Christian
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sun, 19 Aug 2007 14:52:52 +0000 |
| parents | e5bc29de3f0a |
| children | 546f7c1eb755 |
line wrap: on
line source
.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