include/SDL_opengles2.h
author David Ludwig <dludwig@pobox.com>
Sat, 29 Nov 2014 10:09:30 -0500
changeset 9247 eddb899239fe
parent 9055 868b523403e0
child 9619 b94b6d0bff0f
permissions -rw-r--r--
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).
slouken@5204
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
slouken@5204
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@5204
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@5204
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@5204
    20
*/
slouken@5204
    21
slouken@5204
    22
/**
philipp@9055
    23
 *  \file SDL_opengles2.h
slouken@7191
    24
 *
slouken@5204
    25
 *  This is a simple file to encapsulate the OpenGL ES 2.0 API headers.
slouken@5204
    26
 */
gabomdq@8021
    27
#ifndef _MSC_VER
jorgen@8806
    28
slouken@5204
    29
#ifdef __IPHONEOS__
slouken@5204
    30
#include <OpenGLES/ES2/gl.h>
slouken@5204
    31
#include <OpenGLES/ES2/glext.h>
slouken@5204
    32
#else
gabomdq@8767
    33
#include <GLES2/gl2platform.h>
slouken@5204
    34
#include <GLES2/gl2.h>
slouken@5204
    35
#include <GLES2/gl2ext.h>
slouken@5204
    36
#endif
slouken@5204
    37
gabomdq@8021
    38
#else /* _MSC_VER */
gabomdq@8021
    39
gabomdq@8021
    40
/* OpenGL ES2 headers for Visual Studio */
jorgen@8806
    41
#include "SDL_opengles2_khrplatform.h"
jorgen@8806
    42
#include "SDL_opengles2_gl2platform.h"
jorgen@8806
    43
#include "SDL_opengles2_gl2.h"
jorgen@8806
    44
#include "SDL_opengles2_gl2ext.h"
gabomdq@8021
    45
gabomdq@8021
    46
#endif /* _MSC_VER */
gabomdq@8021
    47
slouken@5204
    48
#ifndef APIENTRY
gabomdq@8021
    49
#define APIENTRY GL_APIENTRY
slouken@8149
    50
#endif