summaryrefslogtreecommitdiff
path: root/manuals/guile-sdl2/Blend-Modes.html
blob: 55363a4974b3e45d6949ad3a4ab700ee28078420 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2016, 2017, 2018, 2019  David Thompson davet@gnu.org

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".

A copy of the license is also available from the Free Software
Foundation Web site at http://www.gnu.org/licenses/fdl.html.


* Guile-SDL2: (guile-sdl2).     SDL2 bindings for Guile.

The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
 -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Blend Modes (Guile-SDL2)</title>

<meta name="description" content="Blend Modes (Guile-SDL2)">
<meta name="keywords" content="Blend Modes (Guile-SDL2)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="API-Reference.html" rel="up" title="API Reference">
<link href="Images.html" rel="next" title="Images">
<link href="Rendering.html" rel="prev" title="Rendering">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
@media (min-width: 1140px) {
    body {
        margin-left: 14rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (min-width: 800px) and (max-width: 1140px) {
    body {
        margin-left: 6rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (max-width: 800px) {
    body {
        margin: 1rem;
    }
}

-->
</style>
<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css">


</head>

<body lang="en">
<span id="Blend-Modes"></span><div class="header">
<p>
Next: <a href="Images.html" accesskey="n" rel="next">Images</a>, Previous: <a href="Rendering.html" accesskey="p" rel="prev">Rendering</a>, Up: <a href="API-Reference.html" accesskey="u" rel="up">API Reference</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Blend-Modes-1"></span><h3 class="section">3.8 Blend Modes</h3>

<div class="example">
<pre class="example">(use-modules (sdl2 blend-mode))
</pre></div>

<p>SDL2 provides several of the most commonly used blend modes:
</p>
<dl>
<dt id="index-none">Variable: <strong>none</strong></dt>
<dd><p>No blending.
</p></dd></dl>

<dl>
<dt id="index-blend">Variable: <strong>blend</strong></dt>
<dd><p>Alpha blending.
</p></dd></dl>

<dl>
<dt id="index-add">Variable: <strong>add</strong></dt>
<dd><p>Additive blending.
</p></dd></dl>

<dl>
<dt id="index-mul">Variable: <strong>mul</strong></dt>
<dd><p>Multiplicative blending.
</p></dd></dl>

<dl>
<dt id="index-mod">Variable: <strong>mod</strong></dt>
<dd><p>Color modulation.
</p></dd></dl>

<p>Custom blend modes can be created using the <code>make-blend-mode</code>
procedure.
</p>
<dl>
<dt id="index-make_002dblend_002dmode">Procedure: <strong>make-blend-mode</strong> <em>src-color-factor dst-color-factor color-operation src-alpha-factor dst-alpha-factor alpha-operation</em></dt>
<dd><p>Return a new custom blend mode for renderers.
</p>
<p><var>src-color-factor</var> applies to the red, green, and blue components
of the source pixels.
</p>
<p><var>dst-color-factor</var> applies to the red, green, and blue components of the
destination pixels.
</p>
<p><var>color-operation</var> specifies how to combine the red, green, and blue
components of the source and destination pixels.
</p>
<p><var>src-alpha-factor</var> applies to the alpha component of the source pixels.
</p>
<p><var>dst-alpha-factor</var> applies to the alpha component of the destination
pixels.
</p>
<p><var>alpha-operation</var> specifies how to combine the alpha component of the
source and destination pixels.
</p>
<p>Possible values for factors are <code>zero</code>, <code>one</code>,
<code>src-color</code>, <code>one-minus-src-color</code>, <code>src-alpha</code>,
<code>one-minus-src-alpha</code>, <code>dst-color</code>,
<code>one-minus-dst-color</code>, <code>dst-alpha</code>, and <code>one-minus-dst
alpha</code>.
</p>
<p>Possible values for operations are <code>add</code>, <code>subtract</code>,
<code>rev-subtract</code>, <code>minimum</code>, and <code>maximum</code>.
</p></dd></dl>

<dl>
<dt id="index-blend_002dmode_003f">Procedure: <strong>blend-mode?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a blend mode object.
</p></dd></dl>

<dl>
<dt id="index-blend_002dmode_002dsrc_002dcolor_002dfactor">Procedure: <strong>blend-mode-src-color-factor</strong> <em>blend-mode</em></dt>
<dd><p>Return the source red, green, and blue channel blend factor for
<var>blend-mode</var>.
</p></dd></dl>

<dl>
<dt id="index-blend_002dmode_002ddst_002dcolor_002dfactor">Procedure: <strong>blend-mode-dst-color-factor</strong> <em>blend-mode</em></dt>
<dd><p>Return the destination red, green, and blue channel blend factor for
<var>blend-mode</var>.
</p></dd></dl>

<dl>
<dt id="index-blend_002dmode_002dcolor_002doperation">Procedure: <strong>blend-mode-color-operation</strong> <em>blend-mode</em></dt>
<dd><p>Return the red, green, and blue channel blend operation for
<var>blend-mode</var>.
</p></dd></dl>

<dl>
<dt id="index-blend_002dmode_002dsrc_002dalpha_002dfactor">Procedure: <strong>blend-mode-src-alpha-factor</strong> <em>blend-mode</em></dt>
<dd><p>Return the source alpha channel blend factor for <var>blend-mode</var>.
</p></dd></dl>

<dl>
<dt id="index-blend_002dmode_002ddst_002dalpha_002dfactor">Procedure: <strong>blend-mode-dst-alpha-factor</strong> <em>blend-mode</em></dt>
<dd><p>Return the destination alpha channel blend factor for
<var>blend-mode</var>.
</p></dd></dl>

<dl>
<dt id="index-blend_002dmode_002dalpha_002doperation">Procedure: <strong>blend-mode-alpha-operation</strong> <em>blend-mode</em></dt>
<dd><p>Return the alpha channel blend operation for <var>blend-mode</var>.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Images.html" accesskey="n" rel="next">Images</a>, Previous: <a href="Rendering.html" accesskey="p" rel="prev">Rendering</a>, Up: <a href="API-Reference.html" accesskey="u" rel="up">API Reference</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>