Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1365

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: cstool/cspixmap.h Source File (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&nbsp;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><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>cstool/cspixmap.h</h1><a href="cspixmap_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Crystal Space 3D engine: 2D pixmaps</span>
<a name="l00003"></a>00003 <span class="comment">    Copyright (C) 1998,1999 by Andrew Zabolotny &lt;bit@eltech.ru&gt;</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_CSPIXMAP_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSPIXMAP_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="ref_8h.html" title="Smart Pointers.">csutil/ref.h</a>"</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="keyword">struct </span><a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>;
<a name="l00032"></a>00032 <span class="keyword">struct </span><a class="code" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a>;
<a name="l00033"></a>00033 
<a name="l00041"></a><a class="code" href="classcsPixmap.html">00041</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a>
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <span class="keyword">public</span>:
<a name="l00045"></a><a class="code" href="classcsPixmap.html#2f1ddb8edb618964eb76383dc9c6d44e">00045</a>   <span class="keyword">virtual</span> ~<a class="code" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a>() {}
<a name="l00046"></a>00046 
<a name="l00048"></a>00048   <span class="keyword">virtual</span> <span class="keywordtype">int</span> Width() = 0;
<a name="l00050"></a>00050   <span class="keyword">virtual</span> <span class="keywordtype">int</span> Height() = 0;
<a name="l00052"></a>00052   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Advance(<a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> ElapsedTime) = 0;
<a name="l00054"></a>00054   <span class="keyword">virtual</span> <a class="code" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> *GetTextureHandle() = 0;
<a name="l00055"></a>00055 
<a name="l00057"></a>00057   <span class="keyword">virtual</span> <span class="keywordtype">void</span> DrawScaled (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <span class="keywordtype">int</span> sx, <span class="keywordtype">int</span> sy, <span class="keywordtype">int</span> sw, <span class="keywordtype">int</span> sh,
<a name="l00058"></a>00058     <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> Alpha = 0) = 0;
<a name="l00060"></a><a class="code" href="classcsPixmap.html#310561d6f996aefa887293b81c4b7871">00060</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> DrawScaledAlign (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <span class="keywordtype">int</span> sx, <span class="keywordtype">int</span> sy, <span class="keywordtype">int</span> sw,
<a name="l00061"></a>00061       <span class="keywordtype">int</span> sh, <span class="keywordtype">int</span> alnx, <span class="keywordtype">int</span> alny, <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> Alpha = 0)
<a name="l00062"></a>00062     { DrawScaled (g3d, sx - alnx * sw / 2, sy - alny * sh / 2, sw, sh, Alpha); }
<a name="l00064"></a><a class="code" href="classcsPixmap.html#579791125905822ad70b5603c8602c55">00064</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Draw (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <span class="keywordtype">int</span> sx, <span class="keywordtype">int</span> sy, <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> Alpha = 0)
<a name="l00065"></a>00065     { DrawScaled (g3d, sx, sy, Width(), Height(), Alpha); }
<a name="l00067"></a><a class="code" href="classcsPixmap.html#f6336ebecbb49259d8f83116bb8d675d">00067</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> DrawAlign (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <span class="keywordtype">int</span> sx, <span class="keywordtype">int</span> sy, <span class="keywordtype">int</span> alnx, <span class="keywordtype">int</span> alny,
<a name="l00068"></a>00068       <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> Alpha = 0)
<a name="l00069"></a>00069     { DrawScaledAlign (g3d, sx, sy, Width(), Height(), alnx, alny, Alpha); }
<a name="l00070"></a>00070 
<a name="l00077"></a>00077   <span class="keyword">virtual</span> <span class="keywordtype">void</span> DrawTiled (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <span class="keywordtype">int</span> sx, <span class="keywordtype">int</span> sy, <span class="keywordtype">int</span> sw, <span class="keywordtype">int</span> sh,
<a name="l00078"></a>00078     <span class="keywordtype">int</span> orgx, <span class="keywordtype">int</span> orgy, <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> Alpha = 0) = 0;
<a name="l00080"></a><a class="code" href="classcsPixmap.html#7720201b8e5315939c2d83be6094ec1d">00080</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> DrawTiled (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <span class="keywordtype">int</span> sx, <span class="keywordtype">int</span> sy, <span class="keywordtype">int</span> w, <span class="keywordtype">int</span> h,
<a name="l00081"></a>00081       <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> Alpha = 0)
<a name="l00082"></a>00082   { DrawTiled (g3d, sx, sy, w, h, sx, sy, Alpha); }
<a name="l00083"></a>00083 };
<a name="l00084"></a>00084 
<a name="l00086"></a><a class="code" href="classcsSimplePixmap.html">00086</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsSimplePixmap.html" title="This is the simple implementation of csPixmap that uses a single texture.">csSimplePixmap</a> : <span class="keyword">public</span> <a class="code" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a>
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088 <span class="keyword">protected</span>:
<a name="l00089"></a><a class="code" href="classcsSimplePixmap.html#4aaaabb841125a5517b42f18f5f27ac9">00089</a>   <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iTextureHandle&gt;</a> hTex;
<a name="l00090"></a><a class="code" href="classcsSimplePixmap.html#d655f3b3b6c928616afe8cb4d4492f75">00090</a>   <span class="keywordtype">int</span> tx, ty, tw, th;
<a name="l00091"></a>00091 
<a name="l00092"></a>00092 <span class="keyword">public</span>:
<a name="l00094"></a>00094   <a class="code" href="classcsSimplePixmap.html" title="This is the simple implementation of csPixmap that uses a single texture.">csSimplePixmap</a> (<a class="code" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> *hTexture);
<a name="l00096"></a>00096   <a class="code" href="classcsSimplePixmap.html" title="This is the simple implementation of csPixmap that uses a single texture.">csSimplePixmap</a> (<a class="code" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> *hTexture, <span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> w, <span class="keywordtype">int</span> h);
<a name="l00098"></a>00098   <span class="keyword">virtual</span> ~<a class="code" href="classcsSimplePixmap.html" title="This is the simple implementation of csPixmap that uses a single texture.">csSimplePixmap</a> ();
<a name="l00099"></a>00099 
<a name="l00101"></a>00101   <span class="keywordtype">void</span> SetTextureHandle (<a class="code" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> *hTexture);
<a name="l00103"></a><a class="code" href="classcsSimplePixmap.html#7cdeed3377b5a47c4203bcb120118611">00103</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> SetTextureRectangle (<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> w, <span class="keywordtype">int</span> h)
<a name="l00104"></a>00104   { tx = x; ty = y; tw = w; th = h; }
<a name="l00105"></a>00105 
<a name="l00106"></a>00106   <span class="comment">// implementation of csPixmap methods</span>
<a name="l00107"></a>00107   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcsPixmap.html#c51483cf186f7cb94700edbbcb8c77fe" title="Draw the pixmap given the screen position and new size.">DrawScaled</a> (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <span class="keywordtype">int</span> sx, <span class="keywordtype">int</span> sy, <span class="keywordtype">int</span> sw, <span class="keywordtype">int</span> sh,
<a name="l00108"></a>00108     <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> Alpha = 0);
<a name="l00109"></a>00109   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcsPixmap.html#18bafca32fff1ca7270db8da54d8dee0" title="Draw the pixmap tiled over an area.">DrawTiled</a> (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <span class="keywordtype">int</span> sx, <span class="keywordtype">int</span> sy, <span class="keywordtype">int</span> sw, <span class="keywordtype">int</span> sh,
<a name="l00110"></a>00110     <span class="keywordtype">int</span> orgx, <span class="keywordtype">int</span> orgy, <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> Alpha = 0);
<a name="l00111"></a>00111   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classcsPixmap.html#eca74d9a08f365f7d0d91a7416413be6" title="return current width of this pixmap">Width</a> ();
<a name="l00112"></a>00112   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classcsPixmap.html#adf2b381eab0d686b80bf2576fd4d3fa" title="return current height of this pixmap">Height</a> ();
<a name="l00113"></a><a class="code" href="classcsSimplePixmap.html#6eca6af461604c09a441649ab7bb8a18">00113</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcsPixmap.html#4320d55b7a6541c2520a64511df3ce0e" title="advance in time">Advance</a>(<a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> <span class="comment">/*ElapsedTime*/</span>) {}
<a name="l00114"></a>00114   <span class="keyword">virtual</span> <a class="code" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> *<a class="code" href="classcsPixmap.html#fb18943f75e61dda86a73b0b5b52ebf9" title="return current texture handle">GetTextureHandle</a> ();
<a name="l00115"></a>00115 };
<a name="l00116"></a>00116 
<a name="l00117"></a>00117 <span class="preprocessor">#endif // __CS_CSPIXMAP_H__</span>
</pre></div><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>