diff options
Diffstat (limited to 'manuals/chickadee/Models.html')
| -rw-r--r-- | manuals/chickadee/Models.html | 167 |
1 files changed, 167 insertions, 0 deletions
diff --git a/manuals/chickadee/Models.html b/manuals/chickadee/Models.html new file mode 100644 index 0000000..3a1a6d6 --- /dev/null +++ b/manuals/chickadee/Models.html @@ -0,0 +1,167 @@ +<!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>Models (The Chickadee Game Toolkit)</title> + +<meta name="description" content="Models (The Chickadee Game Toolkit)"> +<meta name="keywords" content="Models (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="Lights.html" rel="next" title="Lights"> +<link href="Tile-Maps.html" rel="prev" title="Tile Maps"> +<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="Models"></span><div class="header"> +<p> +Next: <a href="Lights.html" accesskey="n" rel="next">Lights</a>, Previous: <a href="Tile-Maps.html" accesskey="p" rel="prev">Tile Maps</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="Models-1"></span><h4 class="subsection">5.3.8 Models</h4> + +<p><em>Disclaimer: Chickadee is alpha software, but 3D model support is +even more alpha than that. There are many missing features in both +the model loading and rendering components, so set your expectations +accordingly!</em> +</p> +<p>The <code>(chickadee graphics model)</code> module provides procedures to +load and render 3D models in the classic OBJ and more modern glTF 2.0 +formats. +</p> +<p>Here’s some basic boilerplate to render a 3D model: +</p> +<div class="example"> +<pre class="example">(use-modules (chickadee graphics light) + (chickadee graphics model) + (chickadee graphics skybox)) + +(define model (load-gltf "Suzanne.gltf")) +(define camera-position (vec3 0.0 0.0 3.0)) +(define world (make-identity-matrix4)) +(define view (look-at camera-position (vec3 0.0 0.0 0.0) (vec3 0.0 1.0 0.0))) +(define projection (perspective-projection (/ pi 3.0) (/ 4.0 3.0) 0.1 5.0)) + +(define (draw alpha) + (with-projection projection + (draw-model model world view camera-position +</pre></div> + +<dl> +<dt id="index-load_002dobj">Procedure: <strong>load-obj</strong> <em>file-name</em></dt> +<dd><p>Load the OBJ formatted model in <var>file-name</var> and return a 3D model +object. +</p> +<p>OBJ models are rendered using a Phong lighting model, which is a +work-in-progress. +</p></dd></dl> + +<dl> +<dt id="index-load_002dgltf">Procedure: <strong>load-gltf</strong> <em>file-name</em></dt> +<dd><p>Load the glTF 2.0 formatted model in <var>file-name</var> and return a 3D +model object. +</p> +<p>glTF models are rendered using a physically based lighting model, +which is currently a stub to be implemented later. +</p></dd></dl> + +<dl> +<dt id="index-model_003f">Procedure: <strong>model?</strong> <em>obj</em></dt> +<dd><p>Return <code>#t</code> if <var>obj</var> is a 3D model. +</p></dd></dl> + +<dl> +<dt id="index-draw_002dmodel">Procedure: <strong>draw-model</strong> <em>model [#:model-matrix] [#:view-matrix] [#:camera-position (vec3 0 0 0)] [#:skybox] [#:lights '()]</em></dt> +<dd> +<p>Render <var>model</var> with the transformation matrices <var>model-matrix</var> +and <var>view-matrix</var> applied. <var>camera-position</var> is the world +position of the camera, for correct specular lighting calculations. +<var>skybox</var> is used to apply ambient lighting to the model. +<var>lights</var> contains all of the dynamic lights (see <a href="Lights.html">Lights</a>) that +should have an effect on the model. +</p></dd></dl> + +<p>Models are composed of simpler data types: meshes, primitives, and +materials. Let’s start with materials. A material controls the +appearance of a 3D object. Is the object a rough stone? Or maybe a +smooth metal? Materials control all of this and more. +</p> +<p>There are two types of materials in Chickadee: Phong and PBR. +</p> +<hr> +<div class="header"> +<p> +Next: <a href="Lights.html" accesskey="n" rel="next">Lights</a>, Previous: <a href="Tile-Maps.html" accesskey="p" rel="prev">Tile Maps</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> |