Jaylon Gowie
88578dc9cb
Update Docs
2021-09-10 19:49:47 -07:00
Jaylon Gowie
5fa8a042ac
Fix the indentation
2021-09-10 19:49:47 -07:00
Ivan Epifanov
82c91fed21
Update docs
2021-09-09 07:22:01 -07:00
Ellie
21160cb815
Formatting fixes (purely cosmetic, fixes GitHub's rendering)
2021-09-07 07:29:40 -10:00
Ryan C. Gordon
57bfed79e2
README-dynapi.md: Google+ link is gone, remove it.
...
The Wayback Machine doesn't even have it. :(
2021-08-03 22:15:04 -04:00
Ryan C. Gordon
178c95f82c
README-winrt.md: Cleaned up sample code
...
- Fixed the markdown.
- Code can now be exited by pressing ESC.
- Cleans up and returns from main()
- Mushed all the `if (x) { return 0; }` blocks into else ifs.
2021-08-03 21:52:47 -04:00
Ryan C. Gordon
9632fb3369
README-dynapi.md: Cleaned up markdown formatting.
2021-07-23 12:48:28 -04:00
Sam Lantinga
599001d4c7
Revert "Removed reference to ant project."
...
This reverts commit 0cad302346
.
The ant directory still exists in source control
2021-07-07 13:30:48 -07:00
Gianfranco Berardi
0cad302346
Removed reference to ant project.
...
The android-project-ant directory does not exist anymore.
2021-06-14 12:58:48 -07:00
Ivan Epifanov
3c02814194
Update docs and fix typos
2021-06-11 13:21:07 -04:00
Sylvain
f5b87273e1
Fixed bug #4397 - update IOS documentation
2021-06-02 08:32:43 +02:00
Sylvain
30359a689f
Android: document workaround to use JNI on native thread (see bug #4406 )
2021-06-01 20:11:59 +02:00
Cacodemon345
ddc6be3559
KMSDRM on Dragonfly BSD doesn't work without being root
2021-05-12 09:26:23 -07:00
Ryan C. Gordon
2542977b0a
Revert "Update wiki.libsdl.org urls to libsdl-org/SDL/wiki ( #4069 )"
...
This reverts commit 82a96afa70
.
We ended up not moving to GitHub's wiki after all and built
https://github.com/icculus/ghwikipp to fill the gap...since the wiki is
back at https://wiki.libsdl.org/ , put back the original URLs.
2021-04-01 12:15:28 -04:00
Cacodemon345
1899844952
Fix GitHub display of README-android.md
2021-03-21 01:15:14 +06:00
Ivan Epifanov
1e5cc96199
Docs
2021-03-08 09:07:12 -08:00
Cameron Cawley
2f4e9294aa
Update the Linux build instructions
2021-02-25 19:24:50 +03:00
Ryan C. Gordon
c4b7e485af
docs: README.md points to Discourse instead of the mailing list now.
2021-02-18 11:10:20 -05:00
Ryan C. Gordon
abe2c0f1b1
license: Fixed references to COPYING.txt that are now LICENSE.txt.
...
Fixes #4108
2021-02-18 11:07:26 -05:00
Cacodemon345
0a58010c0d
Fix README-kmsbsd.md Markdown display
2021-02-17 13:11:00 -05:00
Cacodemon345
350e0ae1fd
Add documentation for KMSDRM on *BSDs
2021-02-15 15:24:52 -05:00
erik yuzwa
92506462e2
update some copy
2021-02-15 08:35:13 -08:00
erik yuzwa
be17004e67
updated some notes around using a newer IDE
2021-02-15 08:35:13 -08:00
erik yuzwa
7f1b833373
initial work
2021-02-15 08:35:13 -08:00
Erik Yuzwa
82a96afa70
Update wiki.libsdl.org urls to libsdl-org/SDL/wiki ( #4069 )
2021-02-13 11:49:31 -05:00
Ryan C. Gordon
65fbf36c9e
Cleaned up a few more Bugzilla mentions.
2021-02-12 14:46:49 -05:00
Ryan C. Gordon
4ff51d29c3
Deprecate SDL_GetRevisionNumber and update things for git instead of hg.
...
Fixes #4063
2021-02-12 14:31:38 -05:00
Ryan C. Gordon
f9046b4cab
We're in Git now! Updated docs.
2021-02-11 14:39:08 -08:00
Sylvain Becker
d74779b748
Android: documention update
2021-02-10 10:22:19 -05:00
Ozkan Sezer
20db1471e5
added documentation docs/README-os2.md (based on original readme.os2).
2020-10-14 23:01:06 +03:00
Ryan C. Gordon
d31dac1563
docs: README-linux.md updated for a modern Ubuntu release.
2020-05-14 21:54:51 -04:00
Ryan C. Gordon
ec2d70364a
docs: Fixed README-linux.md's line endings and word wrap.
2020-05-14 21:49:29 -04:00
Ryan C. Gordon
2d5de8faf9
docs: Linux systems don't need to install wayland-protocols anymore.
...
We ship the protocol xml files we need with SDL's sources now.
2020-05-14 21:48:24 -04:00
Ryan C. Gordon
b8590f1aec
README-ios: added a note about enabling hidapi.
2018-10-29 15:51:38 -04:00
David Ludwig
3d55a51482
CMake: tabs to spaces in new parts of README-cmake.md
2019-09-23 18:30:22 -04:00
David Ludwig
00bc7f6b96
CMake: document iOS/tvOS support in README-cmake.md
2019-09-23 18:27:14 -04:00
Sylvain Becker
155087d106
Fixed bug 3918 - CMake support for android project
2019-08-11 15:23:37 +02:00
Ethan Lee
225ae6909e
Add notes for SDL_WinRTRunApp and SDL2-WinRTResources for non-C++ projects
2019-06-09 11:54:51 -04:00
Sylvain Becker
05333a6e9f
Android: add hint SDL_HINT_ANDROID_BLOCK_ON_PAUSE
...
to set whether the event loop will block itself when the app is paused.
2019-04-05 09:16:30 +02:00
Hugh McMaster
14b385f2bf
docs: Replace references to configure.in with configure.ac
2019-03-27 20:58:33 +11:00
Sam Lantinga
390459d83e
Updated minimum supported Android version to API 16, to match latest NDK toolchain
2019-01-12 12:11:06 -08:00
Sylvain Becker
d09774a47c
Fixed bug 3511 - documentation to end an Android application
2018-12-30 14:23:25 +01:00
Ryan C. Gordon
bc57ac27f9
mir: Removed mir client support.
...
Fixes Bugzilla #4288 .
2018-11-02 21:34:17 -04:00
Sam Lantinga
950f39e23b
Backed out changeset 2944045e695b, SDL_JOYSTICK_HIDAPI is only used on iOS for Steam Controller support, which is not publicly available.
2018-10-29 19:58:59 -07:00
Ryan C. Gordon
b43f427fa6
README-ios: added a note about enabling hidapi.
2018-10-29 15:51:38 -04:00
Sam Lantinga
e381a1599d
Updated Android project files and documentation
2018-10-28 10:31:06 -07:00
Sam Lantinga
38ae49880f
Updated required Android SDK to API 26, to match Google's new App Store requirements
2018-08-21 20:46:25 -07:00
Ryan C. Gordon
b7e88aaae0
audio: Added ARM NEON versions of audio converters.
...
These are _much_ faster than the scalar equivalents on the Raspberry Pi that
I tested on. Often 3x to 4x as fast!
2018-05-16 02:03:06 -04:00
Sam Lantinga
6e01fbb763
On Android show the system UI when an SDL window is windowed, hide the system UI when it's fullscreen, like we do on iOS.
...
We're increasing the Android SDK minimum version to API 19, this doesn't increase the minimum target API, which is API 14.
2018-02-11 18:23:37 -08:00
Ryan C. Gordon
351d6d4784
audio: Port WASAPI to WinRT, remove XAudio2 backend.
...
XAudio2 doesn't have capture support, so WASAPI was to replace it; the holdout
was WinRT, which still needed it as its primary audio target until the WASAPI
code code be made to work.
The support matrix now looks like:
WinXP: directsound by default, winmm as a fallback for buggy drivers.
Vista+: WASAPI (directsound and winmm as fallbacks for debugging).
WinRT: WASAPI
2017-12-06 12:24:32 -05:00
Sam Lantinga
14452e9550
Fixed typos (thanks Martin!)
2017-12-04 20:21:52 -08:00
Sam Lantinga
fa5db3a931
Added the old ant Android build project structure
2017-10-28 12:11:25 -07:00
Sam Lantinga
edf0fae139
Updated Android build tools version, which bumped minimum deployment target to API 14
...
Also added native code to the Android gradle project, which allows using gradle or Android Studio to build the entire SDL application without a separate ndk-build step.
2017-10-23 23:23:47 -07:00
Sam Lantinga
f08480af78
Switched to new style gradle Android application build process
2017-10-23 15:23:43 -07:00
Sam Lantinga
bd5c984ac0
Fixed bug 3850 - incorrect numbering in docs/README-ios.md
...
Michal
the numbering of the bulletpoints in:
docs/README-ios.md
has been mangled with:
changeset 11365 efd3bc8e5a9b
fix:
12 2. Open SDL.xcodeproj (located in Xcode-iOS/SDL) in Xcode.
13 4. Select your desired target, and hit build.
remove:
28 1. Follow step 1 above.
adapt:
29 2. cd (PATH WHERE THE SDL CODE IS)/build-scripts
30 3. ./iosbuild.sh
2017-09-26 16:27:24 -07:00
Sam Lantinga
12efabcbf0
Added instructions for deploying to older iOS devices (thanks Sylvain!)
2017-09-22 11:13:34 -07:00
David Ludwig
e365968a4c
WinRT: minor formatting tweak in README-winrt
2017-09-19 10:33:08 -04:00
David Ludwig
f57ef6ff97
WinRT: noted UWP's inability to work with some game controllers
2017-09-19 10:31:22 -04:00
Sam Lantinga
5c8bde4f7b
Updated documentation to note that libvulkan-dev is no longer needed
2017-09-09 07:45:31 -07:00
David Ludwig
2ea09903e6
WinRT: listed VS 2017 optional-component requirements
2017-09-03 16:36:22 -04:00
Sam Lantinga
6c38c9007b
Update Android SDK required to API level 16
...
Sylvain
Some API 16 methods are used (InputDevice: getDescriptor(), getVibrator()), so we need to compile at least with SDK API 16. Hence default.properties and project.properties have been modified to use android-16.
There are also some modification to SDLActivity.java not to use getVibrator() if we run under API 16. And not to check to presence of hasVibrator() if we are under API 11.
-some hard-coded constant can be expandend.
- rename a local variable (hasVibrator to hasVibratorService)
2017-08-31 15:12:08 -07:00
Sam Lantinga
309474765b
We don't need the VULKAN_SDK to build SDL with Vulkan support anymore
2017-08-28 19:30:59 -07:00
Sam Lantinga
ce2b16445e
Be clear that disabling Vulkan surface support disables the entire SDL Vulkan integration
2017-08-28 00:11:38 -07:00
Ryan C. Gordon
25e3a1ec90
vulkan: Initial Vulkan support!
...
This work was done by Jacob Lifshay and Mark Callow; I'm just merging it
into revision control.
2017-08-27 22:15:57 -04:00
Sam Lantinga
148ac5b3cf
Added Matt Styles' tutorial on building SDL for Android with Visual Studio
2017-08-19 00:27:11 -07:00
Ryan C. Gordon
76306827ec
README-linux.md: added libsndio-dev to the package list.
2017-08-07 00:36:45 -04:00
Philipp Wiesemann
46b77b7322
raspberrypi: Fixed typos in README.
2017-06-24 23:45:34 +02:00
Philipp Wiesemann
a0aff76416
Added missing path in porting README.
2017-05-13 23:01:04 +02:00
Philipp Wiesemann
f1296a8652
Emscripten: Simplified option name in build script and README.
2017-04-02 21:33:24 +02:00
Ryan C. Gordon
2ce52bf9e1
README-hg.md: Updated main Mercurial website.
2017-04-01 00:17:15 -04:00
Philipp Wiesemann
7122036d03
Updated file name in porting README.
2017-03-19 22:16:24 +01:00
Charlie Birks
90e302d074
Remove link to emscripten tests
...
Not updated since early port. Also stopped working when Dropbox
stopped allowing HTML to be parsed.
2017-02-17 10:13:10 +00:00
Ryan C. Gordon
8ad131b78e
readme: more HTTPS changes.
2017-02-16 13:55:12 -05:00
Philipp Wiesemann
330f2911c2
WinRT: Fixed typo in README.
2017-01-22 22:15:24 +01:00
Philipp Wiesemann
a812b4eb37
Changed Bugzilla link in README.md to HTTPS like in BUGS.txt.
2017-01-14 21:35:18 +01:00
Ryan C. Gordon
53588ff6b8
README-linux: added notes about libsamplerate.
2017-01-08 14:16:19 -05:00
Philipp Wiesemann
6f1f77b297
Fixed outdated info in README.
2016-10-30 21:01:33 +01:00
Sam Lantinga
54eb9067e1
Fixed bug 3460 - docs/README-macosx.md: g++fat.sh should be g++-fat.sh in universal build command
...
Elis?e Maurer
I scratched my head for a while until I realized there's a typo in the command listed in the instructions for universal Mac builds: https://hg.libsdl.org/SDL/file/3a3a88db1fc2/docs/README-macosx.md#l24
It should say `g++-fat.sh` but instead it says `g++fat.sh`, which makes `./configure` fail with a C++ preprocessor error.
2016-10-19 20:50:33 -07:00
Philipp Wiesemann
1fd2646c60
Android: Split long line in README.
2016-10-15 20:01:50 +02:00
Sam Lantinga
42f85aa29e
Fixed building and using fcitx IME support on Linux
2016-10-08 11:30:07 -07:00
Sam Lantinga
d3cbc664d5
Fixed bug 2983 - Update Android.readme to include Tegra Graphics Debugger compatibility tip
...
Michael Labb?
NVidia has released some pretty nice Tegra profiling tools for their Android devices. The NVidia Tegra Graphics Debugger works by providing an interposer library that intercepts ES2 and EGL calls. You must link against these libraries.
Unfortunately, this quietly fails with SDL2 because libEGL and libGLES2 are dynamically loaded with dlopen().
NVidia offers a secondary approach to using the Tegra Graphics Debugger: root your device and install a global interposer library. Almost no devs will try this first if they don?t have a rooted device.
I propose an update to the Android readme that explains why the static linking approach recommended by NVidia doesn?t work.
2016-10-07 17:49:33 -07:00
Sam Lantinga
104c9541d9
Converted README documentation to DOS text format
2016-10-07 17:46:58 -07:00
Ryan C. Gordon
f33c58b004
Updated Linux notes on building with Mir and Wayland support.
2016-09-29 12:04:07 -04:00
Philipp Wiesemann
fc469f6f27
Mac: Fixed markdown formatting in README.
...
The newlines were lost in doxygen output.
2016-09-21 23:07:08 +02:00
Philipp Wiesemann
456901150c
Fixed information in touch README and changed identifiers so doxygen links them.
2016-07-27 20:47:31 +02:00
Philipp Wiesemann
696867eed4
Mac: Updated file name in README.
2016-06-25 19:40:02 +02:00
David Ludwig
441359bd5a
WinRT: workaround a possible Windows bug, whereby hiding cursors, disables mouse-moved events
...
This workaround, unfortunately, requires that apps directly link to a set of
Win32-style cursor resource files (that contain a transparent cursor image).
Copies of suitable resource files are in src/core/winrt/, and should be
included directly in an app's MSVC project.
A rough explanation of this workaround/hack, and why it's needed (and
seemingly can't be done through programmatic means), is in this change's code.
2016-05-14 23:29:49 -04:00
Philipp Wiesemann
fe4c3b29d9
iOS: Added brackets to function names in README so that doxygen links them.
2016-05-10 21:15:11 +02:00
David Ludwig
46851a6701
WinRT: another README tweak
2016-04-17 22:56:20 -04:00
David Ludwig
937ae32c7b
WinRT: README tweaks
2016-04-17 22:54:45 -04:00
Philipp Wiesemann
ea86c01a86
Fixed markdown formatting in porting README for doxygen output.
...
The underscores and the newlines for the list were lost before.
2016-04-14 21:10:57 +02:00
Philipp Wiesemann
3555e6e58e
Updated info about required Ubuntu version for Mir support in README.
2016-04-01 21:10:43 +02:00
Philipp Wiesemann
4011d991e7
Fixed doxygen warnings about markdown formatting.
2016-02-24 21:05:19 +01:00
Philipp Wiesemann
5ba1fd9bb1
Fixed typo in README for iOS.
2016-01-01 17:41:11 +01:00
Alex Szpakowski
4aae0290ea
Updated some header comments and iOS documentation to better clarify high-dpi / retina support and screen-coordinate sizes versus pixel sizes.
2015-12-31 21:16:43 -04:00
David Ludwig
25abce513d
WinRT: added Win10/UWP (Universal Windows Platform) support
...
"UWP" appears to be Microsoft's new name for WinRT/Windows-Store APIs.
This set of changes updates SDL's WinRT backends to support the Win10 flavor
of WinRT. It has been tested on Win10 on a desktop. In theory, it should
also support Win10 on other devices (phone, Xbox One, etc.), however further
patches may be necessary.
This adds:
- a set of MSVC 2015 project files, for use in creating UWP apps
- modifications to various pieces of SDL, in order to compile via MSVC 2015 +
the Win10 API set
- enables SDL_Window resizing and programmatic-fullscreen toggling, when using
the WinRT backend
- WinRT README updates
2015-11-29 19:33:11 -05:00
Philipp Wiesemann
d79bfa0d18
Added filesystem to list of paths in porting README.
2015-07-31 20:15:39 +02:00
Alex Szpakowski
6ea942dae3
Added MSAA support for OpenGL ES contexts on iOS.
...
Note that extra steps must be taken when using glReadPixels to read the contents of the main OpenGL ES framebuffer on iOS, if multisampling is used. See the OpenGL ES section of README-ios.md for details.
2015-07-19 19:44:40 -03:00
Philipp Wiesemann
9b6f159c3d
Emscripten: Corrected build instructions in documentation.
...
And fixed a typo.
2015-06-26 20:11:41 +02:00
Ryan C. Gordon
437a6d9da9
Updated Mac OS X documentation for fatbuilt.sh -> gcc-fat.sh transition.
2015-06-22 21:30:08 -04:00