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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2017-2021 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.
* Chickadee: (chickadee). Game programming toolkit 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>Textures (The Chickadee Game Toolkit)</title>
<meta name="description" content="Textures (The Chickadee Game Toolkit)">
<meta name="keywords" content="Textures (The Chickadee Game Toolkit)">
<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="Graphics.html" rel="up" title="Graphics">
<link href="Sprites.html" rel="next" title="Sprites">
<link href="Colors.html" rel="prev" title="Colors">
<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="Textures"></span><div class="header">
<p>
Next: <a href="Sprites.html" accesskey="n" rel="next">Sprites</a>, Previous: <a href="Colors.html" accesskey="p" rel="prev">Colors</a>, Up: <a href="Graphics.html" accesskey="u" rel="up">Graphics</a> [<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="Textures-1"></span><h4 class="subsection">5.3.2 Textures</h4>
<p>Textures are essentially images: a 2D grid of color values. However,
this is a great simplification. Textures can be used to store any
kind of data that can be encoded into color channels. The
<code>(chickadee graphics texture)</code> module provides an interface for
working with texture objects.
</p>
<dl>
<dt id="index-load_002dimage">Procedure: <strong>load-image</strong> <em>file [#:min-filter nearest] [#:mag-filter nearest] [#:wrap-s repeat] [#:wrap-t repeat] [#:transparent-color]</em></dt>
<dd>
<p>Load the image data from <var>file</var> and return a new texture object.
</p>
<p><var>min-filter</var> and <var>mag-filter</var> describe the method that should
be used for minification and magnification when rendering,
respectively. Possible values are <code>nearest</code> and <code>linear</code>.
</p>
<p><var>wrap-s</var> and <var>wrap-t</var> describe how to interpret texture
coordinates that are greater than <code>1.0</code>. Possible values are
<code>repeat</code>, <code>mirrored-repeat</code>, <code>clamp</code>,
<code>clamp-to-border</code>, and <code>clamp-to-edge</code>.
</p>
<p>For color-keyed images (images where a specific color should be made
transparent), specify the appropriate <var>transparent-color</var>.
</p>
</dd></dl>
<dl>
<dt id="index-texture_003f">Procedure: <strong>texture?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a texture.
</p></dd></dl>
<dl>
<dt id="index-texture_002dregion_003f">Procedure: <strong>texture-region?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a texture region.
</p></dd></dl>
<dl>
<dt id="index-texture_002dparent">Procedure: <strong>texture-parent</strong> <em>texture</em></dt>
<dd><p>If <var>texture</var> is a texture region, return the full texture that it
is based upon. Otherwise, return <code>#f</code>.
</p></dd></dl>
<dl>
<dt id="index-texture_002dmin_002dfilter">Procedure: <strong>texture-min-filter</strong> <em>texture</em></dt>
<dd><p>Return the minification filter for <var>texture</var>, either
<code>nearest</code> or <code>linear</code>.
</p></dd></dl>
<dl>
<dt id="index-texture_002dmag_002dfilter">Procedure: <strong>texture-mag-filter</strong> <em>texture</em></dt>
<dd><p>Return the magnification filter for <var>texture</var>, either
<code>nearest</code> or <code>linear</code>.
</p></dd></dl>
<dl>
<dt id="index-texture_002dwrap_002ds">Procedure: <strong>texture-wrap-s</strong> <em>texture</em></dt>
<dd><p>Return the method used for wrapping texture coordinates along the X
axis for <var>texture</var>.
</p>
<p>Possible wrapping methods:
</p><ul>
<li> <code>repeat</code>
</li><li> <code>clamp</code>
</li><li> <code>clamp-to-border</code>
</li><li> <code>clamp-to-edge</code>
</li></ul>
</dd></dl>
<dl>
<dt id="index-texture_002dwrap_002dt">Procedure: <strong>texture-wrap-t</strong> <em>texture</em></dt>
<dd><p>Return the method used for wrapping texture coordinates along the Y
axis for <var>texture</var>.
</p></dd></dl>
<dl>
<dt id="index-texture_002dwidth">Procedure: <strong>texture-width</strong> <em>texture</em></dt>
<dd><p>Return the width of <var>texture</var> in pixels.
</p></dd></dl>
<dl>
<dt id="index-texture_002dheight">Procedure: <strong>texture-height</strong> <em>texture</em></dt>
<dd><p>Return the height of <var>texture</var> in pixels.
</p></dd></dl>
<dl>
<dt id="index-current_002dtexture_002d0">Procedure: <strong>current-texture-0</strong></dt>
<dd><p>Return the current texture associated with texture unit 0 on the GPU.
</p></dd></dl>
<dl>
<dt id="index-current_002dtexture_002d1">Procedure: <strong>current-texture-1</strong></dt>
<dd><p>Return the current texture associated with texture unit 1 on the GPU.
</p></dd></dl>
<dl>
<dt id="index-current_002dtexture_002d2">Procedure: <strong>current-texture-2</strong></dt>
<dd><p>Return the current texture associated with texture unit 2 on the GPU.
</p></dd></dl>
<dl>
<dt id="index-current_002dtexture_002d3">Procedure: <strong>current-texture-3</strong></dt>
<dd><p>Return the current texture associated with texture unit 3 on the GPU.
</p></dd></dl>
<dl>
<dt id="index-current_002dtexture_002d4">Procedure: <strong>current-texture-4</strong></dt>
<dd><p>Return the current texture associated with texture unit 4 on the GPU.
</p></dd></dl>
<dl>
<dt id="index-g_003atexture_002d0">Variable: <strong>g:texture-0</strong></dt>
<dd><p>Render state for texture unit 0 (see <a href="Rendering-Engine.html">Rendering Engine</a>.)
</p></dd></dl>
<dl>
<dt id="index-g_003atexture_002d1">Variable: <strong>g:texture-1</strong></dt>
<dd><p>Render state for texture unit 1 (see <a href="Rendering-Engine.html">Rendering Engine</a>.)
</p></dd></dl>
<dl>
<dt id="index-g_003atexture_002d2">Variable: <strong>g:texture-2</strong></dt>
<dd><p>Render state for texture unit 2 (see <a href="Rendering-Engine.html">Rendering Engine</a>.)
</p></dd></dl>
<dl>
<dt id="index-g_003atexture_002d3">Variable: <strong>g:texture-3</strong></dt>
<dd><p>Render state for texture unit 3 (see <a href="Rendering-Engine.html">Rendering Engine</a>.)
</p></dd></dl>
<dl>
<dt id="index-g_003atexture_002d4">Variable: <strong>g:texture-4</strong></dt>
<dd><p>Render state for texture unit 4 (see <a href="Rendering-Engine.html">Rendering Engine</a>.)
</p></dd></dl>
<span id="Tile-Atlases"></span><h4 class="subsubsection">5.3.2.1 Tile Atlases</h4>
<p>It is common practice to combine multiple bitmap images into a single
texture, known as a “tile atlas” or “tile set”, because it is more
efficient to render many regions of a large texture than it is to
render a bunch of small textures. Chickadee provides a tile atlas
data type for collecting texture regions into a single vector.
</p>
<dl>
<dt id="index-split_002dtexture">Procedure: <strong>split-texture</strong> <em>texture tile-width tile-height [#:margin 0] [#:spacing 0]</em></dt>
<dd>
<p>Return a new texture atlas that splits <var>texture</var> into a grid of
<var>tile-width</var> by <var>tile-height</var> rectangles. Optionally, each
tile may have <var>spacing</var> pixels of horizontal and vertical space
between surrounding tiles and the entire image may have <var>margin</var>
pixels of empty space around its border.
</p>
<p>This type of texture atlas layout is very common for 2D tile maps.
See <a href="Tile-Maps.html">Tile Maps</a> for more information.
</p></dd></dl>
<dl>
<dt id="index-load_002dtileset">Procedure: <strong>load-tileset</strong> <em>file-name tile-width tile-height [#:margin 0] [#:spacing 0] [#:min-filter nearest] [#:mag-filter nearest] [#:wrap-s repeat] [#:wrap-t repeat] [#:transparent-color]</em></dt>
<dd>
<p>Return a new texture atlas that splits the texture loaded from the
file <var>file-name</var> into a grid of <var>tile-width</var> by
<var>tile-height</var> rectangles. See <code>load-image</code> and
<code>split-texture</code> for information about all keyword arguments.
</p></dd></dl>
<dl>
<dt id="index-texture_002datlas_003f">Procedure: <strong>texture-atlas?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a texture atlas.
</p></dd></dl>
<dl>
<dt id="index-texture_002datlas_002dtexture">Procedure: <strong>texture-atlas-texture</strong> <em>atlas</em></dt>
<dd><p>Return the texture that all texture regions in <var>atlas</var> have been created from.
</p></dd></dl>
<dl>
<dt id="index-texture_002datlas_002dref">Procedure: <strong>texture-atlas-ref</strong> <em>atlas index</em></dt>
<dd><p>Return the texture region in <var>atlas</var> at <var>index</var>.
</p></dd></dl>
<span id="Cube-Maps"></span><h4 class="subsubsection">5.3.2.2 Cube Maps</h4>
<p>A cube map is a special type of texture composed of 6 images that can
be thought of as forming the 6 faces of a cube. See <a href="Skyboxes.html">Skyboxes</a> for a
practical use of cube maps.
</p>
<dl>
<dt id="index-load_002dcube_002dmap">Procedure: <strong>load-cube-map</strong> <em>#:right #:left #:top #:bottom #:front #:back [#:min-filter linear-mipmap-linear] [#:mag-filter linear]</em></dt>
<dd>
<p>Return a new cube map that uses the image data in the files
<var>right</var>, <var>left</var>, <var>top</var>, <var>bottom</var>, <var>front</var>, and
<var>back</var> for the 6 faces of the cube.
</p></dd></dl>
<dl>
<dt id="index-cube_002dmap_003f">Procedure: <strong>cube-map?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a cube map.
</p></dd></dl>
<hr>
<div class="header">
<p>
Next: <a href="Sprites.html" accesskey="n" rel="next">Sprites</a>, Previous: <a href="Colors.html" accesskey="p" rel="prev">Colors</a>, Up: <a href="Graphics.html" accesskey="u" rel="up">Graphics</a> [<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>
|
