Tao.Sdl SDK Documentation

Tao.Sdl Namespace

Namespace hierarchy

Classes

Class Description
Sdl Simple DirectMedia Layer binding for .NET, implementing SDL 1.2.11.
Sdl.SDL_CD CDROM Drive Information.
Sdl.SDL_CDTrackData
SdlGfx SDL graphics drawing primitives and other support functions The SDL_gfx library evolved out of the SDL_gfxPrimitives code which provided basic drawing routines such as lines, circles or polygons and SDL_rotozoom which implemented a interpolating rotozoomer for SDL surfaces.

The current components of the SDL_gfx library are:


MMX image filters (SDL_imageFilter.h)

SdlImage SDL_Image bindings for .NET.

A simple library to load images of various formats as SDL surfaces.

SdlMixer

SdlMixer is a simple multi-channel audio mixer. It supports 8 channels of 16 bit stereo audio, plus a single channel of music, mixed by the popular MikMod MOD, Timidity MIDI and SMPEG MP3 libraries.

The mixer can currently load Microsoft WAVE files and Creative Labs VOC files as audio samples, and can load MIDI files via Timidity and the following music formats via MikMod: .MOD .S3M .IT .XM. It can load Ogg Vorbis streams as music if built with the Ogg Vorbis libraries, and finally it can load MP3 music using the SMPEG library.

The process of mixing MIDI files to wave output is very CPU intensive, so if playing regular WAVE files sound great, but playing MIDI files sound choppy, try using 8-bit audio, mono audio, or lower frequencies.

SdlNet SDL_net is a portable network library for use with SDL.
SdlTtf This library supports Sdl_ttf 2.0.8. This library is a wrapper around the excellent FreeType 1.2 library, available at: http://www.freetype.org

WARNING: There may be patent issues with using the FreeType library. Check the FreeType website for up-to-date details.

This library allows you to use TrueType fonts to render text in SDL applications.

Be careful when including fonts with your application, as many of them are copyrighted. The Microsoft fonts, for example, are not freely redistributable and even the free "web" fonts they provide are only redistributable in their special executable installer form (May 1998). There are plenty of freeware and shareware fonts available on the Internet though, and may suit your purposes.

Smpeg SMPEG bindings for .NET.

Structures

Structure Description
Sdl.SDL_ActiveEvent Application visibility event structure.
Sdl.SDL_AudioCVT Audio Conversion Structure
Sdl.SDL_AudioSpec Audio Specification Structure
Sdl.SDL_CDtrack CD Track Information Structure
Sdl.SDL_Color Format independent color description
Sdl.SDL_Cursor Structure to hold cursor
Sdl.SDL_Event General event structure
Sdl.SDL_ExposeEvent Screen redraw event
Sdl.SDL_JoyAxisEvent Joystick axis motion event structure
Sdl.SDL_JoyBallEvent Joystick trackball motion event structure
Sdl.SDL_JoyButtonEvent Joystick button event structure
Sdl.SDL_JoyHatEvent Joystick hat position change event structure
Sdl.SDL_KeyboardEvent Keyboard event structure
Sdl.SDL_keysym The SDL_keysym structure describes a key press or a key release.
Sdl.SDL_MouseButtonEvent Mouse button event structure
Sdl.SDL_MouseMotionEvent Mouse motion event structure
Sdl.SDL_Overlay The YUV hardware video overlay
Sdl.SDL_Palette Color palette for 8-bit pixel formats
Sdl.SDL_PixelFormat Stores surface format information
Sdl.SDL_QuitEvent Quit requested event
Sdl.SDL_Rect Defines a rectangular area.
Sdl.SDL_ResizeEvent Window resized event
Sdl.SDL_Surface Graphical Surface Structure.
Sdl.SDL_SysWMEvent Platform-dependent window manager event.
Sdl.SDL_SysWMinfo The generic custom window manager information structure
Sdl.SDL_SysWMinfo_RiscOS The RISCOS custom window manager information structure
Sdl.SDL_SysWMinfo_Unix The UNIX custom window manager information structure. TODO
Sdl.SDL_SysWMinfo_Windows The Windows custom window manager information structure. TODO
Sdl.SDL_SysWMmsg The generic custom event structure
Sdl.SDL_SysWMmsg_RiscOS RISC OS custom event structure
Sdl.SDL_SysWMmsg_Unix The UNIX custom event structure. TODO
Sdl.SDL_SysWMmsg_Windows The Windows custom event structure. TODO
Sdl.SDL_TimerID
Sdl.SDL_UserEvent A user-defined event type
Sdl.SDL_version Structure to hold version number of the SDL library
Sdl.SDL_VideoInfo Video Target information. Useful for determining the video hardware capabilities. Not finished. The C struct uses a set of bit-fields that need to be marshalled. The vfmt IntPtr works and provided useful information.
SdlGfx.FPSmanager
SdlGfx.tColorRGBA
SdlGfx.tColorY
SdlMixer.Mix_Chunk The internal format for an audio chunk
SdlNet.IPaddress IP Address and Port number
SdlNet.SDLNet_GenericSocket A generic type for UDP and TCP sockets
SdlNet.SDLNet_SocketSet Socket Set type (opaque)
SdlNet.TCPsocket TCP socket type (opaque)
SdlNet.UDPpacket UDP packet data encapsulation
SdlNet.UDPsocket UDP socket type (opaque)
SdlTtf.TTF_Font The opaque holder of a loaded font
Smpeg.SMPEG_Filter The filter definition itself
Smpeg.SMPEG_FilterInfo Filter info from SMPEG
Smpeg.SMPEG_Info Used to get information about the SMPEG object
Smpeg.SMPEG_version Structure to hold version number of the SMPEG library

Delegates

Delegate Description
Sdl.AudioSpecCallbackDelegate Used in the SDL_AudioSpec struct
Sdl.SDL_EventFilter This function sets up a filter to process all events before they change internal state and are posted to the internal event queue.
Sdl.SDL_NewTimerCallback Prototype for the new timer callback.
Sdl.SDL_TimerCallback Prototype for the timer callback.
Sdl.ThreadDelegate int (SDLCALL *fn)(void *)
SdlMixer.ChannelFinishedDelegate
SdlMixer.MixEffectDoneDelegate Special effect done callback function pointer
SdlMixer.MixEffectFunctionDelegate Special effect callback function pointer
SdlMixer.MixFunctionDelegate
SdlMixer.MusicFinishedDelegate
Smpeg.SMPEG_DisplayCallback Matches the declaration of SDL_UpdateRect()
Smpeg.SMPEG_FilterCallback Callback function for the filter
Smpeg.SMPEG_FilterDestroy Callback function for the filter