portal64-still-alive/skelatool64/doc/modules/sk_mesh.html
2022-12-30 20:28:27 -07:00

311 lines
7.8 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>skeletool64</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Tables">Tables</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/sk_input.html">sk_input</a></li>
<li><strong>sk_mesh</strong></li>
<li><a href="../modules/sk_transform.html">sk_transform</a></li>
<li><a href="../modules/sk_animation.html">sk_animation</a></li>
<li><a href="../modules/sk_definition_writer.html">sk_definition_writer</a></li>
<li><a href="../modules/sk_math.html">sk_math</a></li>
<li><a href="../modules/sk_scene.html">sk_scene</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>sk_mesh</code></h1>
<p></p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#generate_render_chunks">generate_render_chunks (node)</a></td>
<td class="summary">generate runder chunks for a node</td>
</tr>
<tr>
<td class="name" nowrap><a href="#generate_mesh">generate_mesh (renderChunks, file[, changes])</a></td>
<td class="summary">Generates a mesh</td>
</tr>
<tr>
<td class="name" nowrap><a href="#generate_vertex_buffer">generate_vertex_buffer (mesh[, material[, file_suffix]])</a></td>
<td class="summary">Generates a vertex buffer for a given mesh and material pair
Materials are important since it will determine if the vertex
buffer uses normals or colors and the size of the texture
used for calculated uv coordinates</td>
</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Material">Material</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="#Mesh">Mesh</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="#RenderChunk">RenderChunk</a></td>
<td class="summary"></td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "generate_render_chunks"></a>
<strong>generate_render_chunks (node)</strong>
</dt>
<dd>
generate runder chunks for a node
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">node</span>
<span class="types"><span class="type">sk_scene.Node</span></span>
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="../modules/sk_mesh.html#RenderChunk">{RenderChunk,...}</a></span>
result
</ol>
</dd>
<dt>
<a name = "generate_mesh"></a>
<strong>generate_mesh (renderChunks, file[, changes])</strong>
</dt>
<dd>
Generates a mesh
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">renderChunks</span>
<span class="types"><a class="type" href="../modules/sk_mesh.html#RenderChunk">{RenderChunk,...}</a></span>
</li>
<li><span class="parameter">file</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
suffix where the mesh definition is written to
</li>
<li><span class="parameter">changes</span>
<span class="types"><span class="type">DisplayListOverrides</span></span>
to the display list
(<em>optional</em>)
</li>
</ul>
</dd>
<dt>
<a name = "generate_vertex_buffer"></a>
<strong>generate_vertex_buffer (mesh[, material[, file_suffix]])</strong>
</dt>
<dd>
Generates a vertex buffer for a given mesh and material pair
Materials are important since it will determine if the vertex
buffer uses normals or colors and the size of the texture
used for calculated uv coordinates
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">mesh</span>
<span class="types"><a class="type" href="../modules/sk_mesh.html#Mesh">Mesh</a></span>
</li>
<li><span class="parameter">material</span>
<span class="types"><a class="type" href="../modules/sk_mesh.html#Material">Material</a></span>
(<em>optional</em>)
</li>
<li><span class="parameter">file_suffix</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
defaults to "_geo"
(<em>optional</em>)
</li>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "Material"></a>
<strong>Material</strong>
</dt>
<dd>
<h3>Fields:</h3>
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
</li>
<li><span class="parameter">macro_name</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
</li>
</ul>
</dd>
<dt>
<a name = "Mesh"></a>
<strong>Mesh</strong>
</dt>
<dd>
<h3>Fields:</h3>
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
</li>
<li><span class="parameter">transform</span>
<span class="types"><span class="type">sk_transform.Transform</span></span>
</li>
<li><span class="parameter">vertices</span>
<span class="types"><span class="type">{sk_math.Vector3,...}</span></span>
</li>
<li><span class="parameter">normals</span>
<span class="types"><span class="type">{sk_math.Vector3,...}</span></span>
</li>
<li><span class="parameter">faces</span>
<span class="types"><span class="type">{{number,number,number},...}</span></span>
</li>
<li><span class="parameter">material</span>
<span class="types"><a class="type" href="../modules/sk_mesh.html#Material">Material</a></span>
</li>
</ul>
</dd>
<dt>
<a name = "RenderChunk"></a>
<strong>RenderChunk</strong>
</dt>
<dd>
<h3>Fields:</h3>
<ul>
<li><span class="parameter">bone_pair</span>
<span class="types"><span class="type">{Bone,Bone}</span></span>
</li>
<li><span class="parameter">mesh</span>
<span class="types"><a class="type" href="../modules/sk_mesh.html#Mesh">Mesh</a></span>
</li>
<li><span class="parameter">meshRoot</span>
<span class="types"><span class="type">sk_scene.Node</span></span>
</li>
<li><span class="parameter">attached_dl_index</span>
<span class="types"><span class="type">number</span></span>
</li>
<li><span class="parameter">material</span>
<span class="types"><a class="type" href="../modules/sk_mesh.html#Material">Material</a></span>
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-12-30 12:30:52 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>