Commit graph

128 commits

Author SHA1 Message Date
Philipp Wiesemann
cea5990d5a Fixed information in touch README and changed identifiers so doxygen links them. 2016-07-27 20:47:31 +02:00
Philipp Wiesemann
87a3a9d5db Mac: Updated file name in README. 2016-06-25 19:40:02 +02:00
David Ludwig
65f383561e 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
4f43ef23de iOS: Added brackets to function names in README so that doxygen links them. 2016-05-10 21:15:11 +02:00
David Ludwig
691f0454e6 WinRT: another README tweak 2016-04-17 22:56:20 -04:00
David Ludwig
638d7e1a81 WinRT: README tweaks 2016-04-17 22:54:45 -04:00
Philipp Wiesemann
dd03d060c8 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
5ac3e2b08a Updated info about required Ubuntu version for Mir support in README. 2016-04-01 21:10:43 +02:00
Philipp Wiesemann
35ad322b34 Fixed doxygen warnings about markdown formatting. 2016-02-24 21:05:19 +01:00
Philipp Wiesemann
8e2a8c6561 Fixed typo in README for iOS. 2016-01-01 17:41:11 +01:00
Alex Szpakowski
1c47d39ad1 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
028a80e83b 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
6d7a315742 Added filesystem to list of paths in porting README. 2015-07-31 20:15:39 +02:00
Alex Szpakowski
d81533aeed 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
c62442af8e Emscripten: Corrected build instructions in documentation.
And fixed a typo.
2015-06-26 20:11:41 +02:00
Ryan C. Gordon
a101d1ee7c Updated Mac OS X documentation for fatbuilt.sh -> gcc-fat.sh transition. 2015-06-22 21:30:08 -04:00
Ryan C. Gordon
7b65ca77ee Moving some whitespace around to test something on the Mercurial server. 2015-06-18 00:44:57 -04:00
Ryan C. Gordon
976a842c8e Whitespace fix. 2015-06-17 13:02:41 -04:00
Philipp Wiesemann
fae1940667 Excluded SDL_egl.h from doxygen input. 2015-06-16 20:25:53 +02:00
Ryan C. Gordon
cb03224602 Normalized endlines. 2015-06-08 03:07:24 -04:00
Ryan C. Gordon
3fd51aa2cc Added LDFLAGS note to Raspberry Pi documentation (thanks, Michael!). 2015-06-08 03:07:16 -04:00
Philipp Wiesemann
295e6b3609 Fixed typo in gesture README. 2015-04-07 23:00:56 +02:00
David Ludwig
6a1d79c7cd WinRT: updated names, and references-to, various ANGLE/WinRT repositories 2015-03-18 12:03:32 -04:00
Ryan C. Gordon
25c786a0d9 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.

--HG--
extra : rebase_source : 3be8e4d6bb5c9fb121ffab0847e868cfce068e27
2015-02-18 16:17:53 -05:00
David Ludwig
445da2c732 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

--HG--
extra : rebase_source : 504904b549f21d518919b2254319783da7c9bbdf
2015-02-08 15:44:15 -05:00
Philipp Wiesemann
581841e8cf Updated a README. 2015-01-26 22:02:53 +01:00
Philipp Wiesemann
daf530147d Linked README-emscripten.md in README.md and added markdown formatting. 2014-12-28 22:02:17 +01:00
Philipp Wiesemann
f292374de1 Renamed README-emscripten.txt to README-emscripten.md.
--HG--
rename : docs/README-emscripten.txt => docs/README-emscripten.md
2014-12-28 22:00:24 +01:00
Philipp Wiesemann
93ff35dbfc Fixed typos in a README. 2014-12-25 22:07:15 +01:00
Ryan C. Gordon
de88474dda 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!)

--HG--
extra : rebase_source : 97af74c8a5121e926ebe89f123536b5dd6681695
2014-12-18 00:19:52 -05:00
David Ludwig
594785a021 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
cba7a719d8 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
David Ludwig
fda1375d4e WinRT: added SDL_HINT_WINRT_PREF_PATH_ROOT
SDL_HINT_WINRT_PREF_PATH_ROOT allows WinRT apps to alter the path that
SDL_GetPrefPath() returns.  Setting it to "local" uses the app's
OS-defined Local folder, setting it to "roaming" uses the app's OS-defined
Roaming folder.

Roaming folder support is not available in Windows Phone 8.0.  Attempts to
make SDL_GetPrefPath() return a Roaming folder on this OS will be ignored.

Various bits of documentation on this were added to SDL_hints.h, and to
README-winrt.md
2014-11-27 09:55:34 -05:00
David Ludwig
53b5ab0011 WinRT: updated README-winrt.md to detail Visual Studio 2013 Community support 2014-11-15 15:07:55 -05:00
David Ludwig
17e1ac0cc2 WinRT: updated docs to include details of recently-expanded GLES2 support 2014-11-02 11:26:54 -05:00
David Ludwig
126039f02f WinRT: moved documentation + setup related TODO items out of README-winrt.md
The TODO items were moved to SDL Bugzilla, case 2775 (https://bugzilla.libsdl.org/show_bug.cgi?id=2775).
2014-11-01 11:41:18 -04:00
David Ludwig
b7fdd52261 WinRT: made README-winrt.md slightly easier to read in an 80-column text editor 2014-11-01 11:17:07 -04:00
David Ludwig
c09730eaed WinRT: added details of the port's status, to README-winrt.md 2014-11-01 11:14:46 -04:00
David Ludwig
2ccf9641c8 WinRT: detailed steps, via the WinRT README, to fix a common build error 2014-10-27 19:53:44 -04:00
Gabriel Jacobo
6bd884d4a0 Clarify (lack of) support for desktop OpenGL on the Raspberry Pi 2014-10-21 11:27:06 -03:00
David Ludwig
9b713b6f0a WinRT: cleaned up the opening section of the README 2014-09-19 12:09:51 -04:00
David Ludwig
420bbb0a84 WinRT: fixed broken emphasis formatting in README, when rendering it with Doxygen 2014-09-19 11:27:18 -04:00
Philipp Wiesemann
b21d8b89b9 Fixed doxygen warning and markdown formatting.
Three backticks for blocks are not supported by doxygen.
2014-09-16 23:09:32 +02:00
David Ludwig
1a8f57ac97 WinRT: made README note that Win 8.0 targeting via MSVC 2013 Express is not possible 2014-09-14 13:10:21 -04:00
David Ludwig
b277ba5f5a WinRT: expanded and updated the README section on MSVC requirements 2014-09-14 12:57:26 -04:00
David Ludwig
133d5caf72 WinRT: added manual, app-setup instructions to the README
A number of other parts of the WinRT README were edited, either for clarity, or to help with Markdown rendering.
2014-09-14 11:36:24 -04:00
David Ludwig
83c375f91f WinRT: added a note to README regarding need for a MS account 2014-09-14 10:31:18 -04:00
David Ludwig
5b705c4f29 WinRT: cleaned up section headers 2014-09-14 10:29:54 -04:00
Philipp Wiesemann
f3ca5c6fa0 Changed version displayed in documentation generated by doxygen. 2014-09-04 22:59:32 +02:00
Ryan C. Gordon
8050ad9269 Added note about libibus-1.0-dev to the Linux README. 2014-08-21 23:03:38 -04:00