summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Rendering-Engine.html
blob: 1c900226f07b99ba4fa261c961f21875f80e887b (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
<!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>Rendering Engine (The Chickadee Game Toolkit)</title>

<meta name="description" content="Rendering Engine (The Chickadee Game Toolkit)">
<meta name="keywords" content="Rendering Engine (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="Audio.html" rel="next" title="Audio">
<link href="Render-Settings.html" rel="prev" title="Render Settings">
<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="Rendering-Engine"></span><div class="header">
<p>
Previous: <a href="Render-Settings.html" accesskey="p" rel="prev">Render Settings</a>, Up: <a href="Graphics.html" accesskey="u" rel="up">Graphics</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="Rendering-Engine-1"></span><h4 class="subsection">5.3.17 Rendering Engine</h4>

<p>The <code>(chickadee graphics engine)</code> module provides a Scheme
abstraction to the state of the GPU driver.  When the Chickadee game
loop launches, it takes care to initialize the engine.  All draw calls
and state changes happen within the context of this engine.
</p>
<p>Performing a custom draw call could look something like this:
</p>
<div class="example">
<pre class="example">(with-graphics-state ((g:blend-mode blend:alpha)
                      (g:texture-0 my-texture))
  (shader-apply my-shader #:foo 1))
</pre></div>

<span id="Render-States"></span><h4 class="subsubsection">5.3.17.1 Render States</h4>

<p>Render states represent individual state values on the GPU.  For
example, the current shader.  As a naming convention, Chickadee
prefixes variables containing render states with <code>g:</code>.  Render
states can be manipulated using the <code>with-graphics-state</code> macro.
</p>
<dl>
<dt id="index-with_002dgraphics_002dstate">Syntax: <strong>with-graphics-state</strong> <em>((name value) &hellip;) body &hellip;</em></dt>
<dd><p>Evaluate <var>body</var> with render states defined by <var>name</var> changed
to <var>value</var>.  The render states are restored to their previous
values afterwards.
</p></dd></dl>

<p>One additional piece of state that the rendering engine has, that is
not part of the GPU state, is the current projection matrix:
</p>
<dl>
<dt id="index-current_002dprojection">Procedure: <strong>current-projection</strong></dt>
<dd><p>Return the currently bound projection matrix (see <a href="Matrices.html">Matrices</a>).
</p></dd></dl>

<dl>
<dt id="index-with_002dprojection">Syntax: <strong>with-projection</strong> <em>projection body &hellip;</em></dt>
<dd><p>Evaluate <var>body</var> with the current projection matrix bound to
<var>projection</var> (see <a href="Matrices.html">Matrices</a>).
</p></dd></dl>

<span id="Rendering"></span><h4 class="subsubsection">5.3.17.2 Rendering</h4>

<p>Chickadee likens a GPU draw call to a Scheme procedure call.  A shader
(see <a href="Shaders.html">Shaders</a>) is like a procedure for the GPU to apply.  Shaders
are passed arguments: The positional arguments are vertex array
attributes (see <a href="Buffers.html">Buffers</a>) and the keyword arguments correspond to
the shader&rsquo;s uniform variables.  Scheme uses <code>apply</code> to call a
procedure, so Chickadee uses <code>shader-apply</code> to call a shader.
</p>
<dl>
<dt id="index-shader_002dapply">Syntax: <strong>shader-apply</strong> <em>shader vertex-array                           [#:uniform-key uniform-value &hellip;]</em></dt>
<dt id="index-shader_002dapply_002a">Syntax: <strong>shader-apply*</strong> <em>shader vertex-array count                             [#:uniform-key uniform-value &hellip;]</em></dt>
<dd>
<p>Render <var>vertex-array</var> using <var>shader</var> with the uniform values
specified in the following keyword arguments.
</p>
<p>While <code>shader-apply</code> will draw every vertex in <var>vertex-array</var>,
<code>shader-apply*</code> will only draw <var>count</var> vertices.
</p></dd></dl>

<dl>
<dt id="index-shader_002dapply_002finstanced">Syntax: <strong>shader-apply/instanced</strong> <em>shader vertex-array        n [#:uniform-key uniform-value &hellip;]</em></dt>
<dt id="index-shader_002dapply_002finstanced-1">Syntax: <strong>shader-apply/instanced</strong> <em>shader vertex-array         count n [#:uniform-key uniform-value &hellip;]</em></dt>
<dd>
<p>Render <var>vertex-array</var> <var>n</var> times using <var>shader</var> with the
uniform values specified in the following keyword arguments.
</p>
<p>Instanced rendering is very beneficial for rendering the same object
many times with only small differences for each one.  For example, the
particle effects described in <a href="Particles.html">Particles</a> use instanced rendering.
</p>
<p>While <code>shader-apply/instanced</code> will draw every vertex in
<var>vertex-array</var>, <code>shader-apply*</code> will only draw <var>count</var>
vertices.
</p></dd></dl>

<hr>
<div class="header">
<p>
Previous: <a href="Render-Settings.html" accesskey="p" rel="prev">Render Settings</a>, Up: <a href="Graphics.html" accesskey="u" rel="up">Graphics</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>