Tao.Sdl SDK Documentation

Sdl Methods

The methods of the Sdl class are listed below. For a complete list of Sdl class members, see the Sdl Members topic.

Public Static (Shared) Methods

CD_INDRIVE Given a status, returns true if there's a disk in the drive.
FRAMES_TO_MSF Conversion function from frames to Minute/Second/Frames.
MSF_TO_FRAMES Conversion function from Minute/Second/Frames to frames.
objc_getClass
objc_msgSend
SDL_AddTimer Add a timer which will call a callback after the specified number of milliseconds has elapsed.
SDL_AllocRW Allocates an empty, unpopulated SDL_RWops structure.
SDL_AllocSurface Same as SDL_CreateRGBSurface
SDL_AudioDriverName This function fills the given character buffer with the name of the current audio driver, and returns a pointer to it if the audio driver has been initialized.
SDL_AudioInit This function is used internally, and should not be used unless you have a specific need to specify the audio driver you want to use. You should normally use SDL_Init or SDL_InitSubSystem.
SDL_AudioQuit This function is used internally, and should not be used unless you have a specific need to specify the audio driver you want to use. You should normally use SDL_Init() or SDL_InitSubSystem().
SDL_BlitSurface This performs a fast blit from the source surface to the destination surface.
SDL_BuildAudioCVT Initializes a SDL_AudioCVT structure for conversion
SDL_BUTTON
SDL_CDClose Closes a SDL_CD handle.
SDL_CDEject Ejects a CDROM.
SDL_CDName Returns a human-readable, system-dependent identifier for the CD-ROM.
SDL_CDNumDrives Returns the number of CD-ROM drives on the system.
SDL_CDOpen Opens a CD-ROM drive for access.
SDL_CDPause Pauses a CDROM.
SDL_CDPlay Play a CD.
SDL_CDPlayTracks Play the given CD track(s).
SDL_CDResume Resumes a CDROM.
SDL_CDStatus This function returns the current status of the given drive.
SDL_CDStop Stops a CDROM.
SDL_ClearError Clears the SDL error.
SDL_CloseAudio Shuts down audio processing and closes the audio device.
SDL_CondBroadcast Restart all threads that are waiting on the condition variable, returns 0 or -1 on error.
SDL_CondSignal Restart one of the threads that are waiting on the condition variable, returns 0 or -1 on error.
SDL_CondWait Wait on the condition variable, unlocking the provided mutex. The mutex must be locked before entering this function! Returns 0 when it is signaled, or -1 on error.
SDL_CondWaitTimeout Waits for at most 'ms' milliseconds, and returns 0 if the condition variable is signaled, SDL_MUTEX_TIMEDOUT if the condition is not signaled in the allotted time, and -1 on error. On some platforms this function is implemented by looping with a delay of 1 ms, and so should be avoided if possible.
SDL_ConvertAudio Convert audio data to a desired audio format.
SDL_ConvertSurface Converts a surface to the same format as another surface.
SDL_CreateCond Create a condition variable
SDL_CreateCursor Creates a new mouse cursor.
SDL_CreateMutex Create a mutex, initialized unlocked
SDL_CreateRGBSurface Create an empty SDL_Surface
SDL_CreateRGBSurfaceFrom Create an SDL_Surface from pixel data
SDL_CreateSemaphore Create a semaphore, initialized with value, returns NULL on failure.
SDL_CreateThread Create thread
SDL_CreateYUVOverlay Create a YUV video overlay.
SDL_Delay Wait a specified number of milliseconds before returning.
SDL_DestroyCond Destroy a condition variable
SDL_DestroyMutex Destroy a mutex
SDL_DestroySemaphore Destroy a semaphore
SDL_DisplayFormat Convert a surface to the display format.
SDL_DisplayFormatAlpha Convert a surface to the display format.
SDL_DisplayYUVOverlay Blit the overlay to the display.
SDL_EnableKeyRepeat Set keyboard repeat rate.
SDL_EnableUNICODE Enable UNICODE translation
SDL_EventState This function allows you to set the state of processing certain events.
SDL_FillRect This function performs a fast fill of the given rectangle with some color.
SDL_Flip Swaps screen buffers
SDL_FreeCursor Frees a cursor created with SDL_CreateCursor.
SDL_FreeRW Frees an SDL_RWops structure allocated by SDL_AllocRW.
SDL_FreeSurface Frees (deletes) a SDL_Surface
SDL_FreeWAV Frees previously opened WAV data.
SDL_FreeYUVOverlay Free a YUV video overlay.
SDL_GetAppState This function returns the current state of the application, which is a bitwise combination of SDL_APPMOUSEFOCUS, SDL_APPINPUTFOCUS, and SDL_APPACTIVE.
SDL_GetAudioStatus Get the current audio state.
SDL_GetClipRect Gets the clipping rectangle for a surface.
SDL_GetCursor Returns the currently active cursor.
SDL_getenv Retrieves a variable from the environment.
SDL_GetError Gets an SDL error string.
SDL_GetEventFilter Retrieves a pointer to the event filter
SDL_GetGammaRamp Gets the color gamma lookup tables for the display.
SDL_GetKeyName Get the name of an SDL virtual keysym
SDL_GetKeyRepeat Get keyboard repeat rate.
SDL_GetKeyState Get a snapshot of the current keyboard state.
SDL_GetModState Get the state of modifier keys.
SDL_GetMouseState Retrieve the current state of the mouse.
SDL_GetRelativeMouseState Retrieve the current state of the mouse.
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_GetThreadID Get the 32-bit thread identifier for the specified thread, equivalent to SDL_ThreadID() if the specified thread is NULL.
SDL_GetTicks Get the number of milliseconds since the SDL library initialization.
SDL_GetVideoInfo This function returns a read-only pointer to information about the video hardware.
SDL_GetVideoSurface This function returns a pointer to the current display surface.
SDL_GetWMInfoOverloaded. Gives you custom hooks into the window manager information.
SDL_GL_GetAttribute Get the value of a special SDL/OpenGL attribute
SDL_GL_GetProcAddress Get the address of a GL function
SDL_GL_LoadLibrary Specify an OpenGL library.
SDL_GL_SetAttribute Set a special SDL/OpenGL attribute.
SDL_GL_SwapBuffers Swap OpenGL framebuffers/Update Display
SDL_Has3DNow This function returns true if the CPU has 3DNow features
SDL_HasAltiVec This function returns true if the CPU has AltiVec features
SDL_HasMMX This function returns true if the CPU has MMX features.
SDL_HasMMXExt This function returns true if the CPU has MMX Ext. features.
SDL_HasRDTSC This function returns true if the CPU has the RDTSC instruction.
SDL_HasSSE This function returns true if the CPU has SSE features
SDL_HasSSE2 This function returns true if the CPU has SSE2 features
SDL_Init Initializes SDL and the specified subsystems.
SDL_InitSubSystem Initializes specified subsystems.
SDL_JoystickClose Closes a previously opened joystick.
SDL_JoystickEventState Enable/disable joystick event polling
SDL_JoystickGetAxis Get the current state of an axis.
SDL_JoystickGetBall Get relative trackball motion.
SDL_JoystickGetButton Get the current state of a given button on a given joystick.
SDL_JoystickGetHat Get the current state of a joystick hat
SDL_JoystickIndex Get the index of an SDL_Joystick.
SDL_JoystickName Get joystick name.
SDL_JoystickNumAxes Get the number of joystick axes
SDL_JoystickNumBalls Get the number of joystick trackballs
SDL_JoystickNumButtons Get the number of joystick buttons.
SDL_JoystickNumHats Get the number of joystick hats.
SDL_JoystickOpen Open a joystick for use.
SDL_JoystickOpened Determine if a joystick has been opened.
SDL_JoystickUpdate Updates the state of all joysticks.
SDL_KillThread Forcefully kill a thread without worrying about its state
SDL_Linked_Version This function gets the version of the dynamically linked SDL library.
SDL_ListModes 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 (SDL_Rect **)-1 if any dimension is okay for the given format.
SDL_LoadBMP Load a Windows BMP file into an SDL_Surface.
SDL_LoadBMP_RW Load a surface from a seekable SDL data source (memory or file.)
SDL_LoadFunction Given an object handle, this function looks up the address of the named function in the shared object and returns it. This address is no longer valid after calling SDL_UnloadObject().
SDL_LoadObject This function dynamically loads a shared object and returns a pointer to the object handle (or NULL if there was an error).
SDL_LoadWAV Load a WAVE file.
SDL_LoadWAV_RW This function loads a WAVE from the data source, automatically freeing that source if 'freesrc' is non-zero. For example, to load a WAVE file, you could do: SDL_LoadWAV_RW(SDL_RWFromFile("sample.wav", "rb"), 1, ...);
SDL_LockAudio Lock out the callback function.
SDL_LockMutex Lock the mutex (Returns 0, or -1 on error)
SDL_LockSurface Lock a surface for directly access.
SDL_LockYUVOverlay Lock an overlay
SDL_MapRGB Map a RGB color value to a pixel format.
SDL_MapRGBA Map a RGBA color value to a pixel format.
SDL_MixAudio Mix audio data.
SDL_MUSTLOCK Evaluates to true if the surface needs to be locked before access
SDL_mutexP Lock the mutex (Returns 0, or -1 on error)
SDL_mutexV Unlock the mutex (Returns 0, or -1 on error)
SDL_NAME Returns SDL name
SDL_NumJoysticks Count the number of joysticks attached to the system.
SDL_OpenAudio Opens the audio device with the desired parameters.
SDL_PauseAudio Pauses and unpauses the audio callback processing.
SDL_PeepEvents Checks the event queue for messages and optionally returns them.
SDL_PollEvent Polls for currently pending events.
SDL_PumpEvents Pumps the event loop, gathering events from the input devices.
SDL_PushEvent Pushes an event onto the event queue.
SDL_putenv Puts a variable of the form "name=value" into the environment.
SDL_Quit Shuts down SDL.
SDL_QuitRequested Checks if SDL_Quit event has been requested
SDL_QuitSubSystem Shuts down specified subsystems.
SDL_ReadBE16 Read an item of the specified endianness and return in native format.
SDL_ReadBE32 Read an item of the specified endianness and return in native format.
SDL_ReadBE64 Read an item of the specified endianness and return in native format.
SDL_ReadLE16 Read an item of the specified endianness and return in native format.
SDL_ReadLE32 Read an item of the specified endianness and return in native format.
SDL_ReadLE64 Read an item of the specified endianness and return in native format.
SDL_RemoveTimer Remove a timer which was added with SDL_AddTimer.
SDL_RWFromConstMem Prepares a constant memory area for use with RWops.
SDL_RWFromFile Create SDL_RWops structures from file.
SDL_RWFromFP SDL_RWFromFP creates a new SDL_RWops structure from a file pointer, opened with stdio. If autoclose is nonzero, the file will be automatically closed when the RWops structure is closed.
SDL_RWFromMemOverloaded. Create SDL_RWops structures from memory.
SDL_SaveBMP Save an SDL_Surface as a Windows BMP file.
SDL_SaveBMP_RW Save a surface to a seekable SDL data source (memory or file.)
SDL_SemPost Atomically increases the semaphore's count (not blocking), returns 0, or -1 on error.
SDL_SemtryWait Non-blocking variant of SDL_SemWait(), returns 0 if the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait would block, and -1 on error.
SDL_SemValue Returns the current count of the semaphore
SDL_SemWait This function suspends the calling thread until the semaphore pointed to by sem has a positive count. It then atomically decreases the semaphore count.
SDL_SemWaitTimeout Variant of SDL_SemWait() with a timeout in milliseconds, returns 0 if the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait does not succeed in the allotted time, and -1 on error. On some platforms this function is implemented by looping with a delay of 1 ms, and so should be avoided if possible.
SDL_SetAlpha Adjust the alpha properties of a surface.
SDL_SetClipRect Sets the clipping rectangle for a surface.
SDL_SetColorKey Sets the color key (transparent pixel) in a blittable surface and RLE acceleration.
SDL_SetColors Sets a portion of the colormap for the given 8-bit surface.
SDL_SetCursor Set the currently active cursor to the specified one.
SDL_SetError Sets an SDL error string.
SDL_SetEventFilter Sets up a filter to process all events before they are posted to the event queue.
SDL_SetGamma Set the gamma correction for each of the color channels.
SDL_SetGammaRamp Set the gamma translation table for the red, green, and blue channels of the video hardware.
SDL_SetModState Set the current key modifier state.
SDL_SetPalette Sets the colors in the palette of an 8-bit surface.
SDL_SetTimer Set a callback to run after the specified number of milliseconds has elapsed.
SDL_SetVideoMode Set up a video mode with the specified width, height and bits-per-pixel.
SDL_ShowCursor Toggle whether or not the cursor is shown on the screen.
SDL_ThreadID Get the 32-bit thread identifier for the current thread
SDL_UnloadObject Unload a shared object from memory
SDL_UnlockAudio Unlock the callback function
SDL_UnlockMutex Unlock the mutex (Returns 0, or -1 on error)
SDL_UnlockSurface Unlocks a previously locked surface.
SDL_UnlockYUVOverlay Unlock an overlay.
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_VERSION This method can be used to fill a version structure with the compile-time version of the SDL library.
SDL_VERSION_ATLEAST Will evaluate to true if SDL version is at least X.Y.Z
SDL_VideoDriverName This function returns a string with the name of the video driver.
SDL_VideoModeOK Check to see if a particular video mode is supported.
SDL_WaitEvent Waits indefinitely for the next available event.
SDL_WaitThread Wait for a thread to finish. The return code for the thread function is placed in the area pointed to by 'status', if 'status' is not NULL.
SDL_WarpMouse Set the position of the mouse cursor.
SDL_WasInit Checks which SDL subsystems are initialized.
SDL_WM_GetCaption Gets the title and icon text of the display window
SDL_WM_GrabInput Grabs mouse and keyboard input.
SDL_WM_IconifyWindowIconify/Minimise the window
SDL_WM_SetCaption Sets the title and icon text of the display window
SDL_WM_SetIcon Sets the icon for the display window.
SDL_WM_ToggleFullScreen Toggle fullscreen mode without changing the contents of the screen.
SDL_WriteBE16 Write an item of native format to the specified endianness
SDL_WriteBE32 Write an item of native format to the specified endianness
SDL_WriteBE64 Write an item of native format to the specified endianness
SDL_WriteLE16 Write an item of native format to the specified endianness
SDL_WriteLE32 Write an item of native format to the specified endianness
SDL_WriteLE64 Write an item of native format to the specified endianness
sel_registerName

Public Instance Methods

Equals (inherited from Object) 
GetHashCode (inherited from Object) 
GetType (inherited from Object) 
ToString (inherited from Object) 

See Also

Sdl Class | Tao.Sdl Namespace