<!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: iHalo 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>iHalo Struct Reference<br>
<small>
[<a class="el" href="group__gfx3d.html">3D</a>]</small>
</h1><!-- doxytag: class="iHalo" --><!-- doxytag: inherits="iBase" --><a class="el" href="structiHalo.html" title="iHalo: used to render halos (aka "light globes").">iHalo</a>: used to render halos (aka "light globes").
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ivideo_2halo_8h-source.html">ivideo/halo.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iHalo:</div>
<div class="dynsection">
<p><center><img src="structiHalo__inherit__graph.png" border="0" usemap="#iHalo__inherit__map" alt="Inheritance graph"></center>
<map name="iHalo__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="5,7,61,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiHalo-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiHalo.html#2007fca1d4d043b81de4c0596d1f3925">Draw</a> (float x, float y, float w, float h, float iIntensity, <a class="el" href="classcsVector2.html">csVector2</a> *iVertices, size_t iVertCount)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw the halo given a center point and an intensity. <a href="#2007fca1d4d043b81de4c0596d1f3925"></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="structiHalo.html#d543a4708d6aa4839ca911c28842a1f3">GetColor</a> (float &oR, float &oG, float &oB)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query halo color. <a href="#d543a4708d6aa4839ca911c28842a1f3"></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="structiHalo.html#cd870120c7bd491b9116d808847ecc49">GetHeight</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query halo height. <a href="#cd870120c7bd491b9116d808847ecc49"></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="structiHalo.html#210bec234106a2ceb5561c76a487da23">GetWidth</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query halo width. <a href="#210bec234106a2ceb5561c76a487da23"></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="structiHalo.html#c7082492c760b3cac22a3e6e212710b7">SetColor</a> (float &iR, float &iG, float &iB)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change halo color. <a href="#c7082492c760b3cac22a3e6e212710b7"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="structiHalo.html" title="iHalo: used to render halos (aka "light globes").">iHalo</a>: used to render halos (aka "light globes").
<p>
This interface can be used as well for any scalable semi-transparent 2D sprites. The "halo" is really just an alpha map; the sprite is a single-colored rectangle with more or less transparent portions (depends on alpha map).
<p>Definition at line <a class="el" href="ivideo_2halo_8h-source.html#l00041">41</a> of file <a class="el" href="ivideo_2halo_8h-source.html">halo.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2007fca1d4d043b81de4c0596d1f3925"></a><!-- doxytag: member="iHalo::Draw" ref="2007fca1d4d043b81de4c0596d1f3925" args="(float x, float y, float w, float h, float iIntensity, csVector2 *iVertices, size_t iVertCount)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iHalo::Draw </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>iIntensity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsVector2.html">csVector2</a> * </td>
<td class="paramname"> <em>iVertices</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>iVertCount</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Draw the halo given a center point and an intensity.
<p>
If either w and/or h is negative, the native width and/or height is used instead. If the halo should be clipped against some polygon, that polygon should be given, otherwise if a 0 pointer is passed, the halo is clipped just against screen bounds.
</div>
</div><p>
<a class="anchor" name="d543a4708d6aa4839ca911c28842a1f3"></a><!-- doxytag: member="iHalo::GetColor" ref="d543a4708d6aa4839ca911c28842a1f3" args="(float &oR, float &oG, float &oB)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iHalo::GetColor </td>
<td>(</td>
<td class="paramtype">float & </td>
<td class="paramname"> <em>oR</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"> <em>oG</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"> <em>oB</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query halo color.
<p>
</div>
</div><p>
<a class="anchor" name="cd870120c7bd491b9116d808847ecc49"></a><!-- doxytag: member="iHalo::GetHeight" ref="cd870120c7bd491b9116d808847ecc49" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iHalo::GetHeight </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query halo height.
<p>
</div>
</div><p>
<a class="anchor" name="210bec234106a2ceb5561c76a487da23"></a><!-- doxytag: member="iHalo::GetWidth" ref="210bec234106a2ceb5561c76a487da23" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iHalo::GetWidth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query halo width.
<p>
</div>
</div><p>
<a class="anchor" name="c7082492c760b3cac22a3e6e212710b7"></a><!-- doxytag: member="iHalo::SetColor" ref="c7082492c760b3cac22a3e6e212710b7" args="(float &iR, float &iG, float &iB)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iHalo::SetColor </td>
<td>(</td>
<td class="paramtype">float & </td>
<td class="paramname"> <em>iR</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"> <em>iG</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"> <em>iB</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change halo color.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivideo/<a class="el" href="ivideo_2halo_8h-source.html">halo.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
>
3088
