docs/README-windows.md
author Ryan C. Gordon <icculus@icculus.org>
Mon, 29 Oct 2018 20:00:03 -0400
changeset 12369 68c87b40b434
parent 11381 2610f8f0a9c6
permissions -rw-r--r--
winmain: Don't use SDL_malloc (or SDL_stack_alloc, which might be malloc).

Otherwise, we are using the allocator before the app can set up its own hooks.

Now we use VirtualAlloc, and WideCharToMultiByte (because SDL_iconv uses
SDL_malloc, too!) to get ready to call into SDL_main.

This also makes console_wmain() call into the same routines as everything
else, so we don't have to deal with those allocations, too. Hopefully we
end up with the same results from GetCommandLine() as we do in wargv.

Fixes Bugzilla #4340.
icculus@11365
     1
Windows
icculus@11365
     2
================================================================================
icculus@11365
     3
icculus@11365
     4
================================================================================
icculus@11365
     5
OpenGL ES 2.x support
icculus@11365
     6
================================================================================
icculus@11365
     7
icculus@11365
     8
SDL has support for OpenGL ES 2.x under Windows via two alternative 
icculus@11365
     9
implementations. 
icculus@11365
    10
The most straightforward method consists in running your app in a system with 
icculus@11365
    11
a graphic card paired with a relatively recent (as of November of 2013) driver 
icculus@11365
    12
which supports the WGL_EXT_create_context_es2_profile extension. Vendors known 
icculus@11365
    13
to ship said extension on Windows currently include nVidia and Intel.
icculus@11365
    14
icculus@11365
    15
The other method involves using the ANGLE library (https://code.google.com/p/angleproject/)
icculus@11365
    16
If an OpenGL ES 2.x context is requested and no WGL_EXT_create_context_es2_profile
icculus@11365
    17
extension is found, SDL will try to load the libEGL.dll library provided by
icculus@11365
    18
ANGLE.
icculus@11365
    19
To obtain the ANGLE binaries, you can either compile from source from
icculus@11365
    20
https://chromium.googlesource.com/angle/angle or copy the relevant binaries from
icculus@11365
    21
a recent Chrome/Chromium install for Windows. The files you need are:
icculus@11365
    22
    
icculus@11365
    23
    * libEGL.dll
icculus@11365
    24
    * libGLESv2.dll
icculus@11365
    25
    * d3dcompiler_46.dll (supports Windows Vista or later, better shader compiler)
icculus@11365
    26
    or...
icculus@11365
    27
    * d3dcompiler_43.dll (supports Windows XP or later)
icculus@11365
    28
    
icculus@11365
    29
If you compile ANGLE from source, you can configure it so it does not need the
icculus@11365
    30
d3dcompiler_* DLL at all (for details on this, see their documentation). 
icculus@11365
    31
However, by default SDL will try to preload the d3dcompiler_46.dll to
icculus@11365
    32
comply with ANGLE's requirements. If you wish SDL to preload d3dcompiler_43.dll (to
icculus@11365
    33
support Windows XP) or to skip this step at all, you can use the 
icculus@11365
    34
SDL_HINT_VIDEO_WIN_D3DCOMPILER hint (see SDL_hints.h for more details).
icculus@11365
    35
icculus@11365
    36
Known Bugs:
icculus@11365
    37
    
icculus@11365
    38
    * SDL_GL_SetSwapInterval is currently a no op when using ANGLE. It appears
icculus@11365
    39
      that there's a bug in the library which prevents the window contents from
icculus@11365
    40
      refreshing if this is set to anything other than the default value.
icculus@11365
    41
     
icculus@11365
    42
Vulkan Surface Support
icculus@11365
    43
==============
icculus@11365
    44
slouken@11381
    45
Support for creating Vulkan surfaces is configured on by default. To disable it change the value of `SDL_VIDEO_VULKAN` to 0 in `SDL_config_windows.h`. You must install the [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) in order to use Vulkan graphics in your application.