<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iFireTexture Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iFireTexture Struct Reference<br>
<small>
[<a class="el" href="group__gfx3d.html">3D</a>]</small>
</h1><!-- doxytag: class="iFireTexture" --><!-- doxytag: inherits="iBase" -->Interface to the 'fire' procedural texture.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ifire_8h-source.html">itexture/ifire.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iFireTexture:</div>
<div class="dynsection">
<p><center><img src="structiFireTexture__inherit__graph.png" border="0" usemap="#iFireTexture__inherit__map" alt="Inheritance graph"></center>
<map name="iFireTexture__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="24,7,80,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiFireTexture-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#cf81d3c98077bbfdb167e3e65029b3f3">GetAdditionalBurn</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get additional burn. <a href="#cf81d3c98077bbfdb167e3e65029b3f3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#8b7f9c46d6269258063017ac31fda00c">GetContinuedBurn</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get continued burn. <a href="#8b7f9c46d6269258063017ac31fda00c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#e4fd10bca0c64bc5840b22783e0b6cbe">GetExtinguish</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get burning down param. <a href="#e4fd10bca0c64bc5840b22783e0b6cbe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#24888fc09641ab6f22fd7c0d55ff51dd">GetHalfBase</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get 1/2 size of flame base. <a href="#24888fc09641ab6f22fd7c0d55ff51dd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#f831d4d82d65cbd5ac1900afcd271d57">GetPossibleBurn</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get possible burn. <a href="#f831d4d82d65cbd5ac1900afcd271d57"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#f0cc484741fbd94e66b743b71b6d2bc3">GetPostSmoothing</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get post smoothing value. <a href="#f0cc484741fbd94e66b743b71b6d2bc3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#6c8687e0179d11018cba3594d5edf4cc">GetSingleFlameMode</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get single flame mode. <a href="#6c8687e0179d11018cba3594d5edf4cc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#2242c7cc3161ddb60530d1a474b2d55c">GetSmoothing</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get smoothing factor. <a href="#2242c7cc3161ddb60530d1a474b2d55c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#af2a5a834c95514598b03a43e8e553e7">SetAdditionalBurn</a> (int addburn)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set animation parameter: additional burn (0. <a href="#af2a5a834c95514598b03a43e8e553e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#364ed23dbb0720e3d108de47f4c9d8c4">SetContinuedBurn</a> (int contburn)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set animation parameter: continued burn (0. <a href="#364ed23dbb0720e3d108de47f4c9d8c4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#4b2b24e5c93a7ab67d965cbea8040269">SetExtinguish</a> (int extinguish)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set animation parameter: burning down param Try 3*256/height. <a href="#4b2b24e5c93a7ab67d965cbea8040269"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#4326b2cf9d92dceeeac2a604a3bbc297">SetHalfBase</a> (int halfbase)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set animation parameter: 1/2 size of flame base, from middle bottom sideways. <a href="#4326b2cf9d92dceeeac2a604a3bbc297"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#97ec331c0b137d8d87763676fa7e7738">SetPalette</a> (<a class="el" href="structiGradient.html">iGradient</a> *gradient)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the colors used by the flame. <a href="#97ec331c0b137d8d87763676fa7e7738"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#d9bd5c2207eedf231aa39f6db423b567">SetPossibleBurn</a> (int possburn)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set animation parameter: possible burn (0. <a href="#d9bd5c2207eedf231aa39f6db423b567"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#2a4c7ed619db1ba46503bf041b35921e">SetPostSmoothing</a> (int amount)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set whether to smooth the whole image again after calculating an iteration. <a href="#2a4c7ed619db1ba46503bf041b35921e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#ebda2126c68d8d03b3c89e0bd4723a34">SetSingleFlameMode</a> (bool enable)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set single flame mode. <a href="#ebda2126c68d8d03b3c89e0bd4723a34"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiFireTexture.html#aad78d5f0226969602057fc3d2405c7e">SetSmoothing</a> (int smoothing)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set animation parameter: smoothing factor (0. <a href="#aad78d5f0226969602057fc3d2405c7e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Interface to the 'fire' procedural texture.
<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000027">Todo:</a></b></dt><dd>'GetPalette()' maybe. </dd></dl>
<p>Definition at line <a class="el" href="ifire_8h-source.html#l00039">39</a> of file <a class="el" href="ifire_8h-source.html">ifire.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="cf81d3c98077bbfdb167e3e65029b3f3"></a><!-- doxytag: member="iFireTexture::GetAdditionalBurn" ref="cf81d3c98077bbfdb167e3e65029b3f3" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iFireTexture::GetAdditionalBurn </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get additional burn.
<p>
</div>
</div><p>
<a class="anchor" name="8b7f9c46d6269258063017ac31fda00c"></a><!-- doxytag: member="iFireTexture::GetContinuedBurn" ref="8b7f9c46d6269258063017ac31fda00c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iFireTexture::GetContinuedBurn </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get continued burn.
<p>
</div>
</div><p>
<a class="anchor" name="e4fd10bca0c64bc5840b22783e0b6cbe"></a><!-- doxytag: member="iFireTexture::GetExtinguish" ref="e4fd10bca0c64bc5840b22783e0b6cbe" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iFireTexture::GetExtinguish </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get burning down param.
<p>
</div>
</div><p>
<a class="anchor" name="24888fc09641ab6f22fd7c0d55ff51dd"></a><!-- doxytag: member="iFireTexture::GetHalfBase" ref="24888fc09641ab6f22fd7c0d55ff51dd" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iFireTexture::GetHalfBase </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get 1/2 size of flame base.
<p>
</div>
</div><p>
<a class="anchor" name="f831d4d82d65cbd5ac1900afcd271d57"></a><!-- doxytag: member="iFireTexture::GetPossibleBurn" ref="f831d4d82d65cbd5ac1900afcd271d57" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iFireTexture::GetPossibleBurn </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get possible burn.
<p>
</div>
</div><p>
<a class="anchor" name="f0cc484741fbd94e66b743b71b6d2bc3"></a><!-- doxytag: member="iFireTexture::GetPostSmoothing" ref="f0cc484741fbd94e66b743b71b6d2bc3" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iFireTexture::GetPostSmoothing </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get post smoothing value.
<p>
</div>
</div><p>
<a class="anchor" name="6c8687e0179d11018cba3594d5edf4cc"></a><!-- doxytag: member="iFireTexture::GetSingleFlameMode" ref="6c8687e0179d11018cba3594d5edf4cc" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iFireTexture::GetSingleFlameMode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get single flame mode.
<p>
</div>
</div><p>
<a class="anchor" name="2242c7cc3161ddb60530d1a474b2d55c"></a><!-- doxytag: member="iFireTexture::GetSmoothing" ref="2242c7cc3161ddb60530d1a474b2d55c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iFireTexture::GetSmoothing </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get smoothing factor.
<p>
</div>
</div><p>
<a class="anchor" name="af2a5a834c95514598b03a43e8e553e7"></a><!-- doxytag: member="iFireTexture::SetAdditionalBurn" ref="af2a5a834c95514598b03a43e8e553e7" args="(int addburn)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iFireTexture::SetAdditionalBurn </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>addburn</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set animation parameter: additional burn (0.
<p>
.) Try addburn=1..5 or so
</div>
</div><p>
<a class="anchor" name="364ed23dbb0720e3d108de47f4c9d8c4"></a><!-- doxytag: member="iFireTexture::SetContinuedBurn" ref="364ed23dbb0720e3d108de47f4c9d8c4" args="(int contburn)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iFireTexture::SetContinuedBurn </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>contburn</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set animation parameter: continued burn (0.
<p>
.) Try 80.
</div>
</div><p>
<a class="anchor" name="4b2b24e5c93a7ab67d965cbea8040269"></a><!-- doxytag: member="iFireTexture::SetExtinguish" ref="4b2b24e5c93a7ab67d965cbea8040269" args="(int extinguish)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iFireTexture::SetExtinguish </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>extinguish</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set animation parameter: burning down param Try 3*256/height.
<p>
</div>
</div><p>
<a class="anchor" name="4326b2cf9d92dceeeac2a604a3bbc297"></a><!-- doxytag: member="iFireTexture::SetHalfBase" ref="4326b2cf9d92dceeeac2a604a3bbc297" args="(int halfbase)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iFireTexture::SetHalfBase </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>halfbase</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set animation parameter: 1/2 size of flame base, from middle bottom sideways.
<p>
</div>
</div><p>
<a class="anchor" name="97ec331c0b137d8d87763676fa7e7738"></a><!-- doxytag: member="iFireTexture::SetPalette" ref="97ec331c0b137d8d87763676fa7e7738" args="(iGradient *gradient)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iFireTexture::SetPalette </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiGradient.html">iGradient</a> * </td>
<td class="paramname"> <em>gradient</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the colors used by the flame.
<p>
Position 0 = darkest areas (background, actually), position 1 = brightest areas.
</div>
</div><p>
<a class="anchor" name="d9bd5c2207eedf231aa39f6db423b567"></a><!-- doxytag: member="iFireTexture::SetPossibleBurn" ref="d9bd5c2207eedf231aa39f6db423b567" args="(int possburn)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iFireTexture::SetPossibleBurn </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>possburn</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set animation parameter: possible burn (0.
<p>
.) Try possburn 3=wood,90=oil,255=max.
</div>
</div><p>
<a class="anchor" name="2a4c7ed619db1ba46503bf041b35921e"></a><!-- doxytag: member="iFireTexture::SetPostSmoothing" ref="2a4c7ed619db1ba46503bf041b35921e" args="(int amount)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iFireTexture::SetPostSmoothing </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>amount</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set whether to smooth the whole image again after calculating an iteration.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>amount</em> </td><td>Size of the square used for averaging. 0 = disable smoothing. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ebda2126c68d8d03b3c89e0bd4723a34"></a><!-- doxytag: member="iFireTexture::SetSingleFlameMode" ref="ebda2126c68d8d03b3c89e0bd4723a34" args="(bool enable)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iFireTexture::SetSingleFlameMode </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set single flame mode.
<p>
</div>
</div><p>
<a class="anchor" name="aad78d5f0226969602057fc3d2405c7e"></a><!-- doxytag: member="iFireTexture::SetSmoothing" ref="aad78d5f0226969602057fc3d2405c7e" args="(int smoothing)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iFireTexture::SetSmoothing </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>smoothing</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set animation parameter: smoothing factor (0.
<p>
.) Try 2.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>itexture/<a class="el" href="ifire_8h-source.html">ifire.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3016
