<!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: csTextureHandle Class 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>csTextureHandle Class Reference</h1><!-- doxytag: class="csTextureHandle" --><!-- doxytag: inherits="scfImplementation1< csTextureHandle, iTextureHandle >" -->This class is the top-level representation of a texture.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">csplugincommon/render3d/txtmgr.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csTextureHandle:</div>
<div class="dynsection">
<p><center><img src="classcsTextureHandle__inherit__graph.png" border="0" usemap="#csTextureHandle__inherit__map" alt="Inheritance graph"></center>
<map name="csTextureHandle__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csTextureHandle, iTextureHandle \>" alt="" coords="60,161,447,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csTextureHandle \>" alt="" coords="5,84,283,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="307,7,363,33"><area shape="rect" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager." alt="" coords="307,84,421,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="33,7,255,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsTextureHandle-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#1f4a017ce139b59be6139f3be7b3f56f">AdjustSizePo2</a> (int width, int height, int depth, int &newwidth, int &newheight, int &newdepth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjusts the textures size, to ensure some restrictions like power of two dimension are met. <a href="#1f4a017ce139b59be6139f3be7b3f56f"></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="classcsTextureHandle.html#7d434df1e7de95833ee882cf0b2e4d2a">GetAlphaMap</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query if the texture has an alpha channel. <a href="#7d434df1e7de95833ee882cf0b2e4d2a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structcsAlphaMode.html#b3d92a9f20c74d102be12658acbbbe49">csAlphaMode::AlphaType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#32efa8f48de50b5a3d48fd220f8579b1">GetAlphaType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of alpha associated with the texture. <a href="#32efa8f48de50b5a3d48fd220f8579b1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#96bbaa6969af492f168fd8f1958097ca">GetFlags</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">--------------------- <a class="el" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> implementation ---------------------- <a href="#96bbaa6969af492f168fd8f1958097ca"></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="classcsTextureHandle.html#33672baf483ac3c601398efd638eb8fe">GetKeyColor</a> (<a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> &r, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> &g, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> &b) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the transparent color. <a href="#33672baf483ac3c601398efd638eb8fe"></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="classcsTextureHandle.html#8895e710e4740d6ecd6b3ced18b741ce">GetKeyColor</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the transparent status (false if no transparency, true if transparency). <a href="#8895e710e4740d6ecd6b3ced18b741ce"></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="classcsTextureHandle.html#e4727c06eba94fe0a6ddb6dd47d14fdd">GetPrivateObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classcsTextureHandle.html" title="This class is the top-level representation of a texture.">csTextureHandle</a> object associated with the texture handle. <a href="#e4727c06eba94fe0a6ddb6dd47d14fdd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#f504e91c2966b8f58f66d4712376b632">GetTextureClass</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the "class" of a texture. <a href="#f504e91c2966b8f58f66d4712376b632"></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="classcsTextureHandle.html#d13e920aec5a534f6d070e8101996ce3">SetAlphaType</a> (<a class="el" href="structcsAlphaMode.html#b3d92a9f20c74d102be12658acbbbe49">csAlphaMode::AlphaType</a> <a class="el" href="classcsTextureHandle.html#56b170a547af2f855821f4998f15bafa">alphaType</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the type of alpha associated with the texture. <a href="#d13e920aec5a534f6d070e8101996ce3"></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="classcsTextureHandle.html#41e2f87931475675a41c630737c78f3a">SetKeyColor</a> (<a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> red, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> green, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> blue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the transparent color. <a href="#41e2f87931475675a41c630737c78f3a"></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="classcsTextureHandle.html#d2ed06e898fe5e258d70c17eb53b2ffd">SetKeyColor</a> (bool Enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable transparent color. <a href="#d2ed06e898fe5e258d70c17eb53b2ffd"></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="classcsTextureHandle.html#9b7194b7c16ce5f286a79bc15e71b0ad">SetTextureClass</a> (const char *className)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the "class" of this texture. <a href="#9b7194b7c16ce5f286a79bc15e71b0ad"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#fbe86bc48f42cb8b5e869e9423f005a5">CalculateNextBestPo2Size</a> (int <a class="el" href="classcsTextureHandle.html#411f5f7497abfe6b61dedc0fd92c1db4">flags</a>, const int orgDim, int &newDim)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Given a texture width and height, it tries to 'guesstimate' the po2 size that causes the least quality reduction: it calculates how many rows/columns would be added/removed when sizing up/down, and takes the one with the smaller number. <a href="#fbe86bc48f42cb8b5e869e9423f005a5"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="56b170a547af2f855821f4998f15bafa"></a><!-- doxytag: member="csTextureHandle::alphaType" ref="56b170a547af2f855821f4998f15bafa" args="" -->
<a class="el" href="structcsAlphaMode.html#b3d92a9f20c74d102be12658acbbbe49">csAlphaMode::AlphaType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#56b170a547af2f855821f4998f15bafa">alphaType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#411f5f7497abfe6b61dedc0fd92c1db4">flags</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Texture usage flags: 2d/3d/etc. <a href="#411f5f7497abfe6b61dedc0fd92c1db4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ebd3c9febd43fe01c53f6e7bf6791b60"></a><!-- doxytag: member="csTextureHandle::texClass" ref="ebd3c9febd43fe01c53f6e7bf6791b60" args="" -->
<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#ebd3c9febd43fe01c53f6e7bf6791b60">texClass</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="classcsTextureManager.html">csTextureManager</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#2cb13f49bb4a6bb933d533a6e8f4742a">texman</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parent texture manager. <a href="#2cb13f49bb4a6bb933d533a6e8f4742a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#b82575708a438a4b1d12dcd726c2abd3">transp</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Does color 0 mean "transparent" for this texture? <a href="#b82575708a438a4b1d12dcd726c2abd3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTextureHandle.html#62311ca2153c8b44c4c3ba6dde650b8b">transp_color</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The transparent color. <a href="#62311ca2153c8b44c4c3ba6dde650b8b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class is the top-level representation of a texture.
<p>
It contains a number of csTexture objects that represents each a single image. A csTexture object is created for each mipmap and for the 2D texture. This class is responsible for creating these textures and filling them with the correct info. The <a class="el" href="classcsTextureHandle.html" title="This class is the top-level representation of a texture.">csTextureHandle</a> class is private to the 3D driver, the driver clients see just the <a class="el" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> interface. <p>
The handle is initialized by giving the 3D driver a <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> object. Later the renderer will create mipmaps and 2D textures are created. The texture manager will release its reference to the image when no longer needed.
<p>Definition at line <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html#l00060">60</a> of file <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1f4a017ce139b59be6139f3be7b3f56f"></a><!-- doxytag: member="csTextureHandle::AdjustSizePo2" ref="1f4a017ce139b59be6139f3be7b3f56f" args="(int width, int height, int depth, int &newwidth, int &newheight, int &newdepth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csTextureHandle::AdjustSizePo2 </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>depth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>newwidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>newheight</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>newdepth</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adjusts the textures size, to ensure some restrictions like power of two dimension are met.
<p>
</div>
</div><p>
<a class="anchor" name="fbe86bc48f42cb8b5e869e9423f005a5"></a><!-- doxytag: member="csTextureHandle::CalculateNextBestPo2Size" ref="fbe86bc48f42cb8b5e869e9423f005a5" args="(int flags, const int orgDim, int &newDim)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void csTextureHandle::CalculateNextBestPo2Size </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"> <em>orgDim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>newDim</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Given a texture width and height, it tries to 'guesstimate' the po2 size that causes the least quality reduction: it calculates how many rows/columns would be added/removed when sizing up/down, and takes the one with the smaller number.
<p>
In case of a tie, it'll size up.
</div>
</div><p>
<a class="anchor" name="7d434df1e7de95833ee882cf0b2e4d2a"></a><!-- doxytag: member="csTextureHandle::GetAlphaMap" ref="7d434df1e7de95833ee882cf0b2e4d2a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csTextureHandle::GetAlphaMap </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query if the texture has an alpha channel.
<p>
This depends both on whenever the original image had an alpha channel and of the fact whenever the renderer supports alpha maps at all.
<p>Implements <a class="el" href="structiTextureHandle.html#72afd50341c75cc40c2da1fc0f9bbb4e">iTextureHandle</a>.</p>
<p>Definition at line <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html#l00118">118</a> of file <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="32efa8f48de50b5a3d48fd220f8579b1"></a><!-- doxytag: member="csTextureHandle::GetAlphaType" ref="32efa8f48de50b5a3d48fd220f8579b1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structcsAlphaMode.html#b3d92a9f20c74d102be12658acbbbe49">csAlphaMode::AlphaType</a> csTextureHandle::GetAlphaType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the type of alpha associated with the texture.
<p>
<p>Implements <a class="el" href="structiTextureHandle.html#a6a4fd4b56d5937f19af604722a22cd4">iTextureHandle</a>.</p>
<p>Definition at line <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html#l00130">130</a> of file <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="96bbaa6969af492f168fd8f1958097ca"></a><!-- doxytag: member="csTextureHandle::GetFlags" ref="96bbaa6969af492f168fd8f1958097ca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int csTextureHandle::GetFlags </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
--------------------- <a class="el" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> implementation ----------------------
<p>
<p>Implements <a class="el" href="structiTextureHandle.html#ad35aa4282b4c59c40e790c499339e8f">iTextureHandle</a>.</p>
<p>Definition at line <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html#l00092">92</a> of file <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="33672baf483ac3c601398efd638eb8fe"></a><!-- doxytag: member="csTextureHandle::GetKeyColor" ref="33672baf483ac3c601398efd638eb8fe" args="(uint8 &r, uint8 &g, uint8 &b) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextureHandle::GetKeyColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> & </td>
<td class="paramname"> <em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> & </td>
<td class="paramname"> <em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> & </td>
<td class="paramname"> <em>b</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the transparent color.
<p>
<p>Implements <a class="el" href="structiTextureHandle.html#cfe9e382ada756fed2f2a755e89bef89">iTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="8895e710e4740d6ecd6b3ced18b741ce"></a><!-- doxytag: member="csTextureHandle::GetKeyColor" ref="8895e710e4740d6ecd6b3ced18b741ce" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csTextureHandle::GetKeyColor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the transparent status (false if no transparency, true if transparency).
<p>
<p>Implements <a class="el" href="structiTextureHandle.html#52d20b447c014d36787bd22e04d9c5b7">iTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="e4727c06eba94fe0a6ddb6dd47d14fdd"></a><!-- doxytag: member="csTextureHandle::GetPrivateObject" ref="e4727c06eba94fe0a6ddb6dd47d14fdd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* csTextureHandle::GetPrivateObject </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the <a class="el" href="classcsTextureHandle.html" title="This class is the top-level representation of a texture.">csTextureHandle</a> object associated with the texture handle.
<p>
<p>Implements <a class="el" href="structiTextureHandle.html#efb30308e917cd492f53ddbc5cffe671">iTextureHandle</a>.</p>
<p>Definition at line <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html#l00110">110</a> of file <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f504e91c2966b8f58f66d4712376b632"></a><!-- doxytag: member="csTextureHandle::GetTextureClass" ref="f504e91c2966b8f58f66d4712376b632" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* csTextureHandle::GetTextureClass </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the "class" of a texture.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcsTextureHandle.html#9b7194b7c16ce5f286a79bc15e71b0ad" title="Set the "class" of this texture.">SetTextureClass</a> </dd></dl>
<p>Implements <a class="el" href="structiTextureHandle.html#a97e5c07fac8363ca9d43cec4925cfe5">iTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="d13e920aec5a534f6d070e8101996ce3"></a><!-- doxytag: member="csTextureHandle::SetAlphaType" ref="d13e920aec5a534f6d070e8101996ce3" args="(csAlphaMode::AlphaType alphaType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextureHandle::SetAlphaType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcsAlphaMode.html#b3d92a9f20c74d102be12658acbbbe49">csAlphaMode::AlphaType</a> </td>
<td class="paramname"> <em>alphaType</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the type of alpha associated with the texture.
<p>
Usually, the alpha mode is auto-detected (alphaSmooth on images with alpha channels, alphaBinary on keycolored images, alphaNone otherwise), but can be overridden with this method.
<p>Implements <a class="el" href="structiTextureHandle.html#09c835ee1f126786443d9fb6a67a9580">iTextureHandle</a>.</p>
<p>Definition at line <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html#l00132">132</a> of file <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="41e2f87931475675a41c630737c78f3a"></a><!-- doxytag: member="csTextureHandle::SetKeyColor" ref="41e2f87931475675a41c630737c78f3a" args="(uint8 red, uint8 green, uint8 blue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextureHandle::SetKeyColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> </td>
<td class="paramname"> <em>red</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> </td>
<td class="paramname"> <em>green</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> </td>
<td class="paramname"> <em>blue</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the transparent color.
<p>
<p>Implements <a class="el" href="structiTextureHandle.html#888d80cba9174c17f7fb39f319fa2599">iTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="d2ed06e898fe5e258d70c17eb53b2ffd"></a><!-- doxytag: member="csTextureHandle::SetKeyColor" ref="d2ed06e898fe5e258d70c17eb53b2ffd" args="(bool Enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextureHandle::SetKeyColor </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>Enable</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enable transparent color.
<p>
<p>Implements <a class="el" href="structiTextureHandle.html#d24caa35c6cb13be24f717f71e6c7a2d">iTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="9b7194b7c16ce5f286a79bc15e71b0ad"></a><!-- doxytag: member="csTextureHandle::SetTextureClass" ref="9b7194b7c16ce5f286a79bc15e71b0ad" args="(const char *className)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csTextureHandle::SetTextureClass </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>className</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the "class" of this texture.
<p>
A texture class is used to set some characteristics on how a texture is handled at runtime. For example, graphics hardware usually offers texture compression, but it can cause a loss of quality and precision and thus may not be desireable for all data. In this case, a class can be set on the texture that instructs the renderer to not apply texture compression. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Not all renderers may support texture classes. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcsTextureHandle.html#f504e91c2966b8f58f66d4712376b632" title="Get the "class" of a texture.">GetTextureClass</a> </dd></dl>
<p>Implements <a class="el" href="structiTextureHandle.html#8483e794ab875f777c0477dbdcffc6c1">iTextureHandle</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="411f5f7497abfe6b61dedc0fd92c1db4"></a><!-- doxytag: member="csTextureHandle::flags" ref="411f5f7497abfe6b61dedc0fd92c1db4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classcsTextureHandle.html#411f5f7497abfe6b61dedc0fd92c1db4">csTextureHandle::flags</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Texture usage flags: 2d/3d/etc.
<p>
<p>Definition at line <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html#l00068">68</a> of file <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2cb13f49bb4a6bb933d533a6e8f4742a"></a><!-- doxytag: member="csTextureHandle::texman" ref="2cb13f49bb4a6bb933d533a6e8f4742a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsRef.html">csRef</a><<a class="el" href="classcsTextureManager.html">csTextureManager</a>> <a class="el" href="classcsTextureHandle.html#2cb13f49bb4a6bb933d533a6e8f4742a">csTextureHandle::texman</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parent texture manager.
<p>
<p>Definition at line <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html#l00065">65</a> of file <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="b82575708a438a4b1d12dcd726c2abd3"></a><!-- doxytag: member="csTextureHandle::transp" ref="b82575708a438a4b1d12dcd726c2abd3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcsTextureHandle.html#b82575708a438a4b1d12dcd726c2abd3">csTextureHandle::transp</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Does color 0 mean "transparent" for this texture?
<p>
<p>Definition at line <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html#l00071">71</a> of file <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="62311ca2153c8b44c4c3ba6dde650b8b"></a><!-- doxytag: member="csTextureHandle::transp_color" ref="62311ca2153c8b44c4c3ba6dde650b8b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a> <a class="el" href="classcsTextureHandle.html#62311ca2153c8b44c4c3ba6dde650b8b">csTextureHandle::transp_color</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The transparent color.
<p>
<p>Definition at line <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html#l00073">73</a> of file <a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csplugincommon/render3d/<a class="el" href="csplugincommon_2render3d_2txtmgr_8h-source.html">txtmgr.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
>
1091
