include/SDL_blendmode.h
author David Ludwig <dludwig@pobox.com>
Sat, 29 Nov 2014 10:09:30 -0500
changeset 9247 eddb899239fe
parent 9239 4a4293b8a37f
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@4929
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
slouken@4929
     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@4929
     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@4929
    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@4929
    20
*/
slouken@4929
    21
slouken@4929
    22
/**
slouken@4929
    23
 *  \file SDL_blendmode.h
slouken@7191
    24
 *
slouken@4929
    25
 *  Header file declaring the SDL_BlendMode enumeration
slouken@4929
    26
 */
slouken@4929
    27
slouken@4929
    28
#ifndef _SDL_blendmode_h
slouken@4929
    29
#define _SDL_blendmode_h
slouken@4929
    30
slouken@4929
    31
#include "begin_code.h"
slouken@4929
    32
/* Set up for C function definitions, even when using C++ */
slouken@4929
    33
#ifdef __cplusplus
slouken@4929
    34
extern "C" {
slouken@4929
    35
#endif
slouken@4929
    36
slouken@4929
    37
/**
slouken@4929
    38
 *  \brief The blend mode used in SDL_RenderCopy() and drawing operations.
slouken@4929
    39
 */
slouken@4929
    40
typedef enum
slouken@4929
    41
{
slouken@7502
    42
    SDL_BLENDMODE_NONE = 0x00000000,     /**< no blending
slouken@7502
    43
                                              dstRGBA = srcRGBA */
slouken@7502
    44
    SDL_BLENDMODE_BLEND = 0x00000001,    /**< alpha blending
slouken@7502
    45
                                              dstRGB = (srcRGB * srcA) + (dstRGB * (1-srcA))
slouken@7502
    46
                                              dstA = srcA + (dstA * (1-srcA)) */
slouken@7502
    47
    SDL_BLENDMODE_ADD = 0x00000002,      /**< additive blending
slouken@7502
    48
                                              dstRGB = (srcRGB * srcA) + dstRGB
slouken@7502
    49
                                              dstA = dstA */
slouken@7502
    50
    SDL_BLENDMODE_MOD = 0x00000004       /**< color modulate
slouken@7502
    51
                                              dstRGB = srcRGB * dstRGB
slouken@7502
    52
                                              dstA = dstA */
slouken@4929
    53
} SDL_BlendMode;
slouken@4929
    54
slouken@4929
    55
/* Ends C function definitions when using C++ */
slouken@4929
    56
#ifdef __cplusplus
slouken@4929
    57
}
slouken@4929
    58
#endif
slouken@4929
    59
#include "close_code.h"
slouken@4929
    60
philipp@9239
    61
#endif /* _SDL_blendmode_h */
slouken@4929
    62
slouken@4929
    63
/* vi: set ts=4 sw=4 expandtab: */