This document contains documentation for the SDL, SDL_image, SDL_mixer, SDL_net, SDL_ttf, and SDL_audio libraries. It lists over 150 functions across these libraries for loading images, audio, fonts, networking and more. The functions allow accessing and manipulating surfaces, audio, files, textures and network resources.

1. Ring Documentation, Release 1.6
• int SDL_HapticRumbleSupported(SDL_Haptic *haptic)
• int SDL_HapticRunEffect(SDL_Haptic *haptic,int effect,Uint32 iterations)
• int SDL_HapticSetAutocenter(SDL_Haptic *haptic,int autocenter)
• int SDL_HapticSetGain(SDL_Haptic *haptic,int gain)
• int SDL_HapticStopAll(SDL_Haptic *haptic)
• int SDL_HapticStopEffect(SDL_Haptic *haptic,int effect)
• int SDL_HapticUnpause(SDL_Haptic *haptic)
• int SDL_HapticUpdateEffect(SDL_Haptic *haptic,int effect,SDL_HapticEffect *data)
• int SDL_JoystickIsHaptic(SDL_Joystick *joystick)
• int SDL_MouseIsHaptic(void)
• int SDL_NumHaptics(void)
• int SDL_AudioInit(const char * driver_name)
• void SDL_AudioQuit(void)
• int SDL_BuildAudioCVT(SDL_AudioCVT *cvt,SDL_AudioFormat src_format,Uint8 src_channels,int
src_rate,SDL_AudioFormat dst_format,Uint8 dst_channels,int dst_rate)
• void SDL_CloseAudioDevice(SDL_AudioDeviceID dev)
• int SDL_ConvertAudio(SDL_AudioCVT *cvt)
• void SDL_FreeWAV(Uint8 *audio_buf)
• const char * SDL_GetAudioDeviceName(int index,int iscapture)
• SDL_AudioStatus SDL_GetAudioDeviceStatus(SDL_AudioDeviceID dev)
• const char * SDL_GetAudioDriver(int index)
• SDL_AudioStatus SDL_GetAudioStatus(void)
• const char * SDL_GetCurrentAudioDriver(void)
• int SDL_GetNumAudioDevices(int iscapture)
• int SDL_GetNumAudioDrivers(void)
• SDL_AudioSpec *SDL_LoadWAV_RW(SDL_RWops *src,int freesrc,SDL_AudioSpec *spec,Uint8 **au-
dio_buf,Uint32 *audio_len)
• void SDL_LockAudio(void)
• void SDL_LockAudioDevice(SDL_AudioDeviceID dev)
• void SDL_MixAudio(Uint8 dst,const Uint8 src,Uint32 len,int volume)
• void SDL_MixAudioFormat(Uint8 *dst,const Uint8 *src,SDL_AudioFormat format,Uint32 len,int volume)
• int SDL_OpenAudio(SDL_AudioSpec *desired,SDL_AudioSpec *obtained)
• SDL_AudioDeviceID SDL_OpenAudioDevice(const char *device,int iscapture,const SDL_AudioSpec *de-
sired,SDL_AudioSpec *obtained,int allowed_changes)
• void SDL_PauseAudio(int pause_on)
• void SDL_PauseAudioDevice(SDL_AudioDeviceID dev,int pause_on)
• void SDL_UnlockAudio(void)
873

