SDL  2.0
SDL_blendmode.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 
22 /**
23  * \file SDL_blendmode.h
24  *
25  * Header file declaring the SDL_BlendMode enumeration
26  */
27 
28 #ifndef SDL_blendmode_h_
29 #define SDL_blendmode_h_
30 
31 #include "begin_code.h"
32 /* Set up for C function definitions, even when using C++ */
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 /**
38  * \brief The blend mode used in SDL_RenderCopy() and drawing operations.
39  */
40 typedef enum
41 {
42  SDL_BLENDMODE_NONE = 0x00000000, /**< no blending
43  dstRGBA = srcRGBA */
44  SDL_BLENDMODE_BLEND = 0x00000001, /**< alpha blending
45  dstRGB = (srcRGB * srcA) + (dstRGB * (1-srcA))
46  dstA = srcA + (dstA * (1-srcA)) */
47  SDL_BLENDMODE_ADD = 0x00000002, /**< additive blending
48  dstRGB = (srcRGB * srcA) + dstRGB
49  dstA = dstA */
50  SDL_BLENDMODE_MOD = 0x00000004, /**< color modulate
51  dstRGB = srcRGB * dstRGB
52  dstA = dstA */
53  SDL_BLENDMODE_INVALID = 0x7FFFFFFF
54 
55  /* Additional custom blend modes can be returned by SDL_ComposeCustomBlendMode() */
56 
57 } SDL_BlendMode;
58 
59 /**
60  * \brief The blend operation used when combining source and destination pixel components
61  */
62 typedef enum
63 {
64  SDL_BLENDOPERATION_ADD = 0x1, /**< dst + src: supported by all renderers */
65  SDL_BLENDOPERATION_SUBTRACT = 0x2, /**< dst - src : supported by D3D9, D3D11, OpenGL, OpenGLES */
66  SDL_BLENDOPERATION_REV_SUBTRACT = 0x3, /**< src - dst : supported by D3D9, D3D11, OpenGL, OpenGLES */
67  SDL_BLENDOPERATION_MINIMUM = 0x4, /**< min(dst, src) : supported by D3D11 */
68  SDL_BLENDOPERATION_MAXIMUM = 0x5 /**< max(dst, src) : supported by D3D11 */
69 
70 } SDL_BlendOperation;
71 
72 /**
73  * \brief The normalized factor used to multiply pixel components
74  */
75 typedef enum
76 {
77  SDL_BLENDFACTOR_ZERO = 0x1, /**< 0, 0, 0, 0 */
78  SDL_BLENDFACTOR_ONE = 0x2, /**< 1, 1, 1, 1 */
79  SDL_BLENDFACTOR_SRC_COLOR = 0x3, /**< srcR, srcG, srcB, srcA */
80  SDL_BLENDFACTOR_ONE_MINUS_SRC_COLOR = 0x4, /**< 1-srcR, 1-srcG, 1-srcB, 1-srcA */
81  SDL_BLENDFACTOR_SRC_ALPHA = 0x5, /**< srcA, srcA, srcA, srcA */
82  SDL_BLENDFACTOR_ONE_MINUS_SRC_ALPHA = 0x6, /**< 1-srcA, 1-srcA, 1-srcA, 1-srcA */
83  SDL_BLENDFACTOR_DST_COLOR = 0x7, /**< dstR, dstG, dstB, dstA */
84  SDL_BLENDFACTOR_ONE_MINUS_DST_COLOR = 0x8, /**< 1-dstR, 1-dstG, 1-dstB, 1-dstA */
85  SDL_BLENDFACTOR_DST_ALPHA = 0x9, /**< dstA, dstA, dstA, dstA */
86  SDL_BLENDFACTOR_ONE_MINUS_DST_ALPHA = 0xA /**< 1-dstA, 1-dstA, 1-dstA, 1-dstA */
87 
88 } SDL_BlendFactor;
89 
90 /**
91  * \brief Create a custom blend mode, which may or may not be supported by a given renderer
92  *
93  * \param srcColorFactor
94  * \param dstColorFactor
95  * \param colorOperation
96  * \param srcAlphaFactor
97  * \param dstAlphaFactor
98  * \param alphaOperation
99  *
100  * The result of the blend mode operation will be:
101  * dstRGB = dstRGB * dstColorFactor colorOperation srcRGB * srcColorFactor
102  * and
103  * dstA = dstA * dstAlphaFactor alphaOperation srcA * srcAlphaFactor
104  */
105 extern DECLSPEC SDL_BlendMode SDLCALL SDL_ComposeCustomBlendMode(SDL_BlendFactor srcColorFactor,
106  SDL_BlendFactor dstColorFactor,
107  SDL_BlendOperation colorOperation,
108  SDL_BlendFactor srcAlphaFactor,
109  SDL_BlendFactor dstAlphaFactor,
110  SDL_BlendOperation alphaOperation);
111 
112 /* Ends C function definitions when using C++ */
113 #ifdef __cplusplus
114 }
115 #endif
116 #include "close_code.h"
117 
118 #endif /* SDL_blendmode_h_ */
119 
120 /* vi: set ts=4 sw=4 expandtab: */