OSDN Git Service

[DOC] Add libSDL2's documentations.
authorK.Ohta <whatisthis.sowhat@gmail.com>
Fri, 26 Feb 2016 11:08:52 +0000 (20:08 +0900)
committerK.Ohta <whatisthis.sowhat@gmail.com>
Fri, 26 Feb 2016 11:08:52 +0000 (20:08 +0900)
doc/SDL/BUGS.txt [new file with mode: 0644]
doc/SDL/COPYING.txt [new file with mode: 0644]
doc/SDL/CREDITS.txt [new file with mode: 0644]
doc/SDL/INSTALL.txt [new file with mode: 0644]
doc/SDL/README-SDL.txt [new file with mode: 0644]
doc/SDL/README.txt [new file with mode: 0644]
doc/SDL/WhatsNew.txt [new file with mode: 0644]

diff --git a/doc/SDL/BUGS.txt b/doc/SDL/BUGS.txt
new file mode 100644 (file)
index 0000000..7ef5538
--- /dev/null
@@ -0,0 +1,16 @@
+\r
+Bugs are now managed in the SDL bug tracker, here:\r
+\r
+    http://bugzilla.libsdl.org/\r
+\r
+You may report bugs there, and search to see if a given issue has already\r
+ been reported, discussed, and maybe even fixed.\r
+\r
+\r
+You may also find help on the SDL mailing list. Subscription information:\r
+\r
+    http://lists.libsdl.org/listinfo.cgi/sdl-libsdl.org\r
+\r
+Bug reports are welcome here, but we really appreciate if you use Bugzilla, as\r
+ bugs discussed on the mailing list may be forgotten or missed.\r
+\r
diff --git a/doc/SDL/COPYING.txt b/doc/SDL/COPYING.txt
new file mode 100644 (file)
index 0000000..e0d7cc4
--- /dev/null
@@ -0,0 +1,20 @@
+\r
+Simple DirectMedia Layer\r
+Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>\r
+  \r
+This software is provided 'as-is', without any express or implied\r
+warranty.  In no event will the authors be held liable for any damages\r
+arising from the use of this software.\r
+\r
+Permission is granted to anyone to use this software for any purpose,\r
+including commercial applications, and to alter it and redistribute it\r
+freely, subject to the following restrictions:\r
+  \r
+1. The origin of this software must not be misrepresented; you must not\r
+   claim that you wrote the original software. If you use this software\r
+   in a product, an acknowledgment in the product documentation would be\r
+   appreciated but is not required. \r
+2. Altered source versions must be plainly marked as such, and must not be\r
+   misrepresented as being the original software.\r
+3. This notice may not be removed or altered from any source distribution.\r
+\r
diff --git a/doc/SDL/CREDITS.txt b/doc/SDL/CREDITS.txt
new file mode 100644 (file)
index 0000000..74163e8
--- /dev/null
@@ -0,0 +1,53 @@
+\r
+Simple DirectMedia Layer CREDITS\r
+Thanks to everyone who made this possible, including:\r
+\r
+* Cliff Matthews, for giving me a reason to start this project. :)\r
+ -- Executor rocks!  *grin*\r
+\r
+* Ryan Gordon for helping everybody out and keeping the dream alive. :)\r
+\r
+* Gabriel Jacobo for his work on the Android port and generally helping out all around.\r
\r
+* Philipp Wiesemann for his attention to detail reviewing the entire SDL code base and proposes patches.\r
+\r
+* Andreas Schiffler for his dedication to unit tests, Visual Studio projects, and managing the Google Summer of Code.\r
+\r
+* Mike Sartain for incorporating SDL into Team Fortress 2 and cheering me on at Valve.\r
+\r
+* Alfred Reynolds for the game controller API and general (in)sanity\r
+\r
+* Jørgen Tjernø for numerous magical Mac OS X fixes.\r
+\r
+* Pierre-Loup Griffais for his deep knowledge of OpenGL drivers.\r
\r
+* Julian Winter for the SDL 2.0 website.\r
+\r
+* Sheena Smith for many months of great work on the SDL wiki creating the API documentation and style guides.\r
+\r
+* Paul Hunkin for his port of SDL to Android during the Google Summer of Code 2010.\r
+\r
+* Eli Gottlieb for his work on shaped windows during the Google Summer of Code 2010.\r
+\r
+* Jim Grandpre for his work on multi-touch and gesture recognition during\r
+  the Google Summer of Code 2010.\r
+\r
+* Edgar "bobbens" Simo for his force feedback API development during the\r
+  Google Summer of Code 2008.\r
+\r
+* Aaron Wishnick for his work on audio resampling and pitch shifting during\r
+  the Google Summer of Code 2008.\r
+\r
+* Holmes Futrell for his port of SDL to the iPhone and iPod Touch during the\r
+  Google Summer of Code 2008.\r
+\r
+* Jon Atkins for SDL_image, SDL_mixer and SDL_net documentation.\r
+\r
+* Everybody at Loki Software, Inc. for their great contributions!\r
+\r
+ And a big hand to everyone else who has contributed over the years.\r
+\r
+THANKS! :)\r
+\r
+  -- Sam Lantinga                      <slouken@libsdl.org>\r
+\r
diff --git a/doc/SDL/INSTALL.txt b/doc/SDL/INSTALL.txt
new file mode 100644 (file)
index 0000000..25627a3
--- /dev/null
@@ -0,0 +1,15 @@
+\r
+To install SDL for native development:\r
+    make native\r
+\r
+To install SDL for cross-compiling development:\r
+    make cross\r
+\r
+Look at the example programs in ./test, and check out online documentation:\r
+    http://wiki.libsdl.org/\r
+\r
+Join the SDL developer mailing list if you want to join the community:\r
+    http://www.libsdl.org/mailing-list.php\r
+\r
+That's it!\r
+Sam Lantinga <slouken@libsdl.org>\r
diff --git a/doc/SDL/README-SDL.txt b/doc/SDL/README-SDL.txt
new file mode 100644 (file)
index 0000000..0630395
--- /dev/null
@@ -0,0 +1,13 @@
+\r
+Please distribute this file with the SDL runtime environment:\r
+\r
+The Simple DirectMedia Layer (SDL for short) is a cross-platform library\r
+designed to make it easy to write multi-media software, such as games and\r
+emulators.\r
+\r
+The Simple DirectMedia Layer library source code is available from:\r
+http://www.libsdl.org/\r
+\r
+This library is distributed under the terms of the zlib license:\r
+http://www.zlib.net/zlib_license.html\r
+\r
diff --git a/doc/SDL/README.txt b/doc/SDL/README.txt
new file mode 100644 (file)
index 0000000..735637b
--- /dev/null
@@ -0,0 +1,42 @@
+\r
+                         Simple DirectMedia Layer\r
+\r
+                                  (SDL)\r
+\r
+                                Version 2.0\r
+\r
+---\r
+http://www.libsdl.org/\r
+\r
+Simple DirectMedia Layer is a cross-platform development library designed\r
+to provide low level access to audio, keyboard, mouse, joystick, and graphics\r
+hardware via OpenGL and Direct3D. It is used by video playback software,\r
+emulators, and popular games including Valve's award winning catalog\r
+and many Humble Bundle games.\r
+\r
+SDL officially supports Windows, Mac OS X, Linux, iOS, and Android.\r
+Support for other platforms may be found in the source code.\r
+\r
+SDL is written in C, works natively with C++, and there are bindings \r
+available for several other languages, including C# and Python.\r
+\r
+This library is distributed under the zlib license, which can be found\r
+in the file "COPYING.txt".\r
+\r
+The best way to learn how to use SDL is to check out the header files in\r
+the "include" subdirectory and the programs in the "test" subdirectory.\r
+The header files and test programs are well commented and always up to date.\r
+More documentation and FAQs are available online at:\r
+       http://wiki.libsdl.org/\r
+\r
+If you need help with the library, or just want to discuss SDL related\r
+issues, you can join the developers mailing list:\r
+       http://www.libsdl.org/mailing-list.php\r
+\r
+If you want to report bugs or contribute patches, please submit them to\r
+bugzilla:\r
+    http://bugzilla.libsdl.org/\r
+\r
+Enjoy!\r
+       Sam Lantinga                            (slouken@libsdl.org)\r
+\r
diff --git a/doc/SDL/WhatsNew.txt b/doc/SDL/WhatsNew.txt
new file mode 100644 (file)
index 0000000..bcbdcd1
--- /dev/null
@@ -0,0 +1,108 @@
+\r
+This is a list of major changes in SDL's version history.\r
+\r
+---------------------------------------------------------------------------\r
+2.0.3:\r
+---------------------------------------------------------------------------\r
+\r
+Mac OS X:\r
+* Fixed creating an OpenGL context by default on Mac OS X 10.6\r
+\r
+\r
+---------------------------------------------------------------------------\r
+2.0.2:\r
+---------------------------------------------------------------------------\r
+General:\r
+* Added SDL_GL_ResetAttributes() to reset OpenGL attributes to default values\r
+* Added an API to load a database of game controller mappings from a file:\r
+    SDL_GameControllerAddMappingsFromFile(), SDL_GameControllerAddMappingsFromRW()\r
+* Added game controller mappings for the PS4 and OUYA controllers\r
+* Added SDL_GetDefaultAssertionHandler() and SDL_GetAssertionHandler()\r
+* Added SDL_DetachThread()\r
+* Added SDL_HasAVX() to determine if the CPU has AVX features\r
+* Added SDL_vsscanf(), SDL_acos(), and SDL_asin() to the stdlib routines\r
+* EGL can now create/manage OpenGL and OpenGL ES 1.x/2.x contexts, and share\r
+  them using SDL_GL_SHARE_WITH_CURRENT_CONTEXT\r
+* Added a field "clicks" to the mouse button event which records whether the event is a single click, double click, etc.\r
+* The screensaver is now disabled by default, and there is a hint SDL_HINT_VIDEO_ALLOW_SCREENSAVER that can change that behavior.\r
+* Added a hint SDL_HINT_MOUSE_RELATIVE_MODE_WARP to specify whether mouse relative mode should be emulated using mouse warping.\r
+* testgl2 does not need to link with libGL anymore\r
+* Added testgles2 test program to demonstrate working with OpenGL ES 2.0\r
+* Added controllermap test program to visually map a game controller\r
+\r
+Windows:\r
+* Support for OpenGL ES 2.x contexts using either WGL or EGL (natively via\r
+  the driver or emulated through ANGLE)\r
+* Added a hint SDL_HINT_VIDEO_WIN_D3DCOMPILER to specify which D3D shader compiler to use for OpenGL ES 2 support through ANGLE\r
+* Added a hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that is useful when creating multiple windows that should share the same OpenGL context.\r
+* Added an event SDL_RENDER_TARGETS_RESET that is sent when D3D9 render targets are reset after the device has been restored.\r
+\r
+Mac OS X:\r
+* Added a hint SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK to control whether Ctrl+click should be treated as a right click on Mac OS X. This is off by default.\r
+\r
+Linux:\r
+* Fixed fullscreen and focused behavior when receiving NotifyGrab events\r
+* Added experimental Wayland and Mir support, disabled by default\r
+\r
+Android:\r
+* Joystick support (minimum SDK version required to build SDL is now 12, \r
+  the required runtime version remains at 10, but on such devices joystick \r
+  support won't be available).\r
+* Hotplugging support for joysticks\r
+* Added a hint SDL_HINT_ACCELEROMETER_AS_JOYSTICK to control whether the accelerometer should be listed as a 3 axis joystick, which it will by default.\r
+\r
+\r
+---------------------------------------------------------------------------\r
+2.0.1:\r
+---------------------------------------------------------------------------\r
+\r
+General:\r
+* Added an API to get common filesystem paths in SDL_filesystem.h:\r
+    SDL_GetBasePath(), SDL_GetPrefPath()\r
+* Added an API to do optimized YV12 and IYUV texture updates:\r
+    SDL_UpdateYUVTexture()\r
+* Added an API to get the amount of RAM on the system:\r
+    SDL_GetSystemRAM()\r
+* Added a macro to perform timestamp comparisons with SDL_GetTicks():\r
+    SDL_TICKS_PASSED()\r
+* Dramatically improved OpenGL ES 2.0 rendering performance\r
+* Added OpenGL attribute SDL_GL_FRAMEBUFFER_SRGB_CAPABLE\r
+\r
+Windows:\r
+* Created a static library configuration for the Visual Studio 2010 project\r
+* Added a hint to create the Direct3D device with support for multi-threading:\r
+    SDL_HINT_RENDER_DIRECT3D_THREADSAFE\r
+* Added a function to get the D3D9 adapter index for a display:\r
+    SDL_Direct3D9GetAdapterIndex()\r
+* Added a function to get the D3D9 device for a D3D9 renderer:\r
+    SDL_RenderGetD3D9Device()\r
+* Fixed building SDL with the mingw32 toolchain (mingw-w64 is preferred)\r
+* Fixed crash when using two XInput controllers at the same time\r
+* Fixed detecting a mixture of XInput and DirectInput controllers\r
+* Fixed clearing a D3D render target larger than the window\r
+* Improved support for format specifiers in SDL_snprintf()\r
+\r
+Mac OS X:\r
+* Added support for retina displays:\r
+  Create your window with the SDL_WINDOW_ALLOW_HIGHDPI flag, and then use SDL_GL_GetDrawableSize() to find the actual drawable size. You are responsible for scaling mouse and drawing coordinates appropriately.\r
+* Fixed mouse warping in fullscreen mode\r
+* Right mouse click is emulated by holding the Ctrl key while left clicking\r
+\r
+Linux:\r
+* Fixed float audio support with the PulseAudio driver\r
+* Fixed missing line endpoints in the OpenGL renderer on some drivers\r
+* X11 symbols are no longer defined to avoid collisions when linking statically\r
+\r
+iOS:\r
+* Fixed status bar visibility on iOS 7\r
+* Flipped the accelerometer Y axis to match expected values\r
+\r
+Android:\r
+IMPORTANT: You MUST get the updated SDLActivity.java to match C code\r
+* Moved EGL initialization to native code \r
+* Fixed the accelerometer axis rotation relative to the device rotation\r
+* Fixed race conditions when handling the EGL context on pause/resume\r
+* Touch devices are available for enumeration immediately after init\r
+\r
+Raspberry Pi:\r
+* Added support for the Raspberry Pi, see README-raspberrypi.txt for details\r