2. Ring Documentation, Release 1.6
• void SDL_UnlockAudioDevice(SDL_AudioDeviceID dev)
• char *SDL_GetBasePath(void)
• char *SDL_GetPrefPath(const char *org,const char *app)
• SDL_RWops *SDL_AllocRW(void)
• void SDL_FreeRW(SDL_RWops *area)
• SDL_RWops SDL_RWFromConstMem(const void mem,int size)
• SDL_RWops *SDL_RWFromFP(void *fp,SDL_bool autoclose)
• SDL_RWops *SDL_RWFromFile(const char *file,const char *mode)
• SDL_RWops *SDL_RWFromMem(void *mem,int size)
• int SDL_RWclose(struct SDL_RWops *context)
• size_t SDL_RWread(struct SDL_RWops *context,void *ptr,size_t size,size_t maxnum)
• Sint64 SDL_RWseek(SDL_RWops *context,Sint64 offset,int whence)
• Sint64 SDL_RWsize(SDL_RWops *context)
• Sint64 SDL_RWtell(struct SDL_RWops *context)
• size_t SDL_RWwrite(struct SDL_RWops *context,const void *ptr,size_t size,size_t num)
• Uint16 SDL_ReadBE16(SDL_RWops *src)
• Uint32 SDL_ReadBE32(SDL_RWops *src)
• Uint64 SDL_ReadBE64(SDL_RWops *src)
• Uint16 SDL_ReadLE16(SDL_RWops *src)
• Uint32 SDL_ReadLE32(SDL_RWops *src)
• Uint64 SDL_ReadLE64(SDL_RWops *src)
• Uint8 SDL_ReadU8(SDL_RWops *src)
• size_t SDL_WriteBE16(SDL_RWops *dst,Uint16 value)
• size_t SDL_WriteBE32(SDL_RWops *dst,Uint32 value)
• size_t SDL_WriteBE64(SDL_RWops *dst,Uint64 value)
• size_t SDL_WriteLE16(SDL_RWops *dst,Uint16 value)
• size_t SDL_WriteLE32(SDL_RWops *dst,Uint32 value)
• size_t SDL_WriteLE64(SDL_RWops *dst,Uint64 value)
• size_t SDL_WriteU8(SDL_RWops *dst,Uint8 value)
• void *SDL_LoadFunction(void *handle,const char *name)
• void *SDL_LoadObject(const char *sofile)
• void SDL_UnloadObject(void *handle)
• const char *SDL_GetPlatform(void)
• int SDL_GetCPUCacheLineSize(void)
• int SDL_GetCPUCount(void)
• int SDL_GetSystemRAM(void)
874

3. Ring Documentation, Release 1.6
• SDL_bool SDL_Has3DNow(void)
• SDL_bool SDL_HasAVX(void)
• SDL_bool SDL_HasMMX(void)
• SDL_bool SDL_HasRDTSC(void)
• SDL_bool SDL_HasSSE(void)
• SDL_bool SDL_HasSSE2(void)
• SDL_bool SDL_HasSSE3(void)
• SDL_bool SDL_HasSSE41(void)
• SDL_bool SDL_HasSSE42(void)
• SDL_PowerState SDL_GetPowerInfo(int *secs,int *pct)
• double SDL_acos(double x)
• int IMG_Init(int flags)
• void IMG_Quit(void)
• SDL_Surface *IMG_Load(const char *file)
• SDL_Surface *IMG_Load_RW(SDL_RWops *src, int freesrc)
• SDL_Surface *IMG_LoadTyped_RW(SDL_RWops *src, int freesrc, char *type)
• SDL_Surface *IMG_LoadCUR_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadBMP_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadPNM_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadXPM_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadXCF_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadPCX_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadGIF_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadJPG_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadTIF_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadPNG_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadTGA_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadLBM_RW(SDL_RWops *src)
• SDL_Surface *IMG_LoadXV_RW(SDL_RWops *src)
• SDL_Surface *IMG_ReadXPMFromArray(char **xpm)
• int IMG_isCUR(SDL_RWops *src)
• int IMG_isICO(SDL_RWops *src)
• int IMG_isBMP(SDL_RWops *src)
• int IMG_isPNM(SDL_RWops *src)
• int IMG_isXPM(SDL_RWops *src)
• int IMG_isXCF(SDL_RWops *src)
875

4. Ring Documentation, Release 1.6
• int IMG_isPCX(SDL_RWops *src)
• int IMG_isGIF(SDL_RWops *src)
• int IMG_isJPG(SDL_RWops *src)
• int IMG_isTIF(SDL_RWops *src)
• int IMG_isPNG(SDL_RWops *src)
• int IMG_isLBM(SDL_RWops *src)
• int IMG_isXV(SDL_RWops *src)
• int TTF_Init(void)
• int TTF_WasInit(void)
• void TTF_Quit(void)
• TTF_Font *TTF_OpenFont(const char *file, int ptsize)
• TTF_Font *TTF_OpenFontRW(SDL_RWops *src, int freesrc, int ptsize)
• TTF_Font *TTF_OpenFontIndex(const char *file, int ptsize, long index)
• TTF_Font *TTF_OpenFontIndexRW(SDL_RWops *src, int freesrc, int ptsize, long index)
• void TTF_CloseFont(TTF_Font *font)
• void TTF_ByteSwappedUNICODE(int swapped)
• int TTF_GetFontStyle(TTF_Font *font)
• void TTF_SetFontStyle(TTF_Font *font, int style)
• int TTF_GetFontOutline(TTF_Font *font)
• void TTF_SetFontOutline(TTF_Font *font, int outline)
• int TTF_GetFontHinting(TTF_Font *font)
• void TTF_SetFontHinting(TTF_Font *font, int hinting)
• int TTF_GetFontKerning(TTF_Font *font)
• void TTF_SetFontKerning(TTF_Font *font, int allowed)
• int TTF_FontHeight(const TTF_Font *font)
• int TTF_FontAscent(const TTF_Font *font)
• int TTF_FontDescent(const TTF_Font *font)
• int TTF_FontLineSkip(const TTF_Font *font)
• long TTF_FontFaces(const TTF_Font *font)
• int TTF_FontFaceIsFixedWidth(const TTF_Font *font)
• char *TTF_FontFaceFamilyName(const TTF_Font *font)
• char *TTF_FontFaceStyleName(const TTF_Font *font)
• int TTF_GlyphIsProvided(const TTF_Font *font, Uint16 ch)
• int TTF_GlyphMetrics(TTF_Font *font, Uint16 ch, int *minx, int *maxx, int *miny, int *maxy, int *advance)
• int TTF_SizeText(TTF_Font *font, const char *text, int *w, int *h)
• int TTF_SizeUTF8(TTF_Font *font, const char *text, int *w, int *h)
876

