docs/README-winrt.md
author David Ludwig
Sat, 15 Nov 2014 15:07:55 -0500
changeset 9224 bc074eca6597
parent 9215 6894461723ab
child 9242 f4d353bd5d16
permissions -rw-r--r--
WinRT: updated README-winrt.md to detail Visual Studio 2013 Community support
     1 WinRT
     2 =====
     3 
     4 This port allows SDL applications to run on Microsoft's platforms that require
     5 use of "Windows Runtime", aka. "WinRT", APIs.  WinRT apps are currently
     6 full-screen only, and run in what Microsoft sometimes refers to as their
     7 "Modern" (formerly, "Metro"), environment.  For Windows 8.x, Microsoft may also
     8 refer to them as "Windows Store" apps, due to them being distributed,
     9 primarily, via a Microsoft-run online store (of the same name).
    10 
    11 Some of the operating systems that include WinRT, are:
    12 
    13 * Windows 8.x
    14 * Windows RT 8.x (aka. Windows 8.x for ARM processors)
    15 * Windows Phone 8.x
    16 
    17 
    18 Requirements
    19 ------------
    20 
    21 * Microsoft Visual C++ (aka Visual Studio), either 2013 or 2012 versions
    22   - Free, "Community" or "Express" editions may be used, so long as they
    23     include  support for either "Windows Store" or "Windows Phone" apps.
    24     "Express" versions marked as supporting "Windows Desktop" development
    25     typically do not include support for creating WinRT apps, to note.
    26     (The "Community" edition of Visual C++ 2013 does, however, support both
    27     desktop/Win32 and WinRT development).
    28   - Visual C++ 2012 can only build apps that target versions 8.0 of Windows,
    29     or  Windows Phone.  8.0-targetted apps will run on devices running 8.1
    30     editions of Windows, however they will not be able to take advantage of
    31     8.1-specific features.
    32   - Visual C++ 2013 cannot create app projects that target Windows 8.0.
    33     Visual C++ 2013 Update 4, can create app projects for Windows Phone 8.0,
    34     Windows Phone 8.1, and Windows 8.1, but not Windows 8.0.  An optional
    35     Visual Studio add-in, "Tools for Maintaining Store apps for Windows 8",
    36     allows Visual C++ 2013 to load and build Windows 8.0 projects that were
    37     created with Visual C++ 2012, so long as Visual C++ 2012 is installed
    38     on the same machine.  More details on targeting different versions of
    39     Windows can found at the following web pages:
    40       - [Develop apps by using Visual Studio 2013](http://msdn.microsoft.com/en-us/library/windows/apps/br211384.aspx)
    41       - [To add the Tools for Maintaining Store apps for Windows 8](http://msdn.microsoft.com/en-us/library/windows/apps/dn263114.aspx#AddMaintenanceTools)
    42 * A valid Microsoft account - This requirement is not imposed by SDL, but
    43   rather by Microsoft's Visual C++ toolchain.  This is required to launch or 
    44   debug apps.
    45 
    46 
    47 Status
    48 ------
    49 
    50 Here is a rough list of what works, and what doens't:
    51 
    52 * What works:
    53   * compilation via Visual C++ 2012 and 2013
    54   * compile-time platform detection for SDL programs.  The C/C++ #define,
    55     `__WINRT__`, will be set to 1 (by SDL) when compiling for WinRT.
    56   * GPU-accelerated 2D rendering, via SDL_Renderer.
    57   * software rendering, via either SDL_Surface (optionally in conjunction with
    58     SDL_GetWindowSurface() and SDL_UpdateWindowSurface()) or via the
    59     SDL_Renderer APIs
    60   * threads.  Significant chunks of Win32's threading APIs are not available in
    61     WinRT.  A new, SDL threading backend was built using C++11's threading APIs
    62     (std::thread, std::mutex, std::condition_variable, etc.), which C or C++
    63     programs alike can access via SDL's threading APIs.  Support for thread
    64     priorities is not, however, currently available, due to restrictions in
    65     WinRT's own API set.
    66   * timers (via SDL_GetTicks(), SDL_AddTimer(), SDL_GetPerformanceCounter(),
    67     SDL_GetPerformanceFrequency(), etc.)
    68   * file I/O via SDL_RWops
    69   * mouse input  (unsupported on Windows Phone)
    70   * audio, via a modified version of SDL's XAudio2 backend
    71   * .DLL file loading.  Libraries must be packaged inside applications.  Loading
    72     anything outside of the app is not supported.
    73   * system path retrieval via SDL's filesystem APIs
    74   * game controllers.  Support is provided via the SDL_Joystick and
    75     SDL_GameController APIs, and is backed by Microsoft's XInput API.
    76   * multi-touch input
    77   * app events.  SDL_APP_WILLENTER* and SDL_APP_DIDENTER* events get sent out as
    78     appropriate.
    79   * window events.  SDL_WINDOWEVENT_MINIMIZED and SDL_WINDOWEVENT_RESTORED are
    80     sent out on app suspend and resume, respectively.  SDL_WINDOWEVENT_SHOWN and
    81     SDL_WINDOWEVENT_HIDDEN are also sent, but not necessarily on app suspend or
    82     resume, as WinRT treats these two concepts differently..
    83   * using Direct3D 11.x APIs outside of SDL.  Non-XAML / Direct3D-only apps can
    84     choose to render content directly via Direct3D, using SDL to manage the
    85     internal WinRT window, as well as input and audio.  (Use
    86     SDL_GetWindowWMInfo() to get the WinRT 'CoreWindow', and pass it into
    87     IDXGIFactory2::CreateSwapChainForCoreWindow() as appropriate.)
    88 
    89 * What partially works:
    90   * keyboard input.  Most of WinRT's documented virtual keys are supported, as
    91     well as many keys with documented hardware scancodes.
    92   * OpenGL.  Experimental support for OpenGL ES 2 is available via the ANGLE
    93     project, using either MS Open Technologies' repository, at 
    94     https://github.com/msopentech/angle (both the "winrt" and "future-dev"
    95     branches are supported), or the official ANGLE repository, at
    96     https://chromium.googlesource.com/angle/angle
    97   * SDLmain.  WinRT uses a different signature for each app's main() function.
    98     SDL-based apps that use this port must compile in SDL_winrt_main_NonXAML.cpp
    99     (in `SDL\src\main\winrt\`) directly in order for their C-style main()
   100     functions to be called.
   101   * XAML interoperability.  This feature is currently experimental (there are
   102     **many** known bugs in this, at present!), preliminary, and only for
   103     Windows 8.x/RT at the moment.  Windows Phone + XAML support is still
   104     pending.
   105 
   106 * What doesn't work:
   107   * compilation with anything other than Visual C++ 2012 or 2013
   108   * programmatically-created custom cursors.  These don't appear to be supported
   109     by WinRT.  Different OS-provided cursors can, however, be created via
   110     SDL_CreateSystemCursor() (unsupported on Windows Phone)
   111   * SDL_WarpMouseInWindow() or SDL_WarpMouseGlobal().  This are not currently
   112     supported by WinRT itself.
   113   * joysticks and game controllers that aren't supported by Microsoft's XInput
   114     API.
   115   * probably anything else that's not listed as supported
   116 
   117 
   118 
   119 
   120 Setup, High-Level Steps
   121 -----------------------
   122 
   123 The steps for setting up a project for an SDL/WinRT app looks like the
   124 following, at a high-level:
   125 
   126 1. create a new Visual C++ project using Microsoft's template for a,
   127    "Direct3D App".
   128 2. remove most of the files from the project.
   129 3. make your app's project directly reference SDL/WinRT's own Visual C++
   130    project file, via use of Visual C++'s "References" dialog.  This will setup
   131    the linker, and will copy SDL's .dll files to your app's final output.
   132 4. adjust your app's build settings, at minimum, telling it where to find SDL's
   133    header files.
   134 5. add a file that contains a WinRT-appropriate main function.
   135 6. add SDL-specific app code.
   136 7. build and run your app.
   137 
   138 
   139 Setup, Detailed Steps
   140 ---------------------
   141 
   142 ### 1. Create a new project ###
   143 
   144 Create a new project using one of Visual C++'s templates for a plain, non-XAML,
   145 "Direct3D App" (XAML support for SDL/WinRT is not yet ready for use).  If you
   146 don't see one of these templates, in Visual C++'s 'New Project' dialog, try
   147 using the textbox titled, 'Search Installed Templates' to look for one.
   148 
   149 
   150 ### 2. Remove unneeded files from the project ###
   151 
   152 In the new project, delete any file that has one of the following extensions:
   153 
   154 - .cpp
   155 - .h
   156 - .hlsl
   157 
   158 When you are done, you should be left with a few files, each of which will be a
   159 necessary part of your app's project.  These files will consist of:
   160 
   161 - an .appxmanifest file, which contains metadata on your WinRT app.  This is
   162   similar to an Info.plist file on iOS, or an AndroidManifest.xml on Android.
   163 - a few .png files, one of which is a splash screen (displayed when your app
   164   launches), others are app icons.
   165 - a .pfx file, used for code signing purposes.
   166 
   167 
   168 ### 3. Add references to SDL's project files ###
   169 
   170 SDL/WinRT can be built in multiple variations, spanning across three different
   171 CPU architectures (x86, x64, and ARM) and two different configurations
   172 (Debug and Release).  WinRT and Visual C++ do not currently provide a means
   173 for combining multiple variations of one library into a single file.
   174 Furthermore, it does not provide an easy means for copying pre-built .dll files
   175 into your app's final output (via Post-Build steps, for example).  It does,
   176 however, provide a system whereby an app can reference the MSVC projects of
   177 libraries such that, when the app is built:
   178 
   179 1. each library gets built for the appropriate CPU architecture(s) and WinRT
   180    platform(s).
   181 2. each library's output, such as .dll files, get copied to the app's build 
   182    output.
   183 
   184 To set this up for SDL/WinRT, you'll need to run through the following steps:
   185 
   186 1. open up the Solution Explorer inside Visual C++ (under the "View" menu, then
   187    "Solution Explorer")
   188 2. right click on your app's solution.
   189 3. navigate to "Add", then to "Existing Project..."
   190 4. find SDL/WinRT's Visual C++ project file and open it.  Different project
   191    files exist for different WinRT platforms.  All of them are in SDL's
   192    source distribution, in the following directories:
   193     * `VisualC-WinRT/WinPhone80_VS2012/` - for Windows Phone 8.0 apps
   194     * `VisualC-WinRT/WinPhone81_VS2013/` - for Windows Phone 8.1 apps
   195     * `VisualC-WinRT/WinRT80_VS2012/` - for Windows 8.0 apps
   196     * `VisualC-WinRT/WinRT81_VS2013/` - for Windows 8.1 apps
   197 5. once the project has been added, right-click on your app's project and
   198    select, "References..."
   199 6. click on the button titled, "Add New Reference..."
   200 7. check the box next to SDL
   201 8. click OK to close the dialog
   202 9. SDL will now show up in the list of references.  Click OK to close that
   203    dialog.
   204 
   205 Your project is now linked to SDL's project, insofar that when the app is
   206 built, SDL will be built as well, with its build output getting included with
   207 your app.
   208 
   209 
   210 ### 4. Adjust Your App's Build Settings ###
   211 
   212 Some build settings need to be changed in your app's project.  This guide will
   213 outline the following:
   214 
   215 - making sure that the compiler knows where to find SDL's header files
   216 - **Optional for C++, but NECESSARY for compiling C code:** telling the
   217   compiler not to use Microsoft's C++ extensions for WinRT development.
   218 - **Optional:** telling the compiler not generate errors due to missing
   219   precompiled header files.
   220 
   221 To change these settings:
   222 
   223 1. right-click on the project
   224 2. choose "Properties"
   225 3. in the drop-down box next to "Configuration", choose, "All Configurations"
   226 4. in the drop-down box next to "Platform", choose, "All Platforms"
   227 5. in the left-hand list, expand the "C/C++" section
   228 6. select "General"
   229 7. edit the "Additional Include Directories" setting, and add a path to SDL's
   230    "include" directory
   231 8. **Optional: to enable compilation of C code:** change the setting for
   232    "Consume Windows Runtime Extension" from "Yes (/ZW)" to "No".  If you're 
   233    working with a completely C++ based project, this step can usually be 
   234    omitted.
   235 9. **Optional: to disable precompiled headers (which can produce 
   236    'stdafx.h'-related build errors, if setup incorrectly:** in the left-hand 
   237    list, select "Precompiled Headers", then change the setting for "Precompiled 
   238    Header" from "Use (/Yu)" to "Not Using Precompiled Headers".
   239 10. close the dialog, saving settings, by clicking the "OK" button
   240 
   241 
   242 ### 5. Add a WinRT-appropriate main function to the app. ###
   243 
   244 C/C++-based WinRT apps do contain a `main` function that the OS will invoke when 
   245 the app starts launching. The parameters of WinRT main functions are different 
   246 than those found on other platforms, Win32 included.  SDL/WinRT provides a 
   247 platform-appropriate main function that will perform these actions, setup key 
   248 portions of the app, then invoke a classic, C/C++-style main function (that take 
   249 in "argc" and "argv" parameters).  The code for this file is contained inside 
   250 SDL's source distribution, under `src/main/winrt/SDL_winrt_main_NonXAML.cpp`.  
   251 You'll need to add this file, or a copy of it, to your app's project, and make 
   252 sure it gets compiled using a Microsoft-specific set of C++ extensions called 
   253 C++/CX.
   254 
   255 **NOTE: C++/CX compilation is currently required in at least one file of your 
   256 app's project.  This is to make sure that Visual C++'s linker builds a 'Windows 
   257 Metadata' file (.winmd) for your app.  Not doing so can lead to build errors.**
   258 
   259 To include `SDL_winrt_main_NonXAML.cpp`:
   260 
   261 1. right-click on your project (again, in Visual C++'s Solution Explorer), 
   262    navigate to "Add", then choose "Existing Item...".
   263 2. open `SDL_winrt_main_NonXAML.cpp`, which is found inside SDL's source 
   264    distribution, under `src/main/winrt/`.  Make sure that the open-file dialog 
   265    closes, either by double-clicking on the file, or single-clicking on it and 
   266    then clicking Add.
   267 3. right-click on the file (as listed in your project), then click on 
   268    "Properties...".
   269 4. in the drop-down box next to "Configuration", choose, "All Configurations"
   270 5. in the drop-down box next to "Platform", choose, "All Platforms"
   271 6. in the left-hand list, click on "C/C++"
   272 7. change the setting for "Consume Windows Runtime Extension" to "Yes (/ZW)".
   273 8. click the OK button.  This will close the dialog.
   274 
   275 
   276 ### 6. Add app code and assets ###
   277 
   278 At this point, you can add in SDL-specific source code.  Be sure to include a 
   279 C-style main function (ie: `int main(int argc, char *argv[])`).  From there you 
   280 should be able to create a single `SDL_Window` (WinRT apps can only have one 
   281 window, at present), as well as an `SDL_Renderer`.  Direct3D will be used to 
   282 draw content.  Events are received via SDL's usual event functions 
   283 (`SDL_PollEvent`, etc.)  If you have a set of existing source files and assets, 
   284 you can start adding them to the project now.  If not, or if you would like to 
   285 make sure that you're setup correctly, some short and simple sample code is 
   286 provided below.
   287 
   288 
   289 #### 6.A. ... when creating a new app ####
   290 
   291 If you are creating a new app (rather than porting an existing SDL-based app), 
   292 or if you would just like a simple app to test SDL/WinRT with before trying to 
   293 get existing code working, some working SDL/WinRT code is provided below.  To 
   294 set this up:
   295 
   296 1. right click on your app's project
   297 2. select Add, then New Item.  An "Add New Item" dialog will show up.
   298 3. from the left-hand list, choose "Visual C++"
   299 4. from the middle/main list, choose "C++ File (.cpp)"
   300 5. near the bottom of the dialog, next to "Name:", type in a name for your 
   301 source file, such as, "main.cpp".
   302 6. click on the Add button.  This will close the dialog, add the new file to 
   303 your project, and open the file in Visual C++'s text editor.
   304 7. Copy and paste the following code into the new file, then save it.
   305 
   306 
   307     #include <SDL.h>
   308     
   309     int main(int argc, char **argv)
   310     {
   311         SDL_DisplayMode mode;
   312         SDL_Window * window = NULL;
   313         SDL_Renderer * renderer = NULL;
   314         SDL_Event evt;
   315     
   316         if (SDL_Init(SDL_INIT_VIDEO) != 0) {
   317             return 1;
   318         }
   319     
   320         if (SDL_GetCurrentDisplayMode(0, &mode) != 0) {
   321             return 1;
   322         }
   323     
   324         if (SDL_CreateWindowAndRenderer(mode.w, mode.h, SDL_WINDOW_FULLSCREEN, &window, &renderer) != 0) {
   325             return 1;
   326         }
   327     
   328         while (1) {
   329             while (SDL_PollEvent(&evt)) {
   330             }
   331     
   332             SDL_SetRenderDrawColor(renderer, 0, 255, 0, 255);
   333             SDL_RenderClear(renderer);
   334             SDL_RenderPresent(renderer);
   335         }
   336     }
   337 
   338 
   339 #### 6.B. Adding code and assets ####
   340 
   341 If you have existing code and assets that you'd like to add, you should be able 
   342 to add them now.  The process for adding a set of files is as such.
   343 
   344 1. right click on the app's project
   345 2. select Add, then click on "New Item..."
   346 3. open any source, header, or asset files as appropriate.  Support for C and 
   347 C++ is available.
   348 
   349 Do note that WinRT only supports a subset of the APIs that are available to 
   350 Win32-based apps.  Many portions of the Win32 API and the C runtime are not 
   351 available.
   352 
   353 A list of unsupported C APIs can be found at 
   354 <http://msdn.microsoft.com/en-us/library/windows/apps/jj606124.aspx>
   355 
   356 General information on using the C runtime in WinRT can be found at 
   357 <http://msdn.microsoft.com/en-us/LIBRARY/hh972425(v=vs.110).aspx>
   358 
   359 A list of supported Win32 APIs for Windows 8/RT apps can be found at 
   360 <http://msdn.microsoft.com/en-us/library/windows/apps/br205757.aspx>.  To note, 
   361 the list of supported Win32 APIs for Windows Phone 8 development is different.  
   362 That list can be found at 
   363 <http://msdn.microsoft.com/en-us/library/windowsphone/develop/jj662956(v=vs.105).aspx>
   364 
   365 
   366 ### 7. Build and run your app ###
   367 
   368 Your app project should now be setup, and you should be ready to build your app.  
   369 To run it on the local machine, open the Debug menu and choose "Start 
   370 Debugging".  This will build your app, then run your app full-screen.  To switch 
   371 out of your app, press the Windows key.  Alternatively, you can choose to run 
   372 your app in a window.  To do this, before building and running your app, find 
   373 the drop-down menu in Visual C++'s toolbar that says, "Local Machine".  Expand 
   374 this by clicking on the arrow on the right side of the list, then click on 
   375 Simulator.  Once you do that, any time you build and run the app, the app will 
   376 launch in window, rather than full-screen.
   377 
   378 
   379 #### 7.A. Running apps on ARM-based devices ####
   380 
   381 To build and run the app on ARM-based, "Windows RT" devices, you'll need to:
   382 
   383 - install Microsoft's "Remote Debugger" on the device.  Visual C++ installs and 
   384   debugs ARM-based apps via IP networks.
   385 - change a few options on the development machine, both to make sure it builds 
   386   for ARM (rather than x86 or x64), and to make sure it knows how to find the 
   387   Windows RT device (on the network).
   388 
   389 Microsoft's Remote Debugger can be found at 
   390 <http://msdn.microsoft.com/en-us/library/vstudio/bt727f1t.aspx>.  Please note 
   391 that separate versions of this debugger exist for different versions of Visual 
   392 C++, one for debugging with MSVC 2012, another for debugging with MSVC 2013.
   393 
   394 To setup Visual C++ to launch your app on an ARM device:
   395 
   396 1. make sure the Remote Debugger is running on your ARM device, and that it's on 
   397    the same IP network as your development machine.
   398 2. from Visual C++'s toolbar, find a drop-down menu that says, "Win32".  Click 
   399    it, then change the value to "ARM".
   400 3. make sure Visual C++ knows the hostname or IP address of the ARM device.  To 
   401    do this:
   402     1. open the app project's properties
   403     2. select "Debugging"
   404     3. next to "Machine Name", enter the hostname or IP address of the ARM 
   405        device
   406     4. if, and only if, you've turned off authentication in the Remote Debugger,
   407        then change the setting for "Require Authentication" to No
   408     5. click "OK"
   409 4. build and run the app (from Visual C++).  The first time you do this, a 
   410    prompt will show up on the ARM device, asking for a Microsoft Account.  You 
   411    do, unfortunately, need to log in here, and will need to follow the 
   412    subsequent registration steps in order to launch the app.  After you do so, 
   413    if the app didn't already launch, try relaunching it again from within Visual 
   414    C++.
   415 
   416 
   417 Troubleshooting
   418 ---------------
   419 
   420 #### Build fails with message, "error LNK2038: mismatch detected for 'vccorlib_lib_should_be_specified_before_msvcrt_lib_to_linker'"
   421 
   422 Try adding the following to your linker flags.  In MSVC, this can be done by
   423 right-clicking on the app project, navigating to Configuration Properties ->
   424 Linker -> Command Line, then adding them to the Additional Options
   425 section.
   426 
   427 * For Release builds / MSVC-Configurations, add:
   428 
   429     /nodefaultlib:vccorlib /nodefaultlib:msvcrt vccorlib.lib msvcrt.lib
   430 
   431 * For Debug builds / MSVC-Configurations, add:
   432 
   433     /nodefaultlib:vccorlibd /nodefaultlib:msvcrtd vccorlibd.lib msvcrtd.lib
   434