2016-01-16 22:15:15 +01:00

239 lines
6.3 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>utils</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>utils</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>
<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../modules/stringutil.html">stringutil</a></li>
<li><a href="../modules/random.html">random</a></li>
<li><a href="../modules/noisemanager.html">noisemanager</a></li>
<li><a href="../modules/nodeutil.html">nodeutil</a></li>
<li><a href="../modules/posutil.html">posutil</a></li>
<li><a href="../modules/objectrefutil.html">objectrefutil</a></li>
<li><a href="../modules/nodeboxutil.html">nodeboxutil</a></li>
<li><a href="../modules/mapmanipulator.html">mapmanipulator</a></li>
<li><a href="../modules/fisheryates.html">fisheryates</a></li>
<li><strong>textureutil</strong></li>
<li><a href="../modules/blockutil.html">blockutil</a></li>
<li><a href="../modules/tango.html">tango</a></li>
<li><a href="../modules/arraymanipulator.html">arraymanipulator</a></li>
<li><a href="../modules/inventoryutil.html">inventoryutil</a></li>
<li><a href="../modules/entityutil.html">entityutil</a></li>
<li><a href="../modules/scheduler.html">scheduler</a></li>
<li><a href="../modules/blockedcache.html">blockedcache</a></li>
<li><a href="../modules/mathutil.html">mathutil</a></li>
<li><a href="../modules/log.html">log</a></li>
<li><a href="../modules/arrayutil.html">arrayutil</a></li>
<li><a href="../modules/directmapmanipulator.html">directmapmanipulator</a></li>
<li><a href="../modules/rotationutil.html">rotationutil</a></li>
<li><a href="../modules/settings.html">settings</a></li>
<li><a href="../modules/pathutil.html">pathutil</a></li>
<li><a href="../modules/wallmountedutil.html">wallmountedutil</a></li>
<li><a href="../modules/interpolate.html">interpolate</a></li>
<li><a href="../modules/transform.html">transform</a></li>
<li><a href="../modules/numberutil.html">numberutil</a></li>
<li><a href="../modules/test.html">test</a></li>
<li><a href="../modules/facedirutil.html">facedirutil</a></li>
<li><a href="../modules/constants.html">constants</a></li>
<li><a href="../modules/minetestex.html">minetestex</a></li>
<li><a href="../modules/list.html">list</a></li>
<li><a href="../modules/stopwatch.html">stopwatch</a></li>
<li><a href="../modules/itemutil.html">itemutil</a></li>
<li><a href="../modules/color.html">color</a></li>
<li><a href="../modules/tableutil.html">tableutil</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>textureutil</code></h1>
<p>Util for various functions regarding textures.</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#cube">cube (textures)</a></td>
<td class="summary">Creates a texture like for an unwrapped cube, see the cube_texture.png file
in the textures directory for an example.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#dummy">dummy (inner_color, border_color)</a></td>
<td class="summary">Creates a dummy texture with the two given colors.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#get_name">get_name (tile)</a></td>
<td class="summary">Gets the name from the given tile.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#tileable">tileable (tile, horizontal, vertical)</a></td>
<td class="summary">Creates a tile with the given tileable parameters.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "cube"></a>
<strong>cube (textures)</strong>
</dt>
<dd>
Creates a texture like for an unwrapped cube, see the cube_texture.png file
in the textures directory for an example.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">textures</span>
The textures or tiles.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The cube texture.
</ol>
</dd>
<dt>
<a name = "dummy"></a>
<strong>dummy (inner_color, border_color)</strong>
</dt>
<dd>
Creates a dummy texture with the two given colors.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">inner_color</span>
Optional. The color for the inner part, either a string
with leading "#" or a Color, defaults to a red.
</li>
<li><span class="parameter">border_color</span>
Optional. The color for the border, either a string
with leading "#" or a Color, defauls to gray.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The dummy texture (string).
</ol>
</dd>
<dt>
<a name = "get_name"></a>
<strong>get_name (tile)</strong>
</dt>
<dd>
Gets the name from the given tile.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">tile</span>
The tile.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The name of the tile.
</ol>
</dd>
<dt>
<a name = "tileable"></a>
<strong>tileable (tile, horizontal, vertical)</strong>
</dt>
<dd>
Creates a tile with the given tileable parameters.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">tile</span>
The name of the tile.
</li>
<li><span class="parameter">horizontal</span>
If the tile is horizontally tileable.
</li>
<li><span class="parameter">vertical</span>
If the tile is vertically tileable.
</li>
</ul>
<h3>Returns:</h3>
<ol>
A tile with tileable information.
</ol>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>