= ToDo = This page is intended to help focus the efforts of the SDL Documentation Wiki contributors. === Missing functions === The following functions are found in the header files, but not (yet) on the wiki. Some pages just need to be categorized, others don't exist yet and need to be made, and some might not belong on the wiki anyway --((for example, none of the internal SDL_cstdlib functions have been listed here))--. ==== SDL_assert.h ==== These functions are for internal use and not meant to be documented: * [[SDL_ReportAssertion]] ==== SDL_error.h ==== These functions are for internal use and not meant to be documented: * [[SDL_Error]] ==== SDL_gamecontroller.h ==== These functions are in the process of being documented by Jorgen * [[SDL_IsGameController]] * [[SDL_GameControllerNameForIndex]] * [[SDL_GameControllerOpen]] * [[SDL_GameControllerName]] * [[SDL_GameControllerGetAttached]] * [[SDL_GameControllerGetJoystick]] * [[SDL_GameControllerEventState]] * [[SDL_GameControllerGetAxisFromString]] * [[SDL_GameControllerGetButtonFromString]] * [[SDL_GameControllerGetButton]] * [[SDL_GameControllerClose]] These functions are currently documented as "draft" only and need improvements: * [[SDL_GameControllerMapping]] * [[SDL_GameControllerMappingForGUID]] * [[SDL_GameControllerGetAxis]] * [[SDL_GameControllerGetBindForAxis]] * [[SDL_GameControllerGetBindForButton]] * [[SDL_GameControllerGetStringForAxis]] * [[SDL_GameControllerGetStringForButton]] * [[SDL_GameControllerUpdate]] ==== SDL_gesture.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_RecordGesture]] * [[SDL_SaveAllDollarTemplates]] * [[SDL_SaveDollarTemplate]] * [[SDL_LoadDollarTemplates]] ==== SDL_hints.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_AddHintCallback]] * [[SDL_DelHintCallback]] ==== SDL_input.h ==== The input API was never implemented and has been removed, so ignore these functions. * [[SDL_RedetectInputDevices]] * [[SDL_GetNumInputDevices]] * [[SDL_GetInputDeviceName]] * [[SDL_IsDeviceDisconnected]] ==== SDL_joystick.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_JoystickNameForIndex]] * [[SDL_JoystickGetDeviceGUID]] * [[SDL_JoystickGetGUID]] * [[SDL_JoystickGetGUIDString]] * [[SDL_JoystickGetGUIDFromString]] * [[SDL_JoystickGetAttached]] * [[SDL_JoystickInstanceID]] ==== SDL_keyboard.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_IsTextInputActive]] * [[SDL_HasScreenKeyboardSupport]] * [[SDL_IsScreenKeyboardShown]] ==== SDL_main.h ==== These functions are platform specific and were left undocumented because they require advanced knowledge of Windows functionality. You may document them but will need to explain when and why you should use them. * [[SDL_RegisterApp]] * [[SDL_UnregisterApp]] ==== SDL_messagebox.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_ShowMessageBox]] * [[SDL_ShowSimpleMessageBox]] ==== SDL_mouse.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_CreateSystemCursor]] * [[SDL_GetDefaultCursor]] ==== SDL_mutex.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_TryLockMutex]] ==== SDL_render.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_CreateWindowAndRenderer]] * [[SDL_RenderTargetSupported]] * [[SDL_GetRendererOutputSize]] * [[SDL_GetRenderTarget]] * [[SDL_RenderSetLogicalSize]] * [[SDL_RenderGetLogicalSize]] * [[SDL_RenderSetScale]] * [[SDL_RenderGetScale]] ==== SDL_rwops.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_ReadU8]] * [[SDL_WriteU8]] ==== SDL_shape.h ==== These functions need testing on all supported platforms and possibly implementation as well. * [[SDL_CreateShapedWindow]] * [[SDL_IsShapedWindow]] * [[SDL_SetWindowShape]] * [[SDL_GetShapedWindowMode]] ==== SDL_system.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_iPhoneSetAnimationCallback]] * [[SDL_iPhoneSetEventPump]] * [[SDL_AndroidGetJNIEnv]] * [[SDL_AndroidGetActivity]] * [[SDL_AndroidGetInternalStoragePath]] * [[SDL_AndroidGetExternalStorageState]] * [[SDL_AndroidGetExternalStoragePath]] * [[SDL_Direct3D9GetAdapterIndex]] * [[SDL_RenderGetD3D9Device]] ==== SDL_thread.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_TLSCreate]] * [[SDL_TLSGet]] * [[SDL_TLSSet]] ==== SDL_touch.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_GetNumTouchDevices]] * [[SDL_GetNumTouchFingers]] * [[SDL_GetTouchDevice]] * [[SDL_GetTouchFinger]] ==== SDL_video.h ==== These functions are currently documented as "draft" only and need improvements: * [[SDL_GetDisplayName]] * [[SDL_GL_GetCurrentContext]] * [[SDL_GL_GetCurrentWindow]] * [[SDL_GetWindowDisplayIndex]] * [[SDL_SetWindowMinimumSize]] * [[SDL_GetWindowMinimumSize]] * [[SDL_SetWindowMaximumSize]] * [[SDL_GetWindowMaximumSize]] * [[SDL_SetWindowBordered]] ==== SDL_stdinc.h ==== These functions maybe do not need to be documented here * [[SDL_abs]] * [[SDL_acos]] * [[SDL_asin]] * [[SDL_atan]] * [[SDL_atan2]] * [[SDL_atof]] * [[SDL_atoi]] * [[SDL_calloc]] * [[SDL_ceil]] * [[SDL_copysign]] * [[SDL_cos]] * [[SDL_cosf]] * [[SDL_crc32]] * [[SDL_fabs]] * [[SDL_floor]] * [[SDL_free]] * [[SDL_getenv]] * [[SDL_iconv]] * [[SDL_iconv_close]] * [[SDL_iconv_open]] * [[SDL_iconv_string]] * [[SDL_isalpha]] * [[SDL_isalnum]] * [[SDL_isblank]] * [[SDL_iscntrl]] * [[SDL_isdigit]] * [[SDL_isxdigit]] * [[SDL_ispunct]] * [[SDL_isspace]] * [[SDL_isupper]] * [[SDL_islower]] * [[SDL_isprint]] * [[SDL_isgraph]] * [[SDL_itoa]] * [[SDL_lltoa]] * [[SDL_log]] * [[SDL_ltoa]] * [[SDL_malloc]] * [[SDL_max]] * [[SDL_memcmp]] * [[SDL_memcpy]] * [[SDL_memcpy4]] * [[SDL_memmove]] * [[SDL_memset]] * [[SDL_memset4]] * [[SDL_min]] * [[SDL_pow]] * [[SDL_qsort]] * [[SDL_realloc]] * [[SDL_scalbn]] * [[SDL_setenv]] * [[SDL_sin]] * [[SDL_sinf]] * [[SDL_snprintf]] * [[SDL_sqrt]] * [[SDL_sscanf]] * [[SDL_strcasecmp]] * [[SDL_strchr]] * [[SDL_strcmp]] * [[SDL_strdup]] * [[SDL_strlcat]] * [[SDL_strlcpy]] * [[SDL_strlen]] * [[SDL_strlwr]] * [[SDL_strncasecmp]] * [[SDL_strncmp]] * [[SDL_strrchr]] * [[SDL_strrev]] * [[SDL_strstr]] * [[SDL_strtod]] * [[SDL_strtol]] * [[SDL_strtoll]] * [[SDL_strtoul]] * [[SDL_strtoull]] * [[SDL_strupr]] * [[SDL_tolower]] * [[SDL_toupper]] * [[SDL_uitoa]] * [[SDL_ulltoa]] * [[SDL_ultoa]] * [[SDL_utf8strlcpy]] * [[SDL_vsnprintf]] * [[SDL_wcslcat]] * [[SDL_wcslcpy]] * [[SDL_wcslen]] ==== SDL2_test ==== These functions maybe do not need to be documented here * [[SDLTest_Assert]] * [[SDLTest_AssertCheck]] * [[SDLTest_AssertPass]] * [[SDLTest_AssertSummaryToTestResult]] * [[SDLTest_CommonArg]] * [[SDLTest_CommonCreateState]] * [[SDLTest_CommonEvent]] * [[SDLTest_CommonInit]] * [[SDLTest_CommonQuit]] * [[SDLTest_CommonUsage]] * [[SDLTest_CompareSurfaces]] * [[SDLTest_crc32Calc]] * [[SDLTest_Crc32CalcBuffer]] * [[SDLTest_Crc32CalcEnd]] * [[SDLTest_Crc32CalcStart]] * [[SDLTest_Crc32Done]] * [[SDLTest_Crc32Init]] * [[SDLTest_DrawString]] * [[SDLTest_FuzzerInit]] * [[SDLTest_GetFuzzerInvocationCount]] * [[SDLTest_ImageBlit]] * [[SDLTest_ImageBlitAlpha]] * [[SDLTest_ImageBlitBlend]] * [[SDLTest_ImageBlitBlendAdd]] * [[SDLTest_ImageBlitBlendAll]] * [[SDLTest_ImageBlitBlendMod]] * [[SDLTest_ImageBlitBlendNone]] * [[SDLTest_ImageBlitColor]] * [[SDLTest_ImageFace]] * [[SDLTest_ImagePrimitives]] * [[SDLTest_ImagePrimitivesBlend]] * [[SDLTest_Log]] * [[SDLTest_LogAssertSummary]] * [[SDLTest_LogError]] * [[SDLTest_Md5Final]] * [[SDLTest_Md5Init]] * [[SDLTest_Md5Update]] * [[SDLTest_Random]] * [[SDLTest_RandomAsciiString]] * [[SDLTest_RandomAsciiStringOfSize]] * [[SDLTest_RandomAsciiStringWithMaximumLength]] * [[SDLTest_RandomDouble]] * [[SDLTest_RandomFloat]] * [[SDLTest_RandomInit]] * [[SDLTest_RandomInitTime]] * [[SDLTest_RandomIntegerInRange]] * [[SDLTest_RandomSint16]] * [[SDLTest_RandomSint16BoundaryValue]] * [[SDLTest_RandomSint32]] * [[SDLTest_RandomSint32BoundaryValue]] * [[SDLTest_RandomSint64]] * [[SDLTest_RandomSint64BoundaryValue]] * [[SDLTest_RandomSint8]] * [[SDLTest_RandomSint8BoundaryValue]] * [[SDLTest_RandomUint16]] * [[SDLTest_RandomUint16BoundaryValue]] * [[SDLTest_RandomUint32]] * [[SDLTest_RandomUint32BoundaryValue]] * [[SDLTest_RandomUint64]] * [[SDLTest_RandomUint64BoundaryValue]] * [[SDLTest_RandomUint8]] * [[SDLTest_RandomUint8BoundaryValue]] * [[SDLTest_RandomUnitDouble]] * [[SDLTest_RandomUnitFloat]] * [[SDLTest_ResetAssertSummary]] * [[SDLTest_RunSuites]] === Missing enumerations === * [[SDL_eventaction]] * [[SDL_GameControllerBindType]] * --([[SDL_SystemCursor]])-- (only needed in [[SDL_CreateSystemCursor]]) * [[WindowShapeMode]] These enumerations are currently documented as "draft" only and need improvements: * [[SDL_GameControllerAxis]] * [[SDL_GameControllerButton]] * [[SDL_MessageBoxButtonFlags]] * [[SDL_MessageBoxColorType]] * [[SDL_MessageBoxFlags]] === Missing structures === ==== SDL_events.h ==== * --(SDL_CommonEvent)-- (shared) * --(SDL_OSEvent)-- (unused) These structures are currently documented as "draft" only and need improvements: * [[SDL_JoyDeviceEvent]] * [[SDL_ControllerAxisEvent]] * [[SDL_ControllerButtonEvent]] * [[SDL_ControllerDeviceEvent]] ==== SDL_gamecontroller.h ==== * [[SDL_GameControllerButtonBind]] ==== SDL_haptic.h ==== These structures are currently documented as "draft" only and need improvements: * [[SDL_HapticLeftRight]] ==== SDL_joystick.h ==== * [[SDL_JoystickGUID]] ==== SDL_messagebox.h ==== These structures are currently documented as "draft" only and need improvements: * [[SDL_MessageBoxButtonData]] * [[SDL_MessageBoxColor]] * [[SDL_MessageBoxColorScheme]] * [[SDL_MessageBoxData]] ==== SDL_shape.h ==== * [[SDL_WindowShapeMode]] ==== SDL_touch.h ==== These structures are currently documented as "draft" only and need improvements: * [[SDL_Finger]] ==== SDL2_test ==== * [[SDLTest_CommonState]] * [[SDLTest_Crc32Context]] * [[SDLTest_Md5Context]] * [[SDLTest_RandomContext]] * [[SDLTest_SurfaceImage_t]] * [[SDLTest_TestCaseReference]] * [[SDLTest_TestSuiteReference]] === Missing unions === ==== SDL_shape.h ==== * [[SDL_WindowShapeParams]] === Not linked pages === * [[Test]] * [[SDL_DirtyTexture]] * [[SDL-gsoc2010_android]] * [[SDL-gsoc2010_gesture]] * [[SDL-gsoc2010_IME]] * [[SDL-gsoc2010_shaped_windows]] * [[SDL-gsoc2010_xrender]]