5. Ring Documentation, Release 1.6
• int TTF_SizeUNICODE(TTF_Font *font, const Uint16 *text, int *w, int *h)
• SDL_Surface *TTF_RenderText_Solid(TTF_Font *font, const char *text, SDL_Color fg)
• SDL_Surface *TTF_RenderUTF8_Solid(TTF_Font *font, const char *text,SDL_Color fg)
• SDL_Surface *TTF_RenderUNICODE_Solid(TTF_Font *font, const Uint16 *text,SDL_Color fg)
• SDL_Surface *TTF_RenderGlyph_Solid(TTF_Font *font, Uint16 ch, SDL_Color fg)
• SDL_Surface *TTF_RenderText_Shaded(TTF_Font *font, const char *text,SDL_Color fg, SDL_Color bg)
• SDL_Surface *TTF_RenderUTF8_Shaded(TTF_Font *font, const char *text,SDL_Color fg, SDL_Color bg)
• SDL_Surface *TTF_RenderUNICODE_Shaded(TTF_Font *font, const Uint16 *text,SDL_Color fg,
SDL_Color bg)
• SDL_Surface *TTF_RenderGlyph_Shaded(TTF_Font *font, Uint16 ch, SDL_Color fg,SDL_Color bg)
• SDL_Surface *TTF_RenderText_Blended(TTF_Font *font, const char *text,SDL_Color fg)
• SDL_Surface *TTF_RenderUTF8_Blended(TTF_Font *font, const char *text,SDL_Color fg)
• SDL_Surface *TTF_RenderUNICODE_Blended(TTF_Font *font, const Uint16 *text,SDL_Color fg)
• SDL_Surface *TTF_RenderGlyph_Blended(TTF_Font *font, Uint16 ch, SDL_Color fg)
• int Mix_Init(int flags)
• void Mix_Quit(void)
• int Mix_OpenAudio(int frequency, Uint16 format, int channels, int chunksize)
• void Mix_CloseAudio(void)
• int Mix_QuerySpec(int *frequency, Uint16 *format, int *channels)
• int Mix_GetNumChunkDecoders(void)
• const char *Mix_GetChunkDecoder(int index)
• Mix_Chunk *Mix_LoadWAV(char *file)
• Mix_Chunk *Mix_LoadWAV_RW(SDL_RWops *src, int freesrc)
• Mix_Chunk *Mix_QuickLoad_WAV(Uint8 *mem)
• void Mix_FreeChunk(Mix_Chunk *chunk)
• int Mix_AllocateChannels(int numchans)
• int Mix_Volume(int channel, int volume)
• int Mix_PlayChannel(int channel, Mix_Chunk *chunk, int loops)
• int Mix_PlayChannelTimed(int channel, Mix_Chunk *chunk, int loops, int ticks)
• int Mix_FadeInChannel(int channel, Mix_Chunk *chunk, int loops, int ms)
• int Mix_FadeInChannelTimed(int channel, Mix_Chunk *chunk,int loops, int ms, int ticks)
• void Mix_Pause(int channel)
• void Mix_Resume(int channel)
• int Mix_HaltChannel(int channel)
• int Mix_ExpireChannel(int channel, int ticks)
• int Mix_FadeOutChannel(int channel, int ms)
877

6. Ring Documentation, Release 1.6
• int Mix_Paused(int channel)
• Mix_Fading Mix_FadingChannel(int which)
• Mix_Chunk *Mix_GetChunk(int channel)
• int Mix_ReserveChannels(int num)
• int Mix_GroupChannel(int which, int tag)
• int Mix_GroupChannels(int from, int to, int tag)
• int Mix_GroupCount(int tag)
• int Mix_GroupAvailable(int tag)
• int Mix_GroupOldest(int tag)
• int Mix_GroupNewer(int tag)
• int Mix_FadeOutGroup(int tag, int ms)
• int Mix_HaltGroup(int tag)
• int Mix_GetNumMusicDecoders(void)
• const char *Mix_GetMusicDecoder(int index)
• Mix_Music *Mix_LoadMUS(const char *file)
• void Mix_FreeMusic(Mix_Music *music)
• int Mix_PlayMusic(Mix_Music *music, int loops)
• int Mix_FadeInMusic(Mix_Music *music, int loops, int ms)
• int Mix_FadeInMusicPos(Mix_Music *music, int loops, int ms, double position)
• int Mix_PlayingMusic(void)
• int Mix_PausedMusic(void)
• Mix_Fading Mix_FadingMusic(void)
• void *Mix_GetMusicHookData(void)
• int Mix_RegisterEffect(int chan, Mix_EffectFunc_t f, Mix_EffectDone_t d,void *arg)
• int Mix_UnregisterEffect(int channel, Mix_EffectFunc_t f)
• int Mix_UnregisterAllEffects(int channel)
• int Mix_SetDistance(int channel, Uint8 distance)
• int Mix_SetPosition(int channel, Sint16 angle, Uint8 distance)
• int Mix_SetReverseStereo(int channel, int flip)
• int SDLNet_Init(void)
• void SDLNet_Quit(void)
• char *SDLNet_GetError(void)
• void SDLNet_Write16(Uint16 value, void *area)
• void SDLNet_Write32(Uint32 value, void *area)
• Uint16 SDLNet_Read16(void *area)
• Uint32 SDLNet_Read32(void *area)
878

7. Ring Documentation, Release 1.6
• int SDLNet_ResolveHost(IPaddress *address, const char *host, Uint16 port)
• const char *SDLNet_ResolveIP(IPaddress *address)
• TCPsocket SDLNet_TCP_Open(IPaddress *ip)
• void SDLNet_TCP_Close(TCPsocket sock)
• TCPsocket SDLNet_TCP_Accept(TCPsocket server)
• IPaddress *SDLNet_TCP_GetPeerAddress(TCPsocket sock)
• int SDLNet_TCP_Send(TCPsocket sock, const void *data, int len)
• int SDLNet_TCP_Recv(TCPsocket sock, void *data, int maxlen)
• UDPsocket SDLNet_UDP_Open(Uint16 port)
• void SDLNet_UDP_Close(UDPsocket sock)
• int SDLNet_UDP_Bind(UDPsocket sock, int channel, IPaddress *address)
• void SDLNet_UDP_Unbind(UDPsocket sock, int channel)
• IPaddress *SDLNet_UDP_GetPeerAddress(UDPsocket sock, int channel)
• int SDLNet_UDP_Send(UDPsocket sock, int channel, UDPpacket *packet)
• int SDLNet_UDP_Recv(UDPsocket sock, UDPpacket *packet)
• int SDLNet_UDP_SendV(UDPsocket sock, UDPpacket **packetV, int npackets)
• int SDLNet_UDP_RecvV(UDPsocket sock, UDPpacket **packetV)
• UDPpacket *SDLNet_AllocPacket(int size)
• int SDLNet_ResizePacket(UDPpacket *packet, int size)
• void SDLNet_FreePacket(UDPpacket *packet)
• UDPpacket **SDLNet_AllocPacketV(int howmany, int size)
• void SDLNet_FreePacketV(UDPpacket **packetV)
• SDLNet_SocketSet SDLNet_AllocSocketSet(int maxsockets)
• void SDLNet_FreeSocketSet(SDLNet_SocketSet set)
• int SDLNet_AddSocket(SDLNet_SocketSet set, SDLNet_GenericSocket sock)
• int SDLNet_TCP_AddSocket(SDLNet_SocketSet set, TCPsocket sock)
• int SDLNet_UDP_AddSocket(SDLNet_SocketSet set, UDPsocket sock)
• int SDLNet_DelSocket(SDLNet_SocketSet set, SDLNet_GenericSocket sock)
• int SDLNet_TCP_DelSocket(SDLNet_SocketSet set, TCPsocket sock)
• int SDLNet_UDP_DelSocket(SDLNet_SocketSet set, UDPsocket sock)
• int SDLNet_CheckSockets(SDLNet_SocketSet set, Uint32 timeout)
• int SDLNet_SocketReady(TCPsocket sock)
• int circleRGBA(SDL_Renderer * renderer, Sint16 x, Sint16 y, Sint16 rad, Uint8 r, Uint8 g, Uint8 b, Uint8 a)
879

8. CHAPTER
EIGHTY
RINGFREEGLUT FUNCTIONS REFERENCE
• GLUT_RGB
• GLUT_RGBA
• GLUT_INDEX
• GLUT_SINGLE
• GLUT_DOUBLE
• GLUT_ACCUM
• GLUT_ALPHA
• GLUT_DEPTH
• GLUT_STENCIL
• GLUT_MULTISAMPLE
• GLUT_STEREO
• GLUT_LUMINANCE
• GLUT_KEY_F1
• GLUT_KEY_F2
• GLUT_KEY_F3
• GLUT_KEY_F4
• GLUT_KEY_F5
• GLUT_KEY_F6
• GLUT_KEY_F7
• GLUT_KEY_F8
• GLUT_KEY_F9
• GLUT_KEY_F10
• GLUT_KEY_F11
• GLUT_KEY_F12
• GLUT_KEY_LEFT
• GLUT_KEY_UP
• GLUT_KEY_RIGHT
880

9. Ring Documentation, Release 1.6
• GLUT_KEY_DOWN
• GLUT_KEY_PAGE_UP
• GLUT_KEY_PAGE_DOWN
• GLUT_KEY_HOME
• GLUT_KEY_END
• GLUT_KEY_INSERT
• GLUT_LEFT_BUTTON
• GLUT_MIDDLE_BUTTON
• GLUT_RIGHT_BUTTON
• GLUT_DOWN
• GLUT_UP
• GLUT_LEFT
• GLUT_ENTERED
• GLUT_MENU_NOT_IN_USE
• GLUT_MENU_IN_USE
• GLUT_NOT_VISIBLE
• GLUT_VISIBLE
• GLUT_HIDDEN
• GLUT_FULLY_RETAINED
• GLUT_PARTIALLY_RETAINED
• GLUT_FULLY_COVERED
• GLUT_WINDOW_X
• GLUT_WINDOW_Y
• GLUT_WINDOW_WIDTH
• GLUT_WINDOW_HEIGHT
• GLUT_WINDOW_BUFFER_SIZE
• GLUT_WINDOW_STENCIL_SIZE
• GLUT_WINDOW_DEPTH_SIZE
• GLUT_WINDOW_RED_SIZE
• GLUT_WINDOW_GREEN_SIZE
• GLUT_WINDOW_BLUE_SIZE
• GLUT_WINDOW_ALPHA_SIZE
• GLUT_WINDOW_ACCUM_RED_SIZE
• GLUT_WINDOW_ACCUM_GREEN_SIZE
• GLUT_WINDOW_ACCUM_BLUE_SIZE
• GLUT_WINDOW_ACCUM_ALPHA_SIZE
881

10. Ring Documentation, Release 1.6
• GLUT_WINDOW_DOUBLEBUFFER
• GLUT_WINDOW_RGBA
• GLUT_WINDOW_PARENT
• GLUT_WINDOW_NUM_CHILDREN
• GLUT_WINDOW_COLORMAP_SIZE
• GLUT_WINDOW_NUM_SAMPLES
• GLUT_WINDOW_STEREO
• GLUT_WINDOW_CURSOR
• GLUT_SCREEN_WIDTH
• GLUT_SCREEN_HEIGHT
• GLUT_SCREEN_WIDTH_MM
• GLUT_SCREEN_HEIGHT_MM
• GLUT_MENU_NUM_ITEMS
• GLUT_DISPLAY_MODE_POSSIBLE
• GLUT_INIT_WINDOW_X
• GLUT_INIT_WINDOW_Y
• GLUT_INIT_WINDOW_WIDTH
• GLUT_INIT_WINDOW_HEIGHT
• GLUT_INIT_DISPLAY_MODE
• GLUT_ELAPSED_TIME
• GLUT_WINDOW_FORMAT_ID
• GLUT_HAS_KEYBOARD
• GLUT_HAS_MOUSE
• GLUT_HAS_SPACEBALL
• GLUT_HAS_DIAL_AND_BUTTON_BOX
• GLUT_HAS_TABLET
• GLUT_NUM_MOUSE_BUTTONS
• GLUT_NUM_SPACEBALL_BUTTONS
• GLUT_NUM_BUTTON_BOX_BUTTONS
• GLUT_NUM_DIALS
• GLUT_NUM_TABLET_BUTTONS
• GLUT_DEVICE_IGNORE_KEY_REPEAT
• GLUT_DEVICE_KEY_REPEAT
• GLUT_HAS_JOYSTICK
• GLUT_OWNS_JOYSTICK
• GLUT_JOYSTICK_BUTTONS
882