Sophie

Sophie

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

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: csgfx/imagebase.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>csgfx/imagebase.h</h1><a href="imagebase_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">    Copyright (C) 2005 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">              (C) 2005 by Frank Richter</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="l00028"></a>00028 <span class="preprocessor">#ifndef __CS_CSGFX_IMAGEBASE_H__</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSGFX_IMAGEBASE_H__</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="util_8h.html" title="Miscellaneous utilities.">csutil/util.h</a>"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="databuf_8h.html" title="Implementation for iDataBuffer.">csutil/databuf.h</a>"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span>
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="image_8h.html" title="Image interface.">igraphic/image.h</a>"</span>
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 
<a name="l00043"></a><a class="code" href="classcsImageBase.html">00043</a> <span class="keyword">class </span><a class="code" href="classcsImageBase.html" title="Base class for iImage implementations.">csImageBase</a> :
<a name="l00044"></a>00044   <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a>&lt;csImageBase, iImage&gt;
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 <span class="keyword">protected</span>:
<a name="l00048"></a><a class="code" href="classcsImageBase.html#1dfe33d17926883d9e20159e37fb22b9">00048</a>   <span class="keywordtype">char</span>* <a class="code" href="classcsImageBase.html#1dfe33d17926883d9e20159e37fb22b9" title="Name of the image file.">fName</a>;
<a name="l00050"></a><a class="code" href="classcsImageBase.html#98ffb30a09b0dcd5df7fd2837b41c0df">00050</a>   <a class="code" href="classcsImageBase.html#98ffb30a09b0dcd5df7fd2837b41c0df" title="Create new instance.">csImageBase</a>() :
<a name="l00051"></a>00051     <a class="code" href="classscfImplementation1.html">scfImplementationType</a>(this, 0), <a class="code" href="classcsImageBase.html#1dfe33d17926883d9e20159e37fb22b9" title="Name of the image file.">fName</a>(0)
<a name="l00052"></a>00052   { }
<a name="l00053"></a>00053 <span class="keyword">public</span>:
<a name="l00054"></a><a class="code" href="classcsImageBase.html#695988f549ed7e4cbe7ce8174821533c">00054</a>   <span class="keyword">virtual</span> <a class="code" href="classcsImageBase.html#695988f549ed7e4cbe7ce8174821533c">~csImageBase</a>() { <span class="keyword">delete</span>[] <a class="code" href="classcsImageBase.html#1dfe33d17926883d9e20159e37fb22b9" title="Name of the image file.">fName</a>; }
<a name="l00055"></a>00055 
<a name="l00056"></a>00056   <span class="comment">/* Commented out: should be implemented by all descendants.</span>
<a name="l00057"></a>00057 <span class="comment">  virtual const void *GetImageData () { return 0; }</span>
<a name="l00058"></a>00058 <span class="comment">  virtual int GetWidth () const { return 0; }</span>
<a name="l00059"></a>00059 <span class="comment">  virtual int GetHeight () const { return 0; }</span>
<a name="l00060"></a>00060 <span class="comment">  */</span>
<a name="l00061"></a>00061   <span class="comment">// Most images are 2D, so provide a sensible default</span>
<a name="l00062"></a><a class="code" href="classcsImageBase.html#05356f886e5dcb7866294515bf31ed38">00062</a>   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classcsImageBase.html#05356f886e5dcb7866294515bf31ed38" title="Query image depth (only sensible when the image type is csimg3D).">GetDepth</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }
<a name="l00063"></a>00063 
<a name="l00064"></a><a class="code" href="classcsImageBase.html#0f830f7221167e2c6094ec8e06e07cab">00064</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcsImageBase.html#0f830f7221167e2c6094ec8e06e07cab" title="Set image file name.">SetName</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName)
<a name="l00065"></a>00065   {
<a name="l00066"></a>00066     <span class="keyword">delete</span>[] <a class="code" href="classcsImageBase.html#1dfe33d17926883d9e20159e37fb22b9" title="Name of the image file.">fName</a>; <a class="code" href="classcsImageBase.html#1dfe33d17926883d9e20159e37fb22b9" title="Name of the image file.">fName</a> = <a class="code" href="group__util.html#gc3a6e34ea28a22fdeda8802c872ce2d0" title="Allocate a new char [] and copy the string into the newly allocated storage.">csStrNew</a> (iName);
<a name="l00067"></a>00067   }
<a name="l00068"></a><a class="code" href="classcsImageBase.html#cffe6abf869943c09d67a06f62f706e6">00068</a>   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classcsImageBase.html#cffe6abf869943c09d67a06f62f706e6" title="Get image file name.">GetName</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classcsImageBase.html#1dfe33d17926883d9e20159e37fb22b9" title="Name of the image file.">fName</a>; }
<a name="l00069"></a>00069 
<a name="l00070"></a>00070   <span class="comment">/* Commented out: should be implemented by all descendants.</span>
<a name="l00071"></a>00071 <span class="comment">  virtual int GetFormat () const { return 0; }</span>
<a name="l00072"></a>00072 <span class="comment">  */</span>
<a name="l00073"></a><a class="code" href="classcsImageBase.html#b5259fde6544f4ebf4fd6200a75c5efa">00073</a>   <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a>* <a class="code" href="classcsImageBase.html#b5259fde6544f4ebf4fd6200a75c5efa" title="Get image palette (or 0 if no palette).">GetPalette</a> () { <span class="keywordflow">return</span> 0; }
<a name="l00074"></a><a class="code" href="classcsImageBase.html#9088e2e94fb55125292f8bd2e6b71d83">00074</a>   <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a>* <a class="code" href="classcsImageBase.html#9088e2e94fb55125292f8bd2e6b71d83" title="Get alpha map for 8-bit paletted image.">GetAlpha</a> () { <span class="keywordflow">return</span> 0; }
<a name="l00075"></a>00075 
<a name="l00076"></a><a class="code" href="classcsImageBase.html#0074d236d0bf6c41c5bd71cf471f6506">00076</a>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classcsImageBase.html#0074d236d0bf6c41c5bd71cf471f6506" title="Check if image has a keycolour stored with it.">HasKeyColor</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }
<a name="l00077"></a>00077 
<a name="l00078"></a><a class="code" href="classcsImageBase.html#3b394ea924569d578b6b8a7392159b56">00078</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcsImageBase.html#3b394ea924569d578b6b8a7392159b56" title="Get the keycolour stored with the image.">GetKeyColor</a> (<span class="keywordtype">int</span> &amp; <span class="comment">/*r*/</span>, <span class="keywordtype">int</span> &amp; <span class="comment">/*g*/</span>, <span class="keywordtype">int</span> &amp; <span class="comment">/*b*/</span>)<span class="keyword"> const </span>{ }
<a name="l00079"></a>00079 
<a name="l00080"></a><a class="code" href="classcsImageBase.html#828abaf036fd86f5be6ababdda0933d2">00080</a>   <span class="keyword">virtual</span> <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> <a class="code" href="classcsImageBase.html#828abaf036fd86f5be6ababdda0933d2" title="Returns the number of mipmaps contained in the image (in case there exist any precalculated...">HasMipmaps</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }
<a name="l00081"></a><a class="code" href="classcsImageBase.html#65885bfc9872abbc3850437037ddadf7">00081</a>   <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iImage&gt;</a> <a class="code" href="classcsImageBase.html#65885bfc9872abbc3850437037ddadf7" title="Return a precomputed mipmap.">GetMipmap</a> (<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> num) 
<a name="l00082"></a>00082   { <span class="keywordflow">return</span> (num == 0) ? <span class="keyword">this</span> : 0; }
<a name="l00083"></a>00083 
<a name="l00084"></a><a class="code" href="classcsImageBase.html#bf6f47e3e0c7b6f19f08526abf082b0d">00084</a>   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classcsImageBase.html#bf6f47e3e0c7b6f19f08526abf082b0d" title="Get a string identifying the format of the raw data of the image (or 0 if raw data...">GetRawFormat</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }
<a name="l00085"></a><a class="code" href="classcsImageBase.html#09cc932884c2812f381df27d2a4d29d4">00085</a>   <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iDataBuffer&gt;</a> <a class="code" href="classcsImageBase.html#09cc932884c2812f381df27d2a4d29d4" title="Get the raw data of the image (or 0 if raw data is not provided).">GetRawData</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }
<a name="l00086"></a><a class="code" href="classcsImageBase.html#851e69042d59791db1276e4daa1280e5">00086</a>   <span class="keyword">virtual</span> <a class="code" href="group__gfx2d.html#ge62190ffec24a286b2d4b50dcb899469" title="Type of an image.">csImageType</a> <a class="code" href="classcsImageBase.html#851e69042d59791db1276e4daa1280e5" title="Get the type of the contained image.">GetImageType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="group__gfx2d.html#gge62190ffec24a286b2d4b50dcb899469bf9c914f4bc9a6d12c118773e1a97740" title="2D image. Nothing special.">csimg2D</a>; }
<a name="l00087"></a><a class="code" href="classcsImageBase.html#cd8a764af200c94c351677087d66d28e">00087</a>   <span class="keyword">virtual</span> <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> <a class="code" href="classcsImageBase.html#cd8a764af200c94c351677087d66d28e" title="Returns the number of sub images, in addition to this image.">HasSubImages</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }
<a name="l00088"></a><a class="code" href="classcsImageBase.html#1c9b0cac6e4263c30ea2ef9b2483ac39">00088</a>   <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef&lt;iImage&gt;</a> <a class="code" href="classcsImageBase.html#1c9b0cac6e4263c30ea2ef9b2483ac39" title="Query a sub image.">GetSubImage</a> (<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> num) 
<a name="l00089"></a>00089   { <span class="keywordflow">return</span> (num == 0) ? <span class="keyword">this</span> : 0; }
<a name="l00090"></a>00090 };
<a name="l00091"></a>00091 
<a name="l00094"></a>00094 <span class="preprocessor">#endif // __CS_CSGFX_IMAGEBASE_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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional