<html>
<head>
<title>Ogre::Image class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::Image Class Reference</h1>Class representing an image file.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>></code>
<p>
<a href="classOgre_1_1Image-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea0">Image</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Standard constructor.</em> <a href="#Ogre_1_1Imagea0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea1">Image</a> (const Image &img)</td></tr>
<tr><td> </td><td><font size=-1><em>Copy-constructor - copies all the data from the target image.</em> <a href="#Ogre_1_1Imagea1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea2">~Image</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Standard destructor.</em> <a href="#Ogre_1_1Imagea2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>Image & </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea3">operator=</a> (const Image &img)</td></tr>
<tr><td> </td><td><font size=-1><em>Assignment operator- copies all the data from the target image.</em> <a href="#Ogre_1_1Imagea3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>Image & </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea4">flipAroundY</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Flips (mirrors) the image around the Y-axis.</em> <a href="#Ogre_1_1Imagea4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>Image & </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea5">flipAroundX</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Flips (mirrors) the image around the X-axis.</em> <a href="#Ogre_1_1Imagea5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>Image & </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea6">loadRawData</a> (const <a class="el" href="classOgre_1_1DataChunk.html">DataChunk</a> &pData, <a class="el" href="namespaceOgre.html#a351">ushort</a> uWidth, <a class="el" href="namespaceOgre.html#a351">ushort</a> uHeight, <a class="el" href="namespaceOgre.html#a623">PixelFormat</a> eFormat)</td></tr>
<tr><td> </td><td><font size=-1><em>Loads raw data from memory.</em> <a href="#Ogre_1_1Imagea6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>Image & </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea7">load</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &strFileName)</td></tr>
<tr><td> </td><td><font size=-1><em>Loads an image file.</em> <a href="#Ogre_1_1Imagea7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>Image & </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea8">load</a> (const <a class="el" href="classOgre_1_1DataChunk.html">DataChunk</a> &chunk, const <a class="el" href="classOgre_1_1String.html">String</a> &type)</td></tr>
<tr><td> </td><td><font size=-1><em>Loads an image file from a chunk of memory.</em> <a href="#Ogre_1_1Imagea8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a350">uchar</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea9">getData</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns a pointer to the internal image buffer.</em> <a href="#Ogre_1_1Imagea9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a350">uchar</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea10">getData</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns a const pointer to the internal image buffer.</em> <a href="#Ogre_1_1Imagea10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea11">getSize</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the size of the data buffer.</em> <a href="#Ogre_1_1Imagea11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>unsigned short </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea12">getNumMipmaps</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the number of mipmaps contained in the image.</em> <a href="#Ogre_1_1Imagea12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea13">hasFlag</a> (const <a class="el" href="namespaceOgre.html#a632">ImageFlags</a> imgFlag)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns true if the image has the appropriate flag set.</em> <a href="#Ogre_1_1Imagea13"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a351">ushort</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea14">getWidth</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the width of the image in pixels.</em> <a href="#Ogre_1_1Imagea14"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a351">ushort</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea15">getHeight</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the height of the image in pixels.</em> <a href="#Ogre_1_1Imagea15"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a351">ushort</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea16">getDepth</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the depth of the image.</em> <a href="#Ogre_1_1Imagea16"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a351">ushort</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea17">getRowSpan</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the physical width in bytes of each row of pixels.</em> <a href="#Ogre_1_1Imagea17"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a623">PixelFormat</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea18">getFormat</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the image format.</em> <a href="#Ogre_1_1Imagea18"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a350">uchar</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea19">getBPP</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the number of bits per pixel.</em> <a href="#Ogre_1_1Imagea19"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea20">getHasAlpha</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns true if the image has an alpha component.</em> <a href="#Ogre_1_1Imagea20"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a350">uchar</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imaged0">PF2PS</a> (<a class="el" href="namespaceOgre.html#a623">PixelFormat</a> format)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a350">uchar</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imaged1">getNumElemBytes</a> (<a class="el" href="namespaceOgre.html#a623">PixelFormat</a> format)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the size in bytes of an element of the given pixel format.</em> <a href="#Ogre_1_1Imaged1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a350">uchar</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imaged2">PF2BPP</a> (<a class="el" href="namespaceOgre.html#a623">PixelFormat</a> format)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a350">uchar</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imaged3">getNumElemBits</a> (<a class="el" href="namespaceOgre.html#a623">PixelFormat</a> format)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the size in bits of an element of the given pixel format.</em> <a href="#Ogre_1_1Imaged3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imaged4">convReqsFlip</a> (<a class="el" href="namespaceOgre.html#a623">PixelFormat</a> srcformat, <a class="el" href="namespaceOgre.html#a623">PixelFormat</a> destformat)</td></tr>
<tr><td> </td><td><font size=-1><em>Decides wether converting from a pixel format to another requires endian-flipping.</em> <a href="#Ogre_1_1Imaged4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imaged5">applyGamma</a> (<a class="el" href="namespaceOgre.html#a350">uchar</a> *buffer, <a class="el" href="namespaceOgre.html#a349">Real</a> gamma, size_t size, <a class="el" href="namespaceOgre.html#a350">uchar</a> bpp)</td></tr>
<tr><td> </td><td><font size=-1><em>Does gamma adjustment.</em> <a href="#Ogre_1_1Imaged5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imaged6">formatHasAlpha</a> (<a class="el" href="namespaceOgre.html#a623">PixelFormat</a> format)</td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a351">ushort</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imageo0">m_uWidth</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a351">ushort</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imageo1">m_uHeight</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a351">ushort</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imageo2">m_uDepth</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a352">uint</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imageo3">m_uSize</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a351">ushort</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imageo4">m_uNumMipmaps</a></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imageo5">m_uFlags</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a623">PixelFormat</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imageo6">m_eFormat</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a350">uchar</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imageo7">m_ucPixelSize</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a350">uchar</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imageo8">m_pBuffer</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class representing an image file.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
The <a class="el" href="classOgre_1_1Image.html">Image</a> class usually holds uncompressed image data and is the only object that can be loaded in a texture. <a class="el" href="classOgre_1_1Image.html">Image</a> objects handle image data decoding themselves by the means of locating the correct <a class="el" href="classOgre_1_1Codec.html">Codec</a> object for each data type.
<p>
Typically, you would want to use an <a class="el" href="classOgre_1_1Image.html">Image</a> object to load a texture when extra processing needs to be done on an image before it is loaded or when you want to blit to an existing texture. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00051">51</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1Imagea0" doxytag="Ogre::Image::Image"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::Image::Image </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Standard constructor.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00036">36</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imagea1" doxytag="Ogre::Image::Image"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::Image::Image </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const Image & </td>
<td class="mdname1" valign="top" nowrap> <em>img</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Copy-constructor - copies all the data from the target image.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00046">46</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imagea2" doxytag="Ogre::Image::~Image"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::Image::~Image </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Standard destructor.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00053">53</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00417">m_pBuffer</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1Imaged5" doxytag="Ogre::Image::applyGamma"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::Image::applyGamma </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a350">uchar</a> * </td>
<td class="mdname" nowrap> <em>buffer</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>gamma</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>size</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a350">uchar</a> </td>
<td class="mdname" nowrap> <em>bpp</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Does gamma adjustment.
<p>
<dl compact><dt><b>
Note: </b><dd>
Basic algo taken from Titan Engine, copyright (c) 2000 Ignacio Castano Iguado </dl> </td>
</tr>
</table>
<a name="Ogre_1_1Imaged4" doxytag="Ogre::Image::convReqsFlip"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::Image::convReqsFlip </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a623">PixelFormat</a> </td>
<td class="mdname" nowrap> <em>srcformat</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a623">PixelFormat</a> </td>
<td class="mdname" nowrap> <em>destformat</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Decides wether converting from a pixel format to another requires endian-flipping.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>srcformat</em> </td><td>
The source pixel format. </td></tr>
<tr><td valign=top><em>destformat</em> </td><td>
The destination pixel format. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
true if the conversion requires flipping, false otherwise. See Remarks. </dl><dl compact><dt><b>
Remarks: </b><dd>
If one of the two pixel formats is FMT_UNKNOWN or is not registered, no assumption can be made for the returned value. </dl>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00255">255</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
References <a class="el" href="namespaceOgre.html#a623a113">Ogre::PF_A2R10G10B10</a>, <a class="el" href="namespaceOgre.html#a623a103">Ogre::PF_A4L4</a>, <a class="el" href="namespaceOgre.html#a623a107">Ogre::PF_A4R4G4B4</a>, <a class="el" href="namespaceOgre.html#a623a111">Ogre::PF_A8R8G8B8</a>, <a class="el" href="namespaceOgre.html#a623a105">Ogre::PF_R5G6B5</a>, <a class="el" href="namespaceOgre.html#a623a109">Ogre::PF_R8G8B8</a>, <a class="el" href="OgreCommon_8h-source.html#l00170">Ogre::PixelFormat</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imagea5" doxytag="Ogre::Image::flipAroundX"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Image & Ogre::Image::flipAroundX </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Flips (mirrors) the image around the X-axis.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
An example of an original and flipped image: <pre>
flip axis
|
originalimg|gmilanigiro
00000000000|00000000000
00000000000|00000000000
00000000000|00000000000
00000000000|00000000000
00000000000|00000000000
</pre> </dl>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00175">175</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreException_8h-source.html#l00033">Except</a>, <a class="el" href="OgreImage_8h-source.html#l00417">m_pBuffer</a>, <a class="el" href="OgreImage_8h-source.html#l00416">m_ucPixelSize</a>, <a class="el" href="OgreImage_8h-source.html#l00402">m_uHeight</a>, <a class="el" href="OgreImage_8h-source.html#l00400">m_uWidth</a>, <a class="el" href="OgreException_8h-source.html#l00039">OgreGuard</a>, <a class="el" href="OgreException_8h-source.html#l00045">OgreUnguardRet</a>, <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00115">Ogre::ushort</a>.
<p>
Referenced by <a class="el" href="OgreWin32Window_8cpp-source.html#l00282">Ogre::Win32Window::writeContentsToFile</a>(), and <a class="el" href="OgreSDLWindow_8cpp-source.html#l00141">Ogre::SDLWindow::writeContentsToFile</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea4" doxytag="Ogre::Image::flipAroundY"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Image & Ogre::Image::flipAroundY </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Flips (mirrors) the image around the Y-axis.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
An example of an original and flipped image: <pre>
originalimg
00000000000
00000000000
00000000000
00000000000
00000000000
------------> flip axis
00000000000
00000000000
00000000000
00000000000
00000000000
originalimg
</pre> </dl>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00081">81</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreException_8h-source.html#l00033">Except</a>, <a class="el" href="OgreImage_8h-source.html#l00417">m_pBuffer</a>, <a class="el" href="OgreImage_8h-source.html#l00402">m_uHeight</a>, <a class="el" href="OgreImage_8h-source.html#l00400">m_uWidth</a>, <a class="el" href="OgreException_8h-source.html#l00039">OgreGuard</a>, <a class="el" href="OgreException_8h-source.html#l00045">OgreUnguardRet</a>, <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>, <a class="el" href="OgrePrerequisites_8h-source.html#l00116">Ogre::uint</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00115">Ogre::ushort</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imaged6" doxytag="Ogre::Image::formatHasAlpha"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::Image::formatHasAlpha </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a623">PixelFormat</a> </td>
<td class="mdname1" valign="top" nowrap> <em>format</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00404">404</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="namespaceOgre.html#a623a113">Ogre::PF_A2R10G10B10</a>, <a class="el" href="namespaceOgre.html#a623a103">Ogre::PF_A4L4</a>, <a class="el" href="namespaceOgre.html#a623a107">Ogre::PF_A4R4G4B4</a>, <a class="el" href="namespaceOgre.html#a623a102">Ogre::PF_A8</a>, <a class="el" href="namespaceOgre.html#a623a111">Ogre::PF_A8R8G8B8</a>, <a class="el" href="namespaceOgre.html#a623a114">Ogre::PF_B10G10R10A2</a>, <a class="el" href="namespaceOgre.html#a623a108">Ogre::PF_B4G4R4A4</a>, <a class="el" href="namespaceOgre.html#a623a106">Ogre::PF_B5G6R5</a>, <a class="el" href="namespaceOgre.html#a623a110">Ogre::PF_B8G8R8</a>, <a class="el" href="namespaceOgre.html#a623a112">Ogre::PF_B8G8R8A8</a>, <a class="el" href="namespaceOgre.html#a623a104">Ogre::PF_L4A4</a>, <a class="el" href="namespaceOgre.html#a623a101">Ogre::PF_L8</a>, <a class="el" href="namespaceOgre.html#a623a105">Ogre::PF_R5G6B5</a>, <a class="el" href="namespaceOgre.html#a623a109">Ogre::PF_R8G8B8</a>, <a class="el" href="namespaceOgre.html#a623a100">Ogre::PF_UNKNOWN</a>, and <a class="el" href="OgreCommon_8h-source.html#l00170">Ogre::PixelFormat</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imagea19" doxytag="Ogre::Image::getBPP"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a350">uchar</a> Ogre::Image::getBPP </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the number of bits per pixel.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00393">393</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00416">m_ucPixelSize</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>.
<p>
Referenced by <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00264">Ogre::D3D9Texture::_loadCubeTex</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00269">Ogre::D3DTexture::blitImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00457">Ogre::D3DTexture::blitImage3D</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00196">Ogre::D3D9Texture::loadImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00702">Ogre::D3DTexture::loadImage</a>(), and <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00742">Ogre::D3DTexture::loadImage3D</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea10" doxytag="Ogre::Image::getData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a350">uchar</a>* Ogre::Image::getData </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a const pointer to the internal image buffer.
<p>
</td>
</tr>
</table>
<a name="Ogre_1_1Imagea9" doxytag="Ogre::Image::getData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a350">uchar</a> * Ogre::Image::getData </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a pointer to the internal image buffer.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00326">326</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00417">m_pBuffer</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>.
<p>
Referenced by <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00063">Ogre::ColourImageAffector::_affectParticles</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l01063">Ogre::D3D9Texture::_blitImagesToCubeTex</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00956">Ogre::D3D9Texture::_blitImageToNormTex</a>(), <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00051">Ogre::ColourImageAffector::_initParticle</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00269">Ogre::D3DTexture::blitImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00457">Ogre::D3DTexture::blitImage3D</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00137">Ogre::GLTexture::blitToTexture</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00292">Ogre::GLTexture::load</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00196">Ogre::D3D9Texture::loadImage</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00155">Ogre::GLTexture::rescaleNPower2</a>(), <a class="el" href="OgreWin32Window_8cpp-source.html#l00282">Ogre::Win32Window::writeContentsToFile</a>(), and <a class="el" href="OgreSDLWindow_8cpp-source.html#l00141">Ogre::SDLWindow::writeContentsToFile</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea16" doxytag="Ogre::Image::getDepth"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a351">ushort</a> Ogre::Image::getDepth </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the depth of the image.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00364">364</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00404">m_uDepth</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00115">Ogre::ushort</a>.
<p>
Referenced by <a class="el" href="OgreGLTexture_8cpp-source.html#l00292">Ogre::GLTexture::load</a>(), and <a class="el" href="OgreGLTexture_8cpp-source.html#l00207">Ogre::GLTexture::loadImages</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea18" doxytag="Ogre::Image::getFormat"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a623">PixelFormat</a> Ogre::Image::getFormat </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the image format.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00387">387</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00413">m_eFormat</a>, and <a class="el" href="OgreCommon_8h-source.html#l00170">Ogre::PixelFormat</a>.
<p>
Referenced by <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00956">Ogre::D3D9Texture::_blitImageToNormTex</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00292">Ogre::GLTexture::load</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00196">Ogre::D3D9Texture::loadImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00702">Ogre::D3DTexture::loadImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00742">Ogre::D3DTexture::loadImage3D</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00207">Ogre::GLTexture::loadImages</a>(), <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00109">Ogre::ColourImageAffector::setImageAdjust</a>(), and <a class="el" href="OgreTerrainSceneManager_8cpp-source.html#l00048">Ogre::TerrainSceneManager::setWorldGeometry</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea20" doxytag="Ogre::Image::getHasAlpha"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::Image::getHasAlpha </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns true if the image has an alpha component.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00399">399</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00413">m_eFormat</a>.
<p>
Referenced by <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00269">Ogre::D3DTexture::blitImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00457">Ogre::D3DTexture::blitImage3D</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00702">Ogre::D3DTexture::loadImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00742">Ogre::D3DTexture::loadImage3D</a>(), and <a class="el" href="OgreGLTexture_8cpp-source.html#l00207">Ogre::GLTexture::loadImages</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea15" doxytag="Ogre::Image::getHeight"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a351">ushort</a> Ogre::Image::getHeight </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the height of the image in pixels.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00375">375</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00402">m_uHeight</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00115">Ogre::ushort</a>.
<p>
Referenced by <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00063">Ogre::ColourImageAffector::_affectParticles</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l01063">Ogre::D3D9Texture::_blitImagesToCubeTex</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00956">Ogre::D3D9Texture::_blitImageToNormTex</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00269">Ogre::D3DTexture::blitImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00457">Ogre::D3DTexture::blitImage3D</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00137">Ogre::GLTexture::blitToTexture</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00261">Ogre::D3DTexture::blitToTexture</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00292">Ogre::GLTexture::load</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00196">Ogre::D3D9Texture::loadImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00702">Ogre::D3DTexture::loadImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00742">Ogre::D3DTexture::loadImage3D</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00207">Ogre::GLTexture::loadImages</a>(), and <a class="el" href="OgreTerrainSceneManager_8cpp-source.html#l00048">Ogre::TerrainSceneManager::setWorldGeometry</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imaged3" doxytag="Ogre::Image::getNumElemBits"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a350">uchar</a> Ogre::Image::getNumElemBits </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a623">PixelFormat</a> </td>
<td class="mdname1" valign="top" nowrap> <em>format</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the size in bits of an element of the given pixel format.
<p>
<dl compact><dt><b>
Returns: </b><dd>
The size in bits of an element. See Remarks. </dl><dl compact><dt><b>
Remarks: </b><dd>
Passing PF_UNKNOWN will result in returning a size of 0 bits while passing an unregistered pixel format will result in returning a size of 256 bits. </dl>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00209">209</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
References <a class="el" href="namespaceOgre.html#a623a113">Ogre::PF_A2R10G10B10</a>, <a class="el" href="namespaceOgre.html#a623a103">Ogre::PF_A4L4</a>, <a class="el" href="namespaceOgre.html#a623a107">Ogre::PF_A4R4G4B4</a>, <a class="el" href="namespaceOgre.html#a623a102">Ogre::PF_A8</a>, <a class="el" href="namespaceOgre.html#a623a111">Ogre::PF_A8R8G8B8</a>, <a class="el" href="namespaceOgre.html#a623a114">Ogre::PF_B10G10R10A2</a>, <a class="el" href="namespaceOgre.html#a623a108">Ogre::PF_B4G4R4A4</a>, <a class="el" href="namespaceOgre.html#a623a106">Ogre::PF_B5G6R5</a>, <a class="el" href="namespaceOgre.html#a623a110">Ogre::PF_B8G8R8</a>, <a class="el" href="namespaceOgre.html#a623a112">Ogre::PF_B8G8R8A8</a>, <a class="el" href="namespaceOgre.html#a623a115">Ogre::PF_DXT1</a>, <a class="el" href="namespaceOgre.html#a623a116">Ogre::PF_DXT2</a>, <a class="el" href="namespaceOgre.html#a623a117">Ogre::PF_DXT3</a>, <a class="el" href="namespaceOgre.html#a623a118">Ogre::PF_DXT4</a>, <a class="el" href="namespaceOgre.html#a623a119">Ogre::PF_DXT5</a>, <a class="el" href="namespaceOgre.html#a623a104">Ogre::PF_L4A4</a>, <a class="el" href="namespaceOgre.html#a623a101">Ogre::PF_L8</a>, <a class="el" href="namespaceOgre.html#a623a105">Ogre::PF_R5G6B5</a>, <a class="el" href="namespaceOgre.html#a623a109">Ogre::PF_R8G8B8</a>, <a class="el" href="namespaceOgre.html#a623a100">Ogre::PF_UNKNOWN</a>, <a class="el" href="OgreCommon_8h-source.html#l00170">Ogre::PixelFormat</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imaged1" doxytag="Ogre::Image::getNumElemBytes"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a350">uchar</a> Ogre::Image::getNumElemBytes </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a623">PixelFormat</a> </td>
<td class="mdname1" valign="top" nowrap> <em>format</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the size in bytes of an element of the given pixel format.
<p>
<dl compact><dt><b>
Returns: </b><dd>
The size in bytes of an element. See Remarks. </dl><dl compact><dt><b>
Remarks: </b><dd>
Passing PF_UNKNOWN will result in returning a size of 0 bytes while passing an unregistered pixel format will result in returning a size of 256 bytes. </dl>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00157">157</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
References <a class="el" href="namespaceOgre.html#a623a113">Ogre::PF_A2R10G10B10</a>, <a class="el" href="namespaceOgre.html#a623a103">Ogre::PF_A4L4</a>, <a class="el" href="namespaceOgre.html#a623a107">Ogre::PF_A4R4G4B4</a>, <a class="el" href="namespaceOgre.html#a623a102">Ogre::PF_A8</a>, <a class="el" href="namespaceOgre.html#a623a111">Ogre::PF_A8R8G8B8</a>, <a class="el" href="namespaceOgre.html#a623a114">Ogre::PF_B10G10R10A2</a>, <a class="el" href="namespaceOgre.html#a623a108">Ogre::PF_B4G4R4A4</a>, <a class="el" href="namespaceOgre.html#a623a106">Ogre::PF_B5G6R5</a>, <a class="el" href="namespaceOgre.html#a623a110">Ogre::PF_B8G8R8</a>, <a class="el" href="namespaceOgre.html#a623a112">Ogre::PF_B8G8R8A8</a>, <a class="el" href="namespaceOgre.html#a623a104">Ogre::PF_L4A4</a>, <a class="el" href="namespaceOgre.html#a623a101">Ogre::PF_L8</a>, <a class="el" href="namespaceOgre.html#a623a105">Ogre::PF_R5G6B5</a>, <a class="el" href="namespaceOgre.html#a623a109">Ogre::PF_R8G8B8</a>, <a class="el" href="namespaceOgre.html#a623a100">Ogre::PF_UNKNOWN</a>, <a class="el" href="OgreCommon_8h-source.html#l00170">Ogre::PixelFormat</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imagea12" doxytag="Ogre::Image::getNumMipmaps"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned short Ogre::Image::getNumMipmaps </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the number of mipmaps contained in the image.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00345">345</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00408">m_uNumMipmaps</a>.
<p>
Referenced by <a class="el" href="OgreGLTexture_8cpp-source.html#l00207">Ogre::GLTexture::loadImages</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea17" doxytag="Ogre::Image::getRowSpan"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a351">ushort</a> Ogre::Image::getRowSpan </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the physical width in bytes of each row of pixels.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00381">381</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00416">m_ucPixelSize</a>, <a class="el" href="OgreImage_8h-source.html#l00400">m_uWidth</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00115">Ogre::ushort</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imagea11" doxytag="Ogre::Image::getSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> size_t Ogre::Image::getSize </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the size of the data buffer.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00339">339</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00406">m_uSize</a>.
<p>
Referenced by <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00264">Ogre::D3D9Texture::_loadCubeTex</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00269">Ogre::D3DTexture::blitImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00457">Ogre::D3DTexture::blitImage3D</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00292">Ogre::GLTexture::load</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00196">Ogre::D3D9Texture::loadImage</a>(), and <a class="el" href="OgreGLTexture_8cpp-source.html#l00155">Ogre::GLTexture::rescaleNPower2</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea14" doxytag="Ogre::Image::getWidth"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a351">ushort</a> Ogre::Image::getWidth </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the width of the image in pixels.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00369">369</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00400">m_uWidth</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00115">Ogre::ushort</a>.
<p>
Referenced by <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00063">Ogre::ColourImageAffector::_affectParticles</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l01063">Ogre::D3D9Texture::_blitImagesToCubeTex</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00956">Ogre::D3D9Texture::_blitImageToNormTex</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00269">Ogre::D3DTexture::blitImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00457">Ogre::D3DTexture::blitImage3D</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00137">Ogre::GLTexture::blitToTexture</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00261">Ogre::D3DTexture::blitToTexture</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00292">Ogre::GLTexture::load</a>(), <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00196">Ogre::D3D9Texture::loadImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00702">Ogre::D3DTexture::loadImage</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00742">Ogre::D3DTexture::loadImage3D</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00207">Ogre::GLTexture::loadImages</a>(), and <a class="el" href="OgreTerrainSceneManager_8cpp-source.html#l00048">Ogre::TerrainSceneManager::setWorldGeometry</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea13" doxytag="Ogre::Image::hasFlag"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::Image::hasFlag </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a632">ImageFlags</a> </td>
<td class="mdname1" valign="top" nowrap> <em>imgFlag</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns true if the image has the appropriate flag set.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00351">351</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00034">Ogre::ImageFlags</a>, and <a class="el" href="OgreImage_8h-source.html#l00410">m_uFlags</a>.
<p>
Referenced by <a class="el" href="OgreGLTexture_8cpp-source.html#l00292">Ogre::GLTexture::load</a>(), and <a class="el" href="OgreGLTexture_8cpp-source.html#l00207">Ogre::GLTexture::loadImages</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea8" doxytag="Ogre::Image::load"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Image & Ogre::Image::load </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1DataChunk.html">DataChunk</a> & </td>
<td class="mdname" nowrap> <em>chunk</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>type</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Loads an image file from a chunk of memory.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This method works in the same way as the filename-based load method except it loads the image from a <a class="el" href="classOgre_1_1DataChunk.html">DataChunk</a> object, ie a chunk of memory. This <a class="el" href="classOgre_1_1DataChunk.html">DataChunk</a> is expected to contain the encoded data as it would be held in a file.
<p>
This method is here to support loading from compressed archives where you decompress the data from the archive into memory first. This method will then decode the data and return a raw image data stream. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>chunk</em> </td><td>
The source data. </td></tr>
<tr><td valign=top><em>type</em> </td><td>
The type of the image. Used to decide what decompression codec to use. </td></tr>
</table>
</dl><dl compact><dt><b>
See also: </b><dd>
<a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea7">Image::load</a>( const String& strFileName ) </dl>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00289">289</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1Codeca2">Ogre::Codec::decode</a>(), <a class="el" href="OgreImageCodec_8h-source.html#l00049">Ogre::ImageCodec::ImageData::depth</a>, <a class="el" href="OgreException_8h-source.html#l00033">Except</a>, <a class="el" href="OgreImageCodec_8h-source.html#l00051">Ogre::ImageCodec::ImageData::flags</a>, <a class="el" href="OgreImageCodec_8h-source.html#l00053">Ogre::ImageCodec::ImageData::format</a>, <a class="el" href="OgreDataChunk_8cpp-source.html#l00083">Ogre::DataChunk::getPtr</a>(), <a class="el" href="OgreImageCodec_8h-source.html#l00046">Ogre::ImageCodec::ImageData::height</a>, <a class="el" href="OgreImage_8h-source.html#l00413">m_eFormat</a>, <a class="el" href="OgreImage_8h-source.html#l00417">m_pBuffer</a>, <a class="el" href="OgreImage_8h-source.html#l00416">m_ucPixelSize</a>, <a class="el" href="OgreImage_8h-source.html#l00404">m_uDepth</a>, <a class="el" href="OgreImage_8h-source.html#l00410">m_uFlags</a>, <a class="el" href="OgreImage_8h-source.html#l00402">m_uHeight</a>, <a class="el" href="OgreImage_8h-source.html#l00408">m_uNumMipmaps</a>, <a class="el" href="OgreImage_8h-source.html#l00406">m_uSize</a>, <a class="el" href="OgreImage_8h-source.html#l00400">m_uWidth</a>, <a class="el" href="OgreImageCodec_8h-source.html#l00050">Ogre::ImageCodec::ImageData::num_mipmaps</a>, <a class="el" href="OgreException_8h-source.html#l00039">OgreGuard</a>, <a class="el" href="OgreException_8h-source.html#l00045">OgreUnguardRet</a>, <a class="el" href="OgreImage_8h-source.html#l00144">PF2PS</a>(), <a class="el" href="OgreImageCodec_8h-source.html#l00048">Ogre::ImageCodec::ImageData::size</a>, and <a class="el" href="OgreImageCodec_8h-source.html#l00047">Ogre::ImageCodec::ImageData::width</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imagea7" doxytag="Ogre::Image::load"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Image & Ogre::Image::load </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>strFileName</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Loads an image file.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This method loads an image into memory held in the object. The pixel format will be either greyscale or RGB with an optional Alpha component. The type can be determined by calling <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea18">getFormat</a>(). </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>strFileName</em> </td><td>
Name of a file file to load. </td></tr>
</table>
</dl><dl compact><dt><b>
Note: </b><dd>
The memory associated with this buffer is destroyed with the <a class="el" href="classOgre_1_1Image.html">Image</a> object. </dl>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00226">226</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1Codeca2">Ogre::Codec::decode</a>(), <a class="el" href="OgreImageCodec_8h-source.html#l00049">Ogre::ImageCodec::ImageData::depth</a>, <a class="el" href="OgreException_8h-source.html#l00033">Except</a>, <a class="el" href="OgreImageCodec_8h-source.html#l00051">Ogre::ImageCodec::ImageData::flags</a>, <a class="el" href="OgreImageCodec_8h-source.html#l00053">Ogre::ImageCodec::ImageData::format</a>, <a class="el" href="OgreDataChunk_8cpp-source.html#l00083">Ogre::DataChunk::getPtr</a>(), <a class="el" href="OgreImageCodec_8h-source.html#l00046">Ogre::ImageCodec::ImageData::height</a>, <a class="el" href="OgreImage_8h-source.html#l00413">m_eFormat</a>, <a class="el" href="OgreImage_8h-source.html#l00417">m_pBuffer</a>, <a class="el" href="OgreImage_8h-source.html#l00416">m_ucPixelSize</a>, <a class="el" href="OgreImage_8h-source.html#l00404">m_uDepth</a>, <a class="el" href="OgreImage_8h-source.html#l00410">m_uFlags</a>, <a class="el" href="OgreImage_8h-source.html#l00402">m_uHeight</a>, <a class="el" href="OgreImage_8h-source.html#l00408">m_uNumMipmaps</a>, <a class="el" href="OgreImage_8h-source.html#l00406">m_uSize</a>, <a class="el" href="OgreImage_8h-source.html#l00400">m_uWidth</a>, <a class="el" href="OgreImageCodec_8h-source.html#l00050">Ogre::ImageCodec::ImageData::num_mipmaps</a>, <a class="el" href="OgreException_8h-source.html#l00039">OgreGuard</a>, <a class="el" href="OgreException_8h-source.html#l00045">OgreUnguardRet</a>, <a class="el" href="OgreImage_8h-source.html#l00144">PF2PS</a>(), <a class="el" href="OgreImageCodec_8h-source.html#l00048">Ogre::ImageCodec::ImageData::size</a>, and <a class="el" href="OgreImageCodec_8h-source.html#l00047">Ogre::ImageCodec::ImageData::width</a>.
<p>
Referenced by <a class="el" href="OgreD3D9Texture_8cpp-source.html#l00264">Ogre::D3D9Texture::_loadCubeTex</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00292">Ogre::GLTexture::load</a>(), <a class="el" href="OgreD3D7Texture_8cpp-source.html#l00782">Ogre::D3DTexture::load</a>(), <a class="el" href="OgreColourImageAffector_8cpp-source.html#l00109">Ogre::ColourImageAffector::setImageAdjust</a>(), and <a class="el" href="OgreTerrainSceneManager_8cpp-source.html#l00048">Ogre::TerrainSceneManager::setWorldGeometry</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea6" doxytag="Ogre::Image::loadRawData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Image & Ogre::Image::loadRawData </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1DataChunk.html">DataChunk</a> & </td>
<td class="mdname" nowrap> <em>pData</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a351">ushort</a> </td>
<td class="mdname" nowrap> <em>uWidth</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a351">ushort</a> </td>
<td class="mdname" nowrap> <em>uHeight</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a623">PixelFormat</a> </td>
<td class="mdname" nowrap> <em>eFormat</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Loads raw data from memory.
<p>
The pixel format has to be specified.
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00206">206</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreDataChunk_8cpp-source.html#l00083">Ogre::DataChunk::getPtr</a>(), <a class="el" href="OgreImage_8h-source.html#l00413">m_eFormat</a>, <a class="el" href="OgreImage_8h-source.html#l00417">m_pBuffer</a>, <a class="el" href="OgreImage_8h-source.html#l00416">m_ucPixelSize</a>, <a class="el" href="OgreImage_8h-source.html#l00402">m_uHeight</a>, <a class="el" href="OgreImage_8h-source.html#l00406">m_uSize</a>, <a class="el" href="OgreImage_8h-source.html#l00400">m_uWidth</a>, <a class="el" href="OgreException_8h-source.html#l00039">OgreGuard</a>, <a class="el" href="OgreException_8h-source.html#l00045">OgreUnguardRet</a>, <a class="el" href="OgreImage_8h-source.html#l00144">PF2PS</a>(), <a class="el" href="OgreCommon_8h-source.html#l00170">Ogre::PixelFormat</a>, <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00115">Ogre::ushort</a>.
<p>
Referenced by <a class="el" href="OgreFont_8cpp-source.html#l00191">Ogre::Font::createTextureFromFont</a>(), <a class="el" href="OgreQuake3Level_8cpp-source.html#l00156">Ogre::Quake3Level::extractLightmaps</a>(), <a class="el" href="OgreGLTexture_8cpp-source.html#l00292">Ogre::GLTexture::load</a>(), <a class="el" href="OgreTexture_8cpp-source.html#l00031">Ogre::Texture::loadRawData</a>(), <a class="el" href="OgreWin32Window_8cpp-source.html#l00282">Ogre::Win32Window::writeContentsToFile</a>(), and <a class="el" href="OgreSDLWindow_8cpp-source.html#l00141">Ogre::SDLWindow::writeContentsToFile</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imagea3" doxytag="Ogre::Image::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Image & Ogre::Image::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const Image & </td>
<td class="mdname1" valign="top" nowrap> <em>img</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Assignment operator- copies all the data from the target image.
<p>
<p>
Definition at line <a class="el" href="OgreImage_8cpp-source.html#l00063">63</a> of file <a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a>.
<p>
References <a class="el" href="OgreImage_8h-source.html#l00413">m_eFormat</a>, <a class="el" href="OgreImage_8h-source.html#l00417">m_pBuffer</a>, <a class="el" href="OgreImage_8h-source.html#l00416">m_ucPixelSize</a>, <a class="el" href="OgreImage_8h-source.html#l00404">m_uDepth</a>, <a class="el" href="OgreImage_8h-source.html#l00410">m_uFlags</a>, <a class="el" href="OgreImage_8h-source.html#l00402">m_uHeight</a>, <a class="el" href="OgreImage_8h-source.html#l00408">m_uNumMipmaps</a>, <a class="el" href="OgreImage_8h-source.html#l00406">m_uSize</a>, <a class="el" href="OgreImage_8h-source.html#l00400">m_uWidth</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imaged2" doxytag="Ogre::Image::PF2BPP"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a350">uchar</a> Ogre::Image::PF2BPP </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a623">PixelFormat</a> </td>
<td class="mdname1" valign="top" nowrap> <em>format</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>
Deprecated: </b><dd>
Use getNumElemBits instead. </dl>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00196">196</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
References <a class="el" href="OgreCommon_8h-source.html#l00170">Ogre::PixelFormat</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Imaged0" doxytag="Ogre::Image::PF2PS"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a350">uchar</a> Ogre::Image::PF2PS </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a623">PixelFormat</a> </td>
<td class="mdname1" valign="top" nowrap> <em>format</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>
Deprecated: </b><dd>
Use getNumElemBytes instead. </dl>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00144">144</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
References <a class="el" href="OgreCommon_8h-source.html#l00170">Ogre::PixelFormat</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>.
<p>
Referenced by <a class="el" href="OgreImage_8cpp-source.html#l00226">load</a>(), and <a class="el" href="OgreImage_8cpp-source.html#l00206">loadRawData</a>(). </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1Imageo6" doxytag="Ogre::Image::m_eFormat"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a623">PixelFormat</a> Ogre::Image::m_eFormat<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00413">413</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
Referenced by <a class="el" href="OgreImage_8cpp-source.html#l00387">getFormat</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00399">getHasAlpha</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00226">load</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00206">loadRawData</a>(), and <a class="el" href="OgreImage_8cpp-source.html#l00063">operator=</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imageo8" doxytag="Ogre::Image::m_pBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a350">uchar</a>* Ogre::Image::m_pBuffer<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00417">417</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
Referenced by <a class="el" href="OgreImage_8cpp-source.html#l00175">flipAroundX</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00081">flipAroundY</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00326">getData</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00226">load</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00206">loadRawData</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00063">operator=</a>(), and <a class="el" href="OgreImage_8cpp-source.html#l00053">~Image</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imageo7" doxytag="Ogre::Image::m_ucPixelSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a350">uchar</a> Ogre::Image::m_ucPixelSize<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00416">416</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
Referenced by <a class="el" href="OgreImage_8cpp-source.html#l00175">flipAroundX</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00393">getBPP</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00381">getRowSpan</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00226">load</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00206">loadRawData</a>(), and <a class="el" href="OgreImage_8cpp-source.html#l00063">operator=</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imageo2" doxytag="Ogre::Image::m_uDepth"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a351">ushort</a> Ogre::Image::m_uDepth<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00404">404</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
Referenced by <a class="el" href="OgreImage_8cpp-source.html#l00364">getDepth</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00226">load</a>(), and <a class="el" href="OgreImage_8cpp-source.html#l00063">operator=</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imageo5" doxytag="Ogre::Image::m_uFlags"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::Image::m_uFlags<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00410">410</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
Referenced by <a class="el" href="OgreImage_8cpp-source.html#l00351">hasFlag</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00226">load</a>(), and <a class="el" href="OgreImage_8cpp-source.html#l00063">operator=</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imageo1" doxytag="Ogre::Image::m_uHeight"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a351">ushort</a> Ogre::Image::m_uHeight<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00402">402</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
Referenced by <a class="el" href="OgreImage_8cpp-source.html#l00175">flipAroundX</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00081">flipAroundY</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00375">getHeight</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00226">load</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00206">loadRawData</a>(), and <a class="el" href="OgreImage_8cpp-source.html#l00063">operator=</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imageo4" doxytag="Ogre::Image::m_uNumMipmaps"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a351">ushort</a> Ogre::Image::m_uNumMipmaps<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00408">408</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
Referenced by <a class="el" href="OgreImage_8cpp-source.html#l00345">getNumMipmaps</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00226">load</a>(), and <a class="el" href="OgreImage_8cpp-source.html#l00063">operator=</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imageo3" doxytag="Ogre::Image::m_uSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a352">uint</a> Ogre::Image::m_uSize<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00406">406</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
Referenced by <a class="el" href="OgreImage_8cpp-source.html#l00339">getSize</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00226">load</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00206">loadRawData</a>(), and <a class="el" href="OgreImage_8cpp-source.html#l00063">operator=</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Imageo0" doxytag="Ogre::Image::m_uWidth"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a351">ushort</a> Ogre::Image::m_uWidth<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreImage_8h-source.html#l00400">400</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
<p>
Referenced by <a class="el" href="OgreImage_8cpp-source.html#l00175">flipAroundX</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00081">flipAroundY</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00381">getRowSpan</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00369">getWidth</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00226">load</a>(), <a class="el" href="OgreImage_8cpp-source.html#l00206">loadRawData</a>(), and <a class="el" href="OgreImage_8cpp-source.html#l00063">operator=</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreImage_8h-source.html">OgreImage.h</a><li><a class="el" href="OgreImage_8cpp-source.html">OgreImage.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:17:55 2004
</p>
</body>
</html>
