include/SDL_test_images.h
author David Ludwig <dludwig@pobox.com>
Sat, 29 Nov 2014 10:09:30 -0500
changeset 9247 eddb899239fe
parent 8149 681eb46b8ac4
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).
aschiffler@6762
     1
/*
aschiffler@6762
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
aschiffler@6762
     4
aschiffler@6762
     5
  This software is provided 'as-is', without any express or implied
aschiffler@6762
     6
  warranty.  In no event will the authors be held liable for any damages
aschiffler@6762
     7
  arising from the use of this software.
aschiffler@6762
     8
aschiffler@6762
     9
  Permission is granted to anyone to use this software for any purpose,
aschiffler@6762
    10
  including commercial applications, and to alter it and redistribute it
aschiffler@6762
    11
  freely, subject to the following restrictions:
aschiffler@6762
    12
aschiffler@6762
    13
  1. The origin of this software must not be misrepresented; you must not
aschiffler@6762
    14
     claim that you wrote the original software. If you use this software
aschiffler@6762
    15
     in a product, an acknowledgment in the product documentation would be
aschiffler@6762
    16
     appreciated but is not required.
aschiffler@6762
    17
  2. Altered source versions must be plainly marked as such, and must not be
aschiffler@6762
    18
     misrepresented as being the original software.
aschiffler@6762
    19
  3. This notice may not be removed or altered from any source distribution.
aschiffler@6762
    20
*/
aschiffler@6762
    21
aschiffler@6762
    22
/**
aschiffler@6762
    23
 *  \file SDL_test_images.h
slouken@7191
    24
 *
aschiffler@6762
    25
 *  Include file for SDL test framework.
aschiffler@6762
    26
 *
aschiffler@6762
    27
 *  This code is a part of the SDL2_test library, not the main SDL library.
aschiffler@6762
    28
 */
aschiffler@6762
    29
slouken@7191
    30
/*
aschiffler@6762
    31
aschiffler@6762
    32
 Defines some images for tests.
slouken@7191
    33
aschiffler@6762
    34
*/
aschiffler@6762
    35
aschiffler@6762
    36
#ifndef _SDL_test_images_h
aschiffler@6762
    37
#define _SDL_test_images_h
aschiffler@6762
    38
aschiffler@6763
    39
#include "SDL.h"
aschiffler@6763
    40
aschiffler@6762
    41
#include "begin_code.h"
aschiffler@6762
    42
/* Set up for C function definitions, even when using C++ */
aschiffler@6762
    43
#ifdef __cplusplus
aschiffler@6762
    44
extern "C" {
aschiffler@6762
    45
#endif
aschiffler@6762
    46
aschiffler@6762
    47
/**
aschiffler@6762
    48
 *Type for test images.
aschiffler@6762
    49
 */
aschiffler@6762
    50
typedef struct SDLTest_SurfaceImage_s {
aschiffler@6762
    51
  int width;
aschiffler@6762
    52
  int height;
slouken@7191
    53
  unsigned int bytes_per_pixel; /* 3:RGB, 4:RGBA */
icculus@7053
    54
  const char *pixel_data;
aschiffler@6762
    55
} SDLTest_SurfaceImage_t;
aschiffler@6762
    56
aschiffler@6762
    57
/* Test images */
aschiffler@6763
    58
SDL_Surface *SDLTest_ImageBlit();
aschiffler@6763
    59
SDL_Surface *SDLTest_ImageBlitColor();
aschiffler@6763
    60
SDL_Surface *SDLTest_ImageBlitAlpha();
aschiffler@6763
    61
SDL_Surface *SDLTest_ImageBlitBlendAdd();
aschiffler@6763
    62
SDL_Surface *SDLTest_ImageBlitBlend();
aschiffler@6763
    63
SDL_Surface *SDLTest_ImageBlitBlendMod();
aschiffler@6763
    64
SDL_Surface *SDLTest_ImageBlitBlendNone();
aschiffler@6763
    65
SDL_Surface *SDLTest_ImageBlitBlendAll();
aschiffler@6763
    66
SDL_Surface *SDLTest_ImageFace();
aschiffler@6763
    67
SDL_Surface *SDLTest_ImagePrimitives();
aschiffler@6763
    68
SDL_Surface *SDLTest_ImagePrimitivesBlend();
aschiffler@6762
    69
aschiffler@6762
    70
/* Ends C function definitions when using C++ */
aschiffler@6762
    71
#ifdef __cplusplus
aschiffler@6762
    72
}
aschiffler@6762
    73
#endif
aschiffler@6762
    74
#include "close_code.h"
aschiffler@6762
    75
aschiffler@6762
    76
#endif /* _SDL_test_images_h */
aschiffler@6762
    77
aschiffler@6762
    78
/* vi: set ts=4 sw=4 expandtab: */