<!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: iTextureHandle 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>iTextureHandle Struct Reference<br>
<small>
[<a class="el" href="group__gfx3d.html">3D</a>]</small>
</h1><!-- doxytag: class="iTextureHandle" --><!-- doxytag: inherits="iBase" -->A texture handle as returned by <a class="el" href="structiTextureManager.html" title="This is the standard texture manager interface.">iTextureManager</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ivideo_2texture_8h-source.html">ivideo/texture.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iTextureHandle:</div>
<div class="dynsection">
<p><center><img src="structiTextureHandle__inherit__graph.png" border="0" usemap="#iTextureHandle__inherit__map" alt="Inheritance graph"></center>
<map name="iTextureHandle__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csTextureHandle, iTextureHandle \>" alt="" coords="5,161,392,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="171,7,227,33"><area shape="rect" href="classcsTextureHandle.html" title="This class is the top-level representation of a texture." alt="" coords="136,239,261,265"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiTextureHandle-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <br>
<a class="el" href="structiTextureHandle.html#0eeb9d63f87a1ed557b92a4e6192554b114aa5014af4d30f29bf74a053da7b0b">CS_TEX_IMG_1D</a> = 0,
<a class="el" href="structiTextureHandle.html#0eeb9d63f87a1ed557b92a4e6192554be433afe6e50efaef98a36ed23270a046">CS_TEX_IMG_2D</a>,
<a class="el" href="structiTextureHandle.html#0eeb9d63f87a1ed557b92a4e6192554b3fd45a9bbd009e3059573f2d0771bf32">CS_TEX_IMG_3D</a>,
<a class="el" href="structiTextureHandle.html#0eeb9d63f87a1ed557b92a4e6192554bf4192ecb51a16bc53075a99800c1f228">CS_TEX_IMG_CUBEMAP</a>,
<br>
<a class="el" href="structiTextureHandle.html#0eeb9d63f87a1ed557b92a4e6192554bdc67142b4b55994c9a4ac6a0eae95033">CS_TEX_IMG_RECT</a>
<br>
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <br>
<a class="el" href="structiTextureHandle.html#26f2ae454cec4b4d58045effa101fa6314694cb3f3e5b590dd214f188d61e056">CS_TEXTURE_CUBE_POS_X</a> = 0,
<a class="el" href="structiTextureHandle.html#26f2ae454cec4b4d58045effa101fa636e2ecc52f0893adc64d71cf4b362d5c2">CS_TEXTURE_CUBE_NEG_X</a>,
<a class="el" href="structiTextureHandle.html#26f2ae454cec4b4d58045effa101fa63689488002292014541da791852ca7442">CS_TEXTURE_CUBE_POS_Y</a>,
<a class="el" href="structiTextureHandle.html#26f2ae454cec4b4d58045effa101fa630602ba75d3e091f089cb47837ecca112">CS_TEXTURE_CUBE_NEG_Y</a>,
<br>
<a class="el" href="structiTextureHandle.html#26f2ae454cec4b4d58045effa101fa63e6bf4a8925c40f5ee91276216f773f58">CS_TEXTURE_CUBE_POS_Z</a>,
<a class="el" href="structiTextureHandle.html#26f2ae454cec4b4d58045effa101fa6340d3c51f8e26764af1384c852b4b40f5">CS_TEXTURE_CUBE_NEG_Z</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Texture Depth Indices are used for Cubemap interface. <a href="structiTextureHandle.html#26f2ae454cec4b4d58045effa101fa63">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureHandle.html#6761ec16c57b70ba89dc4401fd095414">TextureBlitDataFormat</a> { <a class="el" href="structiTextureHandle.html#6761ec16c57b70ba89dc4401fd0954146146a90f722098d73f2752ad335a72a8">RGBA8888</a> = 0,
<a class="el" href="structiTextureHandle.html#6761ec16c57b70ba89dc4401fd0954142f6487333942268571ffb264296a066f">BGRA8888</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Format of the pixel data that is passed to iTextureHandle-><a class="el" href="structiTextureHandle.html#dc814d2a029f9153c0bc0bd5bcbc9aca" title="Blit a memory block to this texture.">Blit()</a>. <a href="structiTextureHandle.html#6761ec16c57b70ba89dc4401fd095414">More...</a><br></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="structiTextureHandle.html#dc814d2a029f9153c0bc0bd5bcbc9aca">Blit</a> (int x, int y, int width, int height, unsigned char const *data, <a class="el" href="structiTextureHandle.html#6761ec16c57b70ba89dc4401fd095414">TextureBlitDataFormat</a> format=RGBA8888)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Blit a memory block to this texture. <a href="#dc814d2a029f9153c0bc0bd5bcbc9aca"></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="structiTextureHandle.html#72afd50341c75cc40c2da1fc0f9bbb4e">GetAlphaMap</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query if the texture has an alpha channel. <a href="#72afd50341c75cc40c2da1fc0f9bbb4e"></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="structiTextureHandle.html#a6a4fd4b56d5937f19af604722a22cd4">GetAlphaType</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of alpha associated with the texture. <a href="#a6a4fd4b56d5937f19af604722a22cd4"></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="structiTextureHandle.html#ad35aa4282b4c59c40e790c499339e8f">GetFlags</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the flags set for this texture. <a href="#ad35aa4282b4c59c40e790c499339e8f"></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="structiTextureHandle.html#5c224dfb2d50110d1b837fe8e39e0b88">GetImageName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the original image name. <a href="#5c224dfb2d50110d1b837fe8e39e0b88"></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="structiTextureHandle.html#cfe9e382ada756fed2f2a755e89bef89">GetKeyColor</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) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the key color. <a href="#cfe9e382ada756fed2f2a755e89bef89"></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="structiTextureHandle.html#52d20b447c014d36787bd22e04d9c5b7">GetKeyColor</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the key color status (false if disabled, true if enabled). <a href="#52d20b447c014d36787bd22e04d9c5b7"></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="structiTextureHandle.html#be99b70b5af0283af51e2bd7a04368b4">GetOriginalDimensions</a> (int &mw, int &mh, int &md)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the original dimensions of the image used to create this texture. <a href="#be99b70b5af0283af51e2bd7a04368b4"></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="structiTextureHandle.html#fa2ac6954bdeb8c99e1a1519235f9c33">GetOriginalDimensions</a> (int &mw, int &mh)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the original dimensions of the image used to create this texture. <a href="#fa2ac6954bdeb8c99e1a1519235f9c33"></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="structiTextureHandle.html#efb30308e917cd492f53ddbc5cffe671">GetPrivateObject</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the private object associated with this handle. <a href="#efb30308e917cd492f53ddbc5cffe671"></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="structiTextureHandle.html#e8a9690621542b96b7e1e9e3b2dfcce3">GetRendererDimensions</a> (int &mw, int &mh, int &md)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the dimensions the renderer uses for this texture. <a href="#e8a9690621542b96b7e1e9e3b2dfcce3"></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="structiTextureHandle.html#329227bace4cb6387a254c11e36c674d">GetRendererDimensions</a> (int &mw, int &mh)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the dimensions the renderer uses for this texture. <a href="#329227bace4cb6387a254c11e36c674d"></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="structiTextureHandle.html#a97e5c07fac8363ca9d43cec4925cfe5">GetTextureClass</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the "class" of a texture. <a href="#a97e5c07fac8363ca9d43cec4925cfe5"></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="structiTextureHandle.html#c561bfec07ac72a26cfbae652612f91e">GetTextureTarget</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the texture target. <a href="#c561bfec07ac72a26cfbae652612f91e"></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="structiTextureHandle.html#61eac8b0b581eddceea99472fda15054">Precache</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Precache this texture. <a href="#61eac8b0b581eddceea99472fda15054"></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="structiTextureHandle.html#09c835ee1f126786443d9fb6a67a9580">SetAlphaType</a> (<a class="el" href="structcsAlphaMode.html#b3d92a9f20c74d102be12658acbbbe49">csAlphaMode::AlphaType</a> alphaType)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the type of alpha associated with the texture. <a href="#09c835ee1f126786443d9fb6a67a9580"></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="structiTextureHandle.html#888d80cba9174c17f7fb39f319fa2599">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)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the key color. <a href="#888d80cba9174c17f7fb39f319fa2599"></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="structiTextureHandle.html#d24caa35c6cb13be24f717f71e6c7a2d">SetKeyColor</a> (bool Enable)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable key color. <a href="#d24caa35c6cb13be24f717f71e6c7a2d"></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="structiTextureHandle.html#8483e794ab875f777c0477dbdcffc6c1">SetTextureClass</a> (const char *className)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the "class" of this texture. <a href="#8483e794ab875f777c0477dbdcffc6c1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A texture handle as returned by <a class="el" href="structiTextureManager.html" title="This is the standard texture manager interface.">iTextureManager</a>.
<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiTextureManager.html#d0d411c423ec7bcf0ca248832d30218f" title="Register a texture.">iTextureManager::RegisterTexture()</a></li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiTextureWrapper.html#ca59c07c6940a87f2e0b391301c47cc6" title="Get the texture handle.">iTextureWrapper::GetTextureHandle()</a></li></ul>
<p>
Main users of this interface:<ul>
<li>3D renderer implementations (<a class="el" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>). </li></ul>
<p>Definition at line <a class="el" href="ivideo_2texture_8h-source.html#l00051">51</a> of file <a class="el" href="ivideo_2texture_8h-source.html">texture.h</a>.</p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="0eeb9d63f87a1ed557b92a4e6192554b"></a><!-- doxytag: member="iTextureHandle::@87" ref="0eeb9d63f87a1ed557b92a4e6192554b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="0eeb9d63f87a1ed557b92a4e6192554b114aa5014af4d30f29bf74a053da7b0b"></a><!-- doxytag: member="CS_TEX_IMG_1D" ref="0eeb9d63f87a1ed557b92a4e6192554b114aa5014af4d30f29bf74a053da7b0b" args="" -->CS_TEX_IMG_1D</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="0eeb9d63f87a1ed557b92a4e6192554be433afe6e50efaef98a36ed23270a046"></a><!-- doxytag: member="CS_TEX_IMG_2D" ref="0eeb9d63f87a1ed557b92a4e6192554be433afe6e50efaef98a36ed23270a046" args="" -->CS_TEX_IMG_2D</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="0eeb9d63f87a1ed557b92a4e6192554b3fd45a9bbd009e3059573f2d0771bf32"></a><!-- doxytag: member="CS_TEX_IMG_3D" ref="0eeb9d63f87a1ed557b92a4e6192554b3fd45a9bbd009e3059573f2d0771bf32" args="" -->CS_TEX_IMG_3D</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="0eeb9d63f87a1ed557b92a4e6192554bf4192ecb51a16bc53075a99800c1f228"></a><!-- doxytag: member="CS_TEX_IMG_CUBEMAP" ref="0eeb9d63f87a1ed557b92a4e6192554bf4192ecb51a16bc53075a99800c1f228" args="" -->CS_TEX_IMG_CUBEMAP</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="0eeb9d63f87a1ed557b92a4e6192554bdc67142b4b55994c9a4ac6a0eae95033"></a><!-- doxytag: member="CS_TEX_IMG_RECT" ref="0eeb9d63f87a1ed557b92a4e6192554bdc67142b4b55994c9a4ac6a0eae95033" args="" -->CS_TEX_IMG_RECT</em> </td><td>
</td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="ivideo_2texture_8h-source.html#l00091">91</a> of file <a class="el" href="ivideo_2texture_8h-source.html">texture.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="26f2ae454cec4b4d58045effa101fa63"></a><!-- doxytag: member="iTextureHandle::@88" ref="26f2ae454cec4b4d58045effa101fa63" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Texture Depth Indices are used for Cubemap interface.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="26f2ae454cec4b4d58045effa101fa6314694cb3f3e5b590dd214f188d61e056"></a><!-- doxytag: member="CS_TEXTURE_CUBE_POS_X" ref="26f2ae454cec4b4d58045effa101fa6314694cb3f3e5b590dd214f188d61e056" args="" -->CS_TEXTURE_CUBE_POS_X</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="26f2ae454cec4b4d58045effa101fa636e2ecc52f0893adc64d71cf4b362d5c2"></a><!-- doxytag: member="CS_TEXTURE_CUBE_NEG_X" ref="26f2ae454cec4b4d58045effa101fa636e2ecc52f0893adc64d71cf4b362d5c2" args="" -->CS_TEXTURE_CUBE_NEG_X</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="26f2ae454cec4b4d58045effa101fa63689488002292014541da791852ca7442"></a><!-- doxytag: member="CS_TEXTURE_CUBE_POS_Y" ref="26f2ae454cec4b4d58045effa101fa63689488002292014541da791852ca7442" args="" -->CS_TEXTURE_CUBE_POS_Y</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="26f2ae454cec4b4d58045effa101fa630602ba75d3e091f089cb47837ecca112"></a><!-- doxytag: member="CS_TEXTURE_CUBE_NEG_Y" ref="26f2ae454cec4b4d58045effa101fa630602ba75d3e091f089cb47837ecca112" args="" -->CS_TEXTURE_CUBE_NEG_Y</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="26f2ae454cec4b4d58045effa101fa63e6bf4a8925c40f5ee91276216f773f58"></a><!-- doxytag: member="CS_TEXTURE_CUBE_POS_Z" ref="26f2ae454cec4b4d58045effa101fa63e6bf4a8925c40f5ee91276216f773f58" args="" -->CS_TEXTURE_CUBE_POS_Z</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="26f2ae454cec4b4d58045effa101fa6340d3c51f8e26764af1384c852b4b40f5"></a><!-- doxytag: member="CS_TEXTURE_CUBE_NEG_Z" ref="26f2ae454cec4b4d58045effa101fa6340d3c51f8e26764af1384c852b4b40f5" args="" -->CS_TEXTURE_CUBE_NEG_Z</em> </td><td>
</td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="ivideo_2texture_8h-source.html#l00102">102</a> of file <a class="el" href="ivideo_2texture_8h-source.html">texture.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="6761ec16c57b70ba89dc4401fd095414"></a><!-- doxytag: member="iTextureHandle::TextureBlitDataFormat" ref="6761ec16c57b70ba89dc4401fd095414" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structiTextureHandle.html#6761ec16c57b70ba89dc4401fd095414">iTextureHandle::TextureBlitDataFormat</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Format of the pixel data that is passed to iTextureHandle-><a class="el" href="structiTextureHandle.html#dc814d2a029f9153c0bc0bd5bcbc9aca" title="Blit a memory block to this texture.">Blit()</a>.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="6761ec16c57b70ba89dc4401fd0954146146a90f722098d73f2752ad335a72a8"></a><!-- doxytag: member="RGBA8888" ref="6761ec16c57b70ba89dc4401fd0954146146a90f722098d73f2752ad335a72a8" args="" -->RGBA8888</em> </td><td>
RGBA, 8 bits per pixel. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="6761ec16c57b70ba89dc4401fd0954142f6487333942268571ffb264296a066f"></a><!-- doxytag: member="BGRA8888" ref="6761ec16c57b70ba89dc4401fd0954142f6487333942268571ffb264296a066f" args="" -->BGRA8888</em> </td><td>
BGRA, 8 bits per pixel. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="ivideo_2texture_8h-source.html#l00134">134</a> of file <a class="el" href="ivideo_2texture_8h-source.html">texture.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="dc814d2a029f9153c0bc0bd5bcbc9aca"></a><!-- doxytag: member="iTextureHandle::Blit" ref="dc814d2a029f9153c0bc0bd5bcbc9aca" args="(int x, int y, int width, int height, unsigned char const *data, TextureBlitDataFormat format=RGBA8888)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTextureHandle::Blit </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></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">unsigned char const * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiTextureHandle.html#6761ec16c57b70ba89dc4401fd095414">TextureBlitDataFormat</a> </td>
<td class="paramname"> <em>format</em> = <code>RGBA8888</code></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>
Blit a memory block to this texture.
<p>
Format of the image is determined by the <em>format</em> parameter. Row by row. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>If the specified target rectangle exceeds the texture dimensions the <a class="el" href="structiTextureHandle.html#dc814d2a029f9153c0bc0bd5bcbc9aca" title="Blit a memory block to this texture.">Blit()</a> call may have no effect. It's the responsibility of the caller to ensure that the rectangle lies completely inside the texture. </dd></dl>
</div>
</div><p>
<a class="anchor" name="72afd50341c75cc40c2da1fc0f9bbb4e"></a><!-- doxytag: member="iTextureHandle::GetAlphaMap" ref="72afd50341c75cc40c2da1fc0f9bbb4e" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iTextureHandle::GetAlphaMap </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 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>Implemented in <a class="el" href="classcsTextureHandle.html#7d434df1e7de95833ee882cf0b2e4d2a">csTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="a6a4fd4b56d5937f19af604722a22cd4"></a><!-- doxytag: member="iTextureHandle::GetAlphaType" ref="a6a4fd4b56d5937f19af604722a22cd4" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structcsAlphaMode.html#b3d92a9f20c74d102be12658acbbbe49">csAlphaMode::AlphaType</a> iTextureHandle::GetAlphaType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the type of alpha associated with the texture.
<p>
<p>Implemented in <a class="el" href="classcsTextureHandle.html#32efa8f48de50b5a3d48fd220f8579b1">csTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="ad35aa4282b4c59c40e790c499339e8f"></a><!-- doxytag: member="iTextureHandle::GetFlags" ref="ad35aa4282b4c59c40e790c499339e8f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iTextureHandle::GetFlags </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the flags set for this texture.
<p>
<p>Implemented in <a class="el" href="classcsTextureHandle.html#96bbaa6969af492f168fd8f1958097ca">csTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="5c224dfb2d50110d1b837fe8e39e0b88"></a><!-- doxytag: member="iTextureHandle::GetImageName" ref="5c224dfb2d50110d1b837fe8e39e0b88" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iTextureHandle::GetImageName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the original image name.
<p>
</div>
</div><p>
<a class="anchor" name="cfe9e382ada756fed2f2a755e89bef89"></a><!-- doxytag: member="iTextureHandle::GetKeyColor" ref="cfe9e382ada756fed2f2a755e89bef89" args="(uint8 &red, uint8 &green, uint8 &blue) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTextureHandle::GetKeyColor </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%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the key color.
<p>
<p>Implemented in <a class="el" href="classcsTextureHandle.html#33672baf483ac3c601398efd638eb8fe">csTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="52d20b447c014d36787bd22e04d9c5b7"></a><!-- doxytag: member="iTextureHandle::GetKeyColor" ref="52d20b447c014d36787bd22e04d9c5b7" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iTextureHandle::GetKeyColor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the key color status (false if disabled, true if enabled).
<p>
<p>Implemented in <a class="el" href="classcsTextureHandle.html#8895e710e4740d6ecd6b3ced18b741ce">csTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="be99b70b5af0283af51e2bd7a04368b4"></a><!-- doxytag: member="iTextureHandle::GetOriginalDimensions" ref="be99b70b5af0283af51e2bd7a04368b4" args="(int &mw, int &mh, int &md)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTextureHandle::GetOriginalDimensions </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>mw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>mh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>md</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>
Return the original dimensions of the image used to create this texture.
<p>
This is most often equal to GetMipMapDimensions (0, mw, mh, md) but in some cases the texture will have been resized in order to accomodate hardware restrictions (like power of two and maximum texture size). This function returns the uncorrected coordinates.
</div>
</div><p>
<a class="anchor" name="fa2ac6954bdeb8c99e1a1519235f9c33"></a><!-- doxytag: member="iTextureHandle::GetOriginalDimensions" ref="fa2ac6954bdeb8c99e1a1519235f9c33" args="(int &mw, int &mh)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTextureHandle::GetOriginalDimensions </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>mw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>mh</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>
Return the original dimensions of the image used to create this texture.
<p>
This is most often equal to GetMipMapDimensions (0, mw, mh) but in some cases the texture will have been resized in order to accomodate hardware restrictions (like power of two and maximum texture size). This function returns the uncorrected coordinates.
</div>
</div><p>
<a class="anchor" name="efb30308e917cd492f53ddbc5cffe671"></a><!-- doxytag: member="iTextureHandle::GetPrivateObject" ref="efb30308e917cd492f53ddbc5cffe671" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* iTextureHandle::GetPrivateObject </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 the private object associated with this handle.
<p>
For internal usage by the 3D driver.
<p>Implemented in <a class="el" href="classcsTextureHandle.html#e4727c06eba94fe0a6ddb6dd47d14fdd">csTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="e8a9690621542b96b7e1e9e3b2dfcce3"></a><!-- doxytag: member="iTextureHandle::GetRendererDimensions" ref="e8a9690621542b96b7e1e9e3b2dfcce3" args="(int &mw, int &mh, int &md)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iTextureHandle::GetRendererDimensions </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>mw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>mh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>md</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>
Get the dimensions the renderer uses for this texture.
<p>
In most cases this corresponds to the size that was used to create this texture, but some renderers have texture size limitations (like power of two) and in that case the size returned here will be the corrected size. You can get the original image size with <a class="el" href="structiTextureHandle.html#fa2ac6954bdeb8c99e1a1519235f9c33" title="Return the original dimensions of the image used to create this texture.">GetOriginalDimensions()</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Whether the renderer-used dimensions could be determined. </dd></dl>
</div>
</div><p>
<a class="anchor" name="329227bace4cb6387a254c11e36c674d"></a><!-- doxytag: member="iTextureHandle::GetRendererDimensions" ref="329227bace4cb6387a254c11e36c674d" args="(int &mw, int &mh)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iTextureHandle::GetRendererDimensions </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>mw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>mh</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>
Get the dimensions the renderer uses for this texture.
<p>
In most cases this corresponds to the size that was used to create this texture, but some renderers have texture size limitations (like power of two) and in that case the size returned here will be the corrected size. You can get the original image size with <a class="el" href="structiTextureHandle.html#fa2ac6954bdeb8c99e1a1519235f9c33" title="Return the original dimensions of the image used to create this texture.">GetOriginalDimensions()</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Whether the renderer-used dimensions could be determined. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a97e5c07fac8363ca9d43cec4925cfe5"></a><!-- doxytag: member="iTextureHandle::GetTextureClass" ref="a97e5c07fac8363ca9d43cec4925cfe5" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iTextureHandle::GetTextureClass </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 the "class" of a texture.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structiTextureHandle.html#8483e794ab875f777c0477dbdcffc6c1" title="Set the "class" of this texture.">SetTextureClass</a> </dd></dl>
<p>Implemented in <a class="el" href="classcsTextureHandle.html#f504e91c2966b8f58f66d4712376b632">csTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="c561bfec07ac72a26cfbae652612f91e"></a><!-- doxytag: member="iTextureHandle::GetTextureTarget" ref="c561bfec07ac72a26cfbae652612f91e" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iTextureHandle::GetTextureTarget </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the texture target.
<p>
Note the texture target is determined by the image from which the texture was created and possibly the texture flags.
</div>
</div><p>
<a class="anchor" name="61eac8b0b581eddceea99472fda15054"></a><!-- doxytag: member="iTextureHandle::Precache" ref="61eac8b0b581eddceea99472fda15054" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTextureHandle::Precache </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Precache this texture.
<p>
This might free up temporary memory and makes later usage of the texture faster.
</div>
</div><p>
<a class="anchor" name="09c835ee1f126786443d9fb6a67a9580"></a><!-- doxytag: member="iTextureHandle::SetAlphaType" ref="09c835ee1f126786443d9fb6a67a9580" args="(csAlphaMode::AlphaType alphaType)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTextureHandle::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> [pure 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>Implemented in <a class="el" href="classcsTextureHandle.html#d13e920aec5a534f6d070e8101996ce3">csTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="888d80cba9174c17f7fb39f319fa2599"></a><!-- doxytag: member="iTextureHandle::SetKeyColor" ref="888d80cba9174c17f7fb39f319fa2599" args="(uint8 red, uint8 green, uint8 blue)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTextureHandle::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> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the key color.
<p>
<p>Implemented in <a class="el" href="classcsTextureHandle.html#41e2f87931475675a41c630737c78f3a">csTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="d24caa35c6cb13be24f717f71e6c7a2d"></a><!-- doxytag: member="iTextureHandle::SetKeyColor" ref="d24caa35c6cb13be24f717f71e6c7a2d" args="(bool Enable)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTextureHandle::SetKeyColor </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>
Enable key color.
<p>
<p>Implemented in <a class="el" href="classcsTextureHandle.html#d2ed06e898fe5e258d70c17eb53b2ffd">csTextureHandle</a>.</p>
</div>
</div><p>
<a class="anchor" name="8483e794ab875f777c0477dbdcffc6c1"></a><!-- doxytag: member="iTextureHandle::SetTextureClass" ref="8483e794ab875f777c0477dbdcffc6c1" args="(const char *className)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTextureHandle::SetTextureClass </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>className</em> </td>
<td> ) </td>
<td width="100%"><code> [pure 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="structiTextureHandle.html#a97e5c07fac8363ca9d43cec4925cfe5" title="Get the "class" of a texture.">GetTextureClass</a> </dd></dl>
<p>Implemented in <a class="el" href="classcsTextureHandle.html#9b7194b7c16ce5f286a79bc15e71b0ad">csTextureHandle</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivideo/<a class="el" href="ivideo_2texture_8h-source.html">texture.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
>
3888
