Commit Graph

96 Commits

Author SHA1 Message Date
Philipp Wiesemann
c05bfa107c raspberrypi: Fixed typos in README. 2017-06-24 23:45:34 +02:00
Philipp Wiesemann
3cd9fb2270 Added missing path in porting README. 2017-05-13 23:01:04 +02:00
Philipp Wiesemann
11874a6261 Emscripten: Simplified option name in build script and README. 2017-04-02 21:33:24 +02:00
Ryan C. Gordon
b8b305d875 README-hg.md: Updated main Mercurial website. 2017-04-01 00:17:15 -04:00
Philipp Wiesemann
e674aa1eb8 Updated file name in porting README. 2017-03-19 22:16:24 +01:00
Charlie Birks
1d731963fe 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
411c27dd6b readme: more HTTPS changes. 2017-02-16 13:55:12 -05:00
Philipp Wiesemann
8e185ea2db WinRT: Fixed typo in README. 2017-01-22 22:15:24 +01:00
Philipp Wiesemann
35b0f86be6 Changed Bugzilla link in README.md to HTTPS like in BUGS.txt. 2017-01-14 21:35:18 +01:00
Ryan C. Gordon
a612eae69e README-linux: added notes about libsamplerate. 2017-01-08 14:16:19 -05:00
Philipp Wiesemann
ac44944886 Fixed outdated info in README. 2016-10-30 21:01:33 +01:00
Sam Lantinga
3de74e55e1 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/c1bb718f6c3f/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
2dceaf32eb Android: Split long line in README. 2016-10-15 20:01:50 +02:00
Sam Lantinga
7ec488f511 Fixed building and using fcitx IME support on Linux 2016-10-08 11:30:07 -07:00
Sam Lantinga
4379100ddb 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
c3d187a6d0 Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
Ryan C. Gordon
c4209757f5 Updated Linux notes on building with Mir and Wayland support. 2016-09-29 12:04:07 -04:00
Philipp Wiesemann
2fa84200b7 Mac: Fixed markdown formatting in README.
The newlines were lost in doxygen output.
2016-09-21 23:07:08 +02:00
Philipp Wiesemann
07a47a3323 Fixed information in touch README and changed identifiers so doxygen links them. 2016-07-27 20:47:31 +02:00
Philipp Wiesemann
df51eb9891 Mac: Updated file name in README. 2016-06-25 19:40:02 +02:00
David Ludwig
5ce0bfa718 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
888362c516 iOS: Added brackets to function names in README so that doxygen links them. 2016-05-10 21:15:11 +02:00
David Ludwig
7935b3132e WinRT: another README tweak 2016-04-17 22:56:20 -04:00
David Ludwig
6550be6896 WinRT: README tweaks 2016-04-17 22:54:45 -04:00
Philipp Wiesemann
960832466f 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
798f7e49b1 Updated info about required Ubuntu version for Mir support in README. 2016-04-01 21:10:43 +02:00
Philipp Wiesemann
48f468765f Fixed doxygen warnings about markdown formatting. 2016-02-24 21:05:19 +01:00
Philipp Wiesemann
939124f69f Fixed typo in README for iOS. 2016-01-01 17:41:11 +01:00
Alex Szpakowski
d95053a6c6 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
574e672678 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
8f69fdbc85 Added filesystem to list of paths in porting README. 2015-07-31 20:15:39 +02:00
Alex Szpakowski
e92a6c4d82 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
171928dc8a Emscripten: Corrected build instructions in documentation.
And fixed a typo.
2015-06-26 20:11:41 +02:00
Ryan C. Gordon
1410f444ad Updated Mac OS X documentation for fatbuilt.sh -> gcc-fat.sh transition. 2015-06-22 21:30:08 -04:00
Ryan C. Gordon
d6b1d573d6 Moving some whitespace around to test something on the Mercurial server. 2015-06-18 00:44:57 -04:00
Ryan C. Gordon
ef4371899e Whitespace fix. 2015-06-17 13:02:41 -04:00
Philipp Wiesemann
de99fafa57 Excluded SDL_egl.h from doxygen input. 2015-06-16 20:25:53 +02:00
Ryan C. Gordon
a4248c15eb Normalized endlines. 2015-06-08 03:07:24 -04:00
Ryan C. Gordon
9c78ae4b9b Added LDFLAGS note to Raspberry Pi documentation (thanks, Michael!). 2015-06-08 03:07:16 -04:00
Philipp Wiesemann
1286d5f6ed Fixed typo in gesture README. 2015-04-07 23:00:56 +02:00
David Ludwig
bbf610ea8d WinRT: updated names, and references-to, various ANGLE/WinRT repositories 2015-03-18 12:03:32 -04:00
Ryan C. Gordon
e310f239ab We maintain the list of platforms on the wiki now.
Also, I don't really want people emailing community members directly with
problems, so I'm removing their email addresses.

Fixes Bugzilla #2304.
2015-02-18 16:17:53 -05:00
David Ludwig
450510e4eb WinRT: made note that VSync is always enabled on WinPhone, due to OS
Windows Phone does not appear to allow VSync to be turned off.  Doing so appears
to either result in content not getting drawn (when the D3D debug runtime is
turned off), or forcing VSync back on and logging an error (when the D3D debug
runtime is turned on).

VSync had been getting turned on anyways, this change just notes such:
- via the WinRT README
- by always setting the SDL_RENDERER_PRESENTVSYNC flag when creating an
  SDL_Renderer on Windows Phone
2015-02-08 15:44:15 -05:00
Philipp Wiesemann
3c8a2ea96a Updated a README. 2015-01-26 22:02:53 +01:00
Philipp Wiesemann
ad3db2a2be Linked README-emscripten.md in README.md and added markdown formatting. 2014-12-28 22:02:17 +01:00
Philipp Wiesemann
ced2d4907f Renamed README-emscripten.txt to README-emscripten.md. 2014-12-28 22:00:24 +01:00
Philipp Wiesemann
72952d4d7e Fixed typos in a README. 2014-12-25 22:07:15 +01:00
Ryan C. Gordon
a9626cb76e Initial merge of Emscripten port!
With this commit, you can compile SDL2 with Emscripten
( http://emscripten.org/ ), and make your SDL-based C/C++ program
into a web app.

This port was due to the efforts of several people, including: Charlie Birks,
Sathyanarayanan Gunasekaran, Jukka Jylänki, Alon Zakai, Edward Rudd,
Bruce Mitchener, and Martin Gerhardy. (Thanks, everyone!)
2014-12-18 00:19:52 -05:00
David Ludwig
b4405e7215 WinRT: removed SDL_HINT_WINRT_PREF_PATH_ROOT (introduced post-2.0.3 & pre-2.0.4)
A WinRT app's Roaming folder-path can still be retrieved via calls to
SDL_WinRTGetFSPathUTF8() or SDL_WinRTGetFSPathUNICODE(), if need be.
2014-12-02 21:18:50 -05:00
David Ludwig
fc843814a3 WinRT: bug and data-integrity fixes for SDL_GetPrefPath()
This change does a few things, all with regards to the WinRT implementation of
SDL_GetPrefPath():

1. it fixes a bug whereby SDL_GetPrefPath() did not create the directory it
returned.  On other SDL platforms, SDL_GetPrefPath() will create separate
directories for its 'org' and 'app' folders.  Without this, attempts to create
files in the pref-path would fail, unless those directories were first created
by the app, or by some other library the app used.  This change makes sure
that these directories get created, before SDL_GetPrefPath() returns to its
caller(s).


2. it defaults to having SDL_GetPrefPath() return a WinRT 'Local' folder
on all platforms.  Previously, for Windows Store apps, it would have used a
different, 'Roaming' folder.  Files in Roaming folders can be automatically,
and synchronized across multiple devices by Windows.  This synchronization can
happen while the app runs, with new files being copied into a running app's
pref-path.  Unless an app is specifically designed to handle this scenario,
there is a chance that save-data could be overwritten in unwanted or
unexpected ways.

The default is now to use a Local folder, which does not get synchronized, and
which is arguably a bit safer to use.  Apps that wish to use Roaming folders
can do so by setting SDL_HINT_WINRT_PREF_PATH_ROOT to "roaming", however it
is recommended that one first read Microsoft's documentation for Roaming
files, a link to which is provided in README-winrt.md.

To preserve older pref-path selection behavior (found in SDL 2.0.3, as well as
many pre-2.0.4 versions of SDL from hg.libsdl.org), which uses a Roaming path
in Windows Store apps, and a Local path in Windows Phone, set
SDL_HINT_WINRT_PREF_PATH_ROOT to "old".

Please note that Roaming paths are not supported on Windows Phone 8.0, due to
limitations in the OS itself.  Attempts to use this will fail.
(Windows Phone 8.1 does not have this limitation, however.)


3. It makes SDL_GetPrefPath(), when on Windows Phone 8.0, and when
SDL_HINT_WINRT_PREF_PATH_ROOT is set to "roaming", return NULL, rather than
silently defaulting to a Local path (then switching to a Roaming path if and
when the user upgraded to Windows Phone 8.1).
2014-11-29 10:09:30 -05:00