README-winrt.txt
author Ryan C. Gordon <icculus@icculus.org>
Wed, 25 Jun 2014 17:24:06 -0400
changeset 8956 a99e30f2bf0a
parent 8698 0eed6a72e3c1
permissions -rw-r--r--
Patched to compile on Windows.
dludwig@8698
     1
================================================================================
dludwig@8698
     2
Simple DirectMedia Layer for WinRT
dludwig@8698
     3
================================================================================
dludwig@8698
     4
dludwig@8698
     5
SDL/WinRT layer allows SDL2-based applications to run on many of Microsoft's
dludwig@8698
     6
platforms that utilize the "Windows Runtime" (aka "WinRT") APIs.  WinRT apps
dludwig@8698
     7
are currently always full-screen apps, run in what Microsoft calls their
dludwig@8698
     8
"Modern" environment (aka. "Metro"), and are distributed via Microsoft-run
dludwig@8698
     9
online stores.  Some of the operating systems that support such apps include:
dludwig@8698
    10
dludwig@8698
    11
* Windows 8.x
dludwig@8698
    12
* Windows RT 8.x (aka. Windows 8.x for ARM processors)
dludwig@8698
    13
* Windows Phone 8.x
dludwig@8698
    14
dludwig@8698
    15
To note, WinRT applications that run on Windows 8.x and/or Windows RT are often
dludwig@8698
    16
called "Windows Store" apps.
dludwig@8698
    17
dludwig@8698
    18
dludwig@8698
    19
--------------------------------------------------------------------------------
dludwig@8698
    20
Requirements
dludwig@8698
    21
--------------------------------------------------------------------------------
dludwig@8698
    22
- Microsoft Visual C++ 2012 -- Free, "Express" editions may be used, so long
dludwig@8698
    23
  as they include support for either "Windows Store" or "Windows Phone" apps.
dludwig@8698
    24
  (NOTE: MSVC 2013 support is pending.  2012 projects may be converted to 2013
dludwig@8698
    25
  projects by MSVC, in the meantime.)
dludwig@8698
    26
- A valid Microsoft account -- This requirement is not imposed by SDL, but
dludwig@8698
    27
  rather by Microsoft's Visual C++ toolchain.
dludwig@8698
    28
dludwig@8698
    29
dludwig@8698
    30
--------------------------------------------------------------------------------
dludwig@8698
    31
TODO
dludwig@8698
    32
--------------------------------------------------------------------------------
dludwig@8698
    33
- Finish adding support for MSVC 2013, and "Universal" WinRT apps, which
dludwig@8698
    34
  support Windows 8.1, Windows Phone 8.1, and in the future, Xbox One and
dludwig@8698
    35
  Windows Desktop.
dludwig@8698
    36
- Finish adding support for the SDL satellite libraries (SDL_image, SDL_mixer,
dludwig@8698
    37
  SDL_ttf, etc.)
dludwig@8698
    38
- Create templates for both MSVC 2012 and MSVC 2013, and have the corresponding
dludwig@8698
    39
  VSIX packages either include pre-built copies of SDL, or reference binaries
dludwig@8698
    40
  available via MSVC's NuGet servers
dludwig@8698
    41
- Write setup instructions that use MSVC 201x templates
dludwig@8698
    42
- Write setup instructions that don't use MSVC 201x templates, and use
dludwig@8698
    43
  MSVC project-to-project references, rather than pre-built binaries
dludwig@8698
    44
- Write a list of caveats found in SDL/WinRT, such as APIs that don't work due
dludwig@8698
    45
  to platform restrictions, or things that need further work