source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1Image.html @ 657

Revision 657, 75.4 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::Image class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::Image Class Reference</h1>Class representing an image file. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1Image-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="structOgre_1_1Box.html">Ogre::Box</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew0">Box</a></td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="structOgre_1_1Rect.html">Ogre::Rect</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew1">Rect</a></td></tr>
21
22<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8">Filter</a> { <br>
23&nbsp;&nbsp;<a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8Ogre_1_1Imagew2">FILTER_NEAREST</a>,
24<a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8Ogre_1_1Imagew3">FILTER_LINEAR</a>,
25<a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8Ogre_1_1Imagew4">FILTER_BILINEAR</a>,
26<a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8Ogre_1_1Imagew5">FILTER_BOX</a>,
27<br>
28&nbsp;&nbsp;<a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8Ogre_1_1Imagew6">FILTER_TRIANGLE</a>,
29<a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8Ogre_1_1Imagew7">FILTER_BICUBIC</a>
30<br>
31 }</td></tr>
32
33<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea0">Image</a> ()</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Standard constructor.  <a href="#Ogre_1_1Imagea0"></a><br><br></td></tr>
37<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea1">Image</a> (const <a class="el" href="classOgre_1_1Image.html">Image</a> &amp;img)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy-constructor - copies all the data from the target image.  <a href="#Ogre_1_1Imagea1"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea2">~Image</a> ()</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Standard destructor.  <a href="#Ogre_1_1Imagea2"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea3">operator=</a> (const <a class="el" href="classOgre_1_1Image.html">Image</a> &amp;img)</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator - copies all the data from the target image.  <a href="#Ogre_1_1Imagea3"></a><br><br></td></tr>
46<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea4">flipAroundY</a> ()</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flips (mirrors) the image around the Y-axis.  <a href="#Ogre_1_1Imagea4"></a><br><br></td></tr>
49<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea5">flipAroundX</a> ()</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flips (mirrors) the image around the X-axis.  <a href="#Ogre_1_1Imagea5"></a><br><br></td></tr>
52<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea6">Image::loadDynamicImage</a> (<a class="el" href="namespaceOgre.html#a421">uchar</a> *pData, size_t uWidth, size_t uHeight, size_t depth, <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> eFormat, bool autoDelete=false, size_t numFaces=1, size_t numMipMaps=0)</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stores a pointer to raw data in memory.  <a href="#Ogre_1_1Imagea6"></a><br><br></td></tr>
55<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea7">loadDynamicImage</a> (<a class="el" href="namespaceOgre.html#a421">uchar</a> *pData, size_t uWidth, size_t uHeight, <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> eFormat)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stores a pointer to raw data in memory.  <a href="#Ogre_1_1Imagea7"></a><br><br></td></tr>
58<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea8">loadRawData</a> (<a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;stream, size_t uWidth, size_t uHeight, size_t uDepth, <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> eFormat, size_t numFaces=1, size_t numMipMaps=0)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads raw data from a stream.  <a href="#Ogre_1_1Imagea8"></a><br><br></td></tr>
61<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea9">loadRawData</a> (<a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;stream, size_t uWidth, size_t uHeight, <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> eFormat)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads raw data from a stream.  <a href="#Ogre_1_1Imagea9"></a><br><br></td></tr>
64<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea10">load</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;strFileName, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;groupName)</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads an image file.  <a href="#Ogre_1_1Imagea10"></a><br><br></td></tr>
67<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea11">load</a> (<a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;stream, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;type)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads an image file from a stream.  <a href="#Ogre_1_1Imagea11"></a><br><br></td></tr>
70<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea12">save</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;filename)</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save the image as a file.  <a href="#Ogre_1_1Imagea12"></a><br><br></td></tr>
73<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a421">uchar</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea13">getData</a> (void)</td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a pointer to the internal image buffer.  <a href="#Ogre_1_1Imagea13"></a><br><br></td></tr>
76<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a421">uchar</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea14">getData</a> () const </td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a const pointer to the internal image buffer.  <a href="#Ogre_1_1Imagea14"></a><br><br></td></tr>
79<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea15">getSize</a> () const </td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the size of the data buffer.  <a href="#Ogre_1_1Imagea15"></a><br><br></td></tr>
82<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea16">getNumMipmaps</a> () const </td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of mipmaps contained in the image.  <a href="#Ogre_1_1Imagea16"></a><br><br></td></tr>
85<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea17">hasFlag</a> (const <a class="el" href="namespaceOgre.html#a657">ImageFlags</a> imgFlag) const </td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the image has the appropriate flag set.  <a href="#Ogre_1_1Imagea17"></a><br><br></td></tr>
88<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea18">getWidth</a> (void) const </td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the width of the image in pixels.  <a href="#Ogre_1_1Imagea18"></a><br><br></td></tr>
91<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea19">getHeight</a> (void) const </td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the height of the image in pixels.  <a href="#Ogre_1_1Imagea19"></a><br><br></td></tr>
94<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea20">getDepth</a> (void) const </td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the depth of the image.  <a href="#Ogre_1_1Imagea20"></a><br><br></td></tr>
97<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea21">getNumFaces</a> (void) const </td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the numer of faces of the image.  <a href="#Ogre_1_1Imagea21"></a><br><br></td></tr>
100<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea22">getRowSpan</a> (void) const </td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the physical width in bytes of each row of pixels.  <a href="#Ogre_1_1Imagea22"></a><br><br></td></tr>
103<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea23">getFormat</a> () const </td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the image format.  <a href="#Ogre_1_1Imagea23"></a><br><br></td></tr>
106<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a421">uchar</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea24">getBPP</a> () const </td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of bits per pixel.  <a href="#Ogre_1_1Imagea24"></a><br><br></td></tr>
109<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea25">getHasAlpha</a> () const </td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the image has an alpha component.  <a href="#Ogre_1_1Imagea25"></a><br><br></td></tr>
112<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea26">getColourAt</a> (int x, int y, int z)</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get colour value from a certain location in the image.  <a href="#Ogre_1_1Imagea26"></a><br><br></td></tr>
115<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea27">getPixelBox</a> (size_t face=0, size_t mipmap=0) const </td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> encapsulating the image data of a mipmap.  <a href="#Ogre_1_1Imagea27"></a><br><br></td></tr>
118<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea28">resize</a> (<a class="el" href="namespaceOgre.html#a422">ushort</a> width, <a class="el" href="namespaceOgre.html#a422">ushort</a> height, <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8">Filter</a> filter=FILTER_BILINEAR)</td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resize a 2D image, applying the appropriate filter.  <a href="#Ogre_1_1Imagea28"></a><br><br></td></tr>
121<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
122<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagee0">applyGamma</a> (<a class="el" href="namespaceOgre.html#a421">uchar</a> *buffer, <a class="el" href="namespaceOgre.html#a420">Real</a> gamma, size_t size, <a class="el" href="namespaceOgre.html#a421">uchar</a> bpp)</td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Does gamma adjustment.  <a href="#Ogre_1_1Imagee0"></a><br><br></td></tr>
125<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagee1">scale</a> (const <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;src, const <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;dst, <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8">Filter</a> filter=FILTER_BILINEAR)</td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Scale a 1D, 2D or 3D image volume.  <a href="#Ogre_1_1Imagee1"></a><br><br></td></tr>
128<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagee2">calculateSize</a> (size_t mipmaps, size_t faces, size_t width, size_t height, size_t depth, <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> format)</td></tr>
129
130<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
131<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager0">m_uWidth</a></td></tr>
132
133<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager1">m_uHeight</a></td></tr>
134
135<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager2">m_uDepth</a></td></tr>
136
137<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager3">m_uSize</a></td></tr>
138
139<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager4">m_uNumMipmaps</a></td></tr>
140
141<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager5">m_uFlags</a></td></tr>
142
143<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager6">m_eFormat</a></td></tr>
144
145<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a421">uchar</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager7">m_ucPixelSize</a></td></tr>
146
147<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a421">uchar</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager8">m_pBuffer</a></td></tr>
148
149<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager9">m_bAutoDelete</a></td></tr>
150
151</table>
152<hr><a name="_details"></a><h2>Detailed Description</h2>
153Class representing an image file.
154<p>
155<dl compact><dt><b>Remarks:</b></dt><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. </dd></dl>
156<dl compact><dt><b></b></dt><dd>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. </dd></dl>
157
158<p>
159
160<p>
161Definition at line <a class="el" href="OgreImage_8h-source.html#l00052">52</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.<hr><h2>Member Typedef Documentation</h2>
162<a class="anchor" name="Ogre_1_1Imagew0" doxytag="Ogre::Image::Box" ></a><p>
163<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
164  <tr>
165    <td class="mdRow">
166      <table cellpadding="0" cellspacing="0" border="0">
167        <tr>
168          <td class="md" nowrap valign="top"> typedef <a class="el" href="structOgre_1_1Box.html">Ogre::Box</a> <a class="el" href="structOgre_1_1Box.html">Ogre::Image::Box</a>
169      </table>
170    </td>
171  </tr>
172</table>
173<table cellspacing=5 cellpadding=0 border=0>
174  <tr>
175    <td>
176      &nbsp;
177    </td>
178    <td>
179
180<p>
181
182<p>
183Definition at line <a class="el" href="OgreImage_8h-source.html#l00055">55</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
184  </tr>
185</table>
186<a class="anchor" name="Ogre_1_1Imagew1" doxytag="Ogre::Image::Rect" ></a><p>
187<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
188  <tr>
189    <td class="mdRow">
190      <table cellpadding="0" cellspacing="0" border="0">
191        <tr>
192          <td class="md" nowrap valign="top"> typedef <a class="el" href="structOgre_1_1Rect.html">Ogre::Rect</a> <a class="el" href="structOgre_1_1Rect.html">Ogre::Image::Rect</a>
193      </table>
194    </td>
195  </tr>
196</table>
197<table cellspacing=5 cellpadding=0 border=0>
198  <tr>
199    <td>
200      &nbsp;
201    </td>
202    <td>
203
204<p>
205
206<p>
207Definition at line <a class="el" href="OgreImage_8h-source.html#l00056">56</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
208  </tr>
209</table>
210<hr><h2>Member Enumeration Documentation</h2>
211<a class="anchor" name="Ogre_1_1Imagew8" doxytag="Ogre::Image::Filter" ></a><p>
212<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
213  <tr>
214    <td class="mdRow">
215      <table cellpadding="0" cellspacing="0" border="0">
216        <tr>
217          <td class="md" nowrap valign="top"> enum <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8">Ogre::Image::Filter</a>
218      </table>
219    </td>
220  </tr>
221</table>
222<table cellspacing=5 cellpadding=0 border=0>
223  <tr>
224    <td>
225      &nbsp;
226    </td>
227    <td>
228
229<p>
230<dl compact><dt><b>Enumeration values: </b></dt><dd>
231<table border=0 cellspacing=2 cellpadding=0>
232<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Imagew8Ogre_1_1Imagew2" doxytag="FILTER_NEAREST" ></a>FILTER_NEAREST</em>&nbsp;</td><td>
233</td></tr>
234<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Imagew8Ogre_1_1Imagew3" doxytag="FILTER_LINEAR" ></a>FILTER_LINEAR</em>&nbsp;</td><td>
235</td></tr>
236<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Imagew8Ogre_1_1Imagew4" doxytag="FILTER_BILINEAR" ></a>FILTER_BILINEAR</em>&nbsp;</td><td>
237</td></tr>
238<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Imagew8Ogre_1_1Imagew5" doxytag="FILTER_BOX" ></a>FILTER_BOX</em>&nbsp;</td><td>
239</td></tr>
240<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Imagew8Ogre_1_1Imagew6" doxytag="FILTER_TRIANGLE" ></a>FILTER_TRIANGLE</em>&nbsp;</td><td>
241</td></tr>
242<tr><td valign=top><em><a class="anchor" name="Ogre_1_1Imagew8Ogre_1_1Imagew7" doxytag="FILTER_BICUBIC" ></a>FILTER_BICUBIC</em>&nbsp;</td><td>
243</td></tr>
244</table>
245</dl>
246
247<p>
248Definition at line <a class="el" href="OgreImage_8h-source.html#l00300">300</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
249  </tr>
250</table>
251<hr><h2>Constructor &amp; Destructor Documentation</h2>
252<a class="anchor" name="Ogre_1_1Imagea0" doxytag="Ogre::Image::Image" ></a><p>
253<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
254  <tr>
255    <td class="mdRow">
256      <table cellpadding="0" cellspacing="0" border="0">
257        <tr>
258          <td class="md" nowrap valign="top"> Ogre::Image::Image </td>
259          <td class="md" valign="top">(&nbsp;</td>
260          <td class="mdname1" valign="top" nowrap>          </td>
261          <td class="md" valign="top">&nbsp;)&nbsp;</td>
262          <td class="md" nowrap></td>
263        </tr>
264
265      </table>
266    </td>
267  </tr>
268</table>
269<table cellspacing=5 cellpadding=0 border=0>
270  <tr>
271    <td>
272      &nbsp;
273    </td>
274    <td>
275
276<p>
277Standard constructor.
278<p>
279    </td>
280  </tr>
281</table>
282<a class="anchor" name="Ogre_1_1Imagea1" doxytag="Ogre::Image::Image" ></a><p>
283<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
284  <tr>
285    <td class="mdRow">
286      <table cellpadding="0" cellspacing="0" border="0">
287        <tr>
288          <td class="md" nowrap valign="top"> Ogre::Image::Image </td>
289          <td class="md" valign="top">(&nbsp;</td>
290          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td>
291          <td class="mdname1" valign="top" nowrap> <em>img</em>          </td>
292          <td class="md" valign="top">&nbsp;)&nbsp;</td>
293          <td class="md" nowrap></td>
294        </tr>
295
296      </table>
297    </td>
298  </tr>
299</table>
300<table cellspacing=5 cellpadding=0 border=0>
301  <tr>
302    <td>
303      &nbsp;
304    </td>
305    <td>
306
307<p>
308Copy-constructor - copies all the data from the target image.
309<p>
310    </td>
311  </tr>
312</table>
313<a class="anchor" name="Ogre_1_1Imagea2" doxytag="Ogre::Image::~Image" ></a><p>
314<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
315  <tr>
316    <td class="mdRow">
317      <table cellpadding="0" cellspacing="0" border="0">
318        <tr>
319          <td class="md" nowrap valign="top"> virtual Ogre::Image::~<a class="el" href="classOgre_1_1Image.html">Image</a> </td>
320          <td class="md" valign="top">(&nbsp;</td>
321          <td class="mdname1" valign="top" nowrap>          </td>
322          <td class="md" valign="top">&nbsp;)&nbsp;</td>
323          <td class="md" nowrap><code> [virtual]</code></td>
324        </tr>
325
326      </table>
327    </td>
328  </tr>
329</table>
330<table cellspacing=5 cellpadding=0 border=0>
331  <tr>
332    <td>
333      &nbsp;
334    </td>
335    <td>
336
337<p>
338Standard destructor.
339<p>
340    </td>
341  </tr>
342</table>
343<hr><h2>Member Function Documentation</h2>
344<a class="anchor" name="Ogre_1_1Imagee0" doxytag="Ogre::Image::applyGamma" ></a><p>
345<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
346  <tr>
347    <td class="mdRow">
348      <table cellpadding="0" cellspacing="0" border="0">
349        <tr>
350          <td class="md" nowrap valign="top"> void Ogre::Image::applyGamma </td>
351          <td class="md" valign="top">(&nbsp;</td>
352          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a421">uchar</a> *&nbsp;</td>
353          <td class="mdname" nowrap> <em>buffer</em>, </td>
354        </tr>
355        <tr>
356          <td class="md" nowrap align="right"></td>
357          <td></td>
358          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
359          <td class="mdname" nowrap> <em>gamma</em>, </td>
360        </tr>
361        <tr>
362          <td class="md" nowrap align="right"></td>
363          <td></td>
364          <td class="md" nowrap>size_t&nbsp;</td>
365          <td class="mdname" nowrap> <em>size</em>, </td>
366        </tr>
367        <tr>
368          <td class="md" nowrap align="right"></td>
369          <td></td>
370          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a421">uchar</a>&nbsp;</td>
371          <td class="mdname" nowrap> <em>bpp</em></td>
372        </tr>
373        <tr>
374          <td></td>
375          <td class="md">)&nbsp;</td>
376          <td class="md" colspan="2"><code> [static]</code></td>
377        </tr>
378
379      </table>
380    </td>
381  </tr>
382</table>
383<table cellspacing=5 cellpadding=0 border=0>
384  <tr>
385    <td>
386      &nbsp;
387    </td>
388    <td>
389
390<p>
391Does gamma adjustment.
392<p>
393<dl compact><dt><b>Note:</b></dt><dd>Basic algo taken from Titan Engine, copyright (c) 2000 Ignacio Castano Iguado </dd></dl>
394    </td>
395  </tr>
396</table>
397<a class="anchor" name="Ogre_1_1Imagee2" doxytag="Ogre::Image::calculateSize" ></a><p>
398<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
399  <tr>
400    <td class="mdRow">
401      <table cellpadding="0" cellspacing="0" border="0">
402        <tr>
403          <td class="md" nowrap valign="top"> size_t Ogre::Image::calculateSize </td>
404          <td class="md" valign="top">(&nbsp;</td>
405          <td class="md" nowrap valign="top">size_t&nbsp;</td>
406          <td class="mdname" nowrap> <em>mipmaps</em>, </td>
407        </tr>
408        <tr>
409          <td class="md" nowrap align="right"></td>
410          <td></td>
411          <td class="md" nowrap>size_t&nbsp;</td>
412          <td class="mdname" nowrap> <em>faces</em>, </td>
413        </tr>
414        <tr>
415          <td class="md" nowrap align="right"></td>
416          <td></td>
417          <td class="md" nowrap>size_t&nbsp;</td>
418          <td class="mdname" nowrap> <em>width</em>, </td>
419        </tr>
420        <tr>
421          <td class="md" nowrap align="right"></td>
422          <td></td>
423          <td class="md" nowrap>size_t&nbsp;</td>
424          <td class="mdname" nowrap> <em>height</em>, </td>
425        </tr>
426        <tr>
427          <td class="md" nowrap align="right"></td>
428          <td></td>
429          <td class="md" nowrap>size_t&nbsp;</td>
430          <td class="mdname" nowrap> <em>depth</em>, </td>
431        </tr>
432        <tr>
433          <td class="md" nowrap align="right"></td>
434          <td></td>
435          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
436          <td class="mdname" nowrap> <em>format</em></td>
437        </tr>
438        <tr>
439          <td></td>
440          <td class="md">)&nbsp;</td>
441          <td class="md" colspan="2"><code> [static]</code></td>
442        </tr>
443
444      </table>
445    </td>
446  </tr>
447</table>
448<table cellspacing=5 cellpadding=0 border=0>
449  <tr>
450    <td>
451      &nbsp;
452    </td>
453    <td>
454
455<p>
456    </td>
457  </tr>
458</table>
459<a class="anchor" name="Ogre_1_1Imagea5" doxytag="Ogre::Image::flipAroundX" ></a><p>
460<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
461  <tr>
462    <td class="mdRow">
463      <table cellpadding="0" cellspacing="0" border="0">
464        <tr>
465          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Image.html">Image</a>&amp; Ogre::Image::flipAroundX </td>
466          <td class="md" valign="top">(&nbsp;</td>
467          <td class="mdname1" valign="top" nowrap>          </td>
468          <td class="md" valign="top">&nbsp;)&nbsp;</td>
469          <td class="md" nowrap></td>
470        </tr>
471
472      </table>
473    </td>
474  </tr>
475</table>
476<table cellspacing=5 cellpadding=0 border=0>
477  <tr>
478    <td>
479      &nbsp;
480    </td>
481    <td>
482
483<p>
484Flips (mirrors) the image around the X-axis.
485<p>
486<dl compact><dt><b>Remarks:</b></dt><dd>An example of an original and flipped image: <pre><div>
487                        flip axis
488                            |
489                originalimg|gmilanigiro
490                00000000000|00000000000
491                00000000000|00000000000
492                00000000000|00000000000
493                00000000000|00000000000
494                00000000000|00000000000
495                </pre></div> </dd></dl>
496    </td>
497  </tr>
498</table>
499<a class="anchor" name="Ogre_1_1Imagea4" doxytag="Ogre::Image::flipAroundY" ></a><p>
500<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
501  <tr>
502    <td class="mdRow">
503      <table cellpadding="0" cellspacing="0" border="0">
504        <tr>
505          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Image.html">Image</a>&amp; Ogre::Image::flipAroundY </td>
506          <td class="md" valign="top">(&nbsp;</td>
507          <td class="mdname1" valign="top" nowrap>          </td>
508          <td class="md" valign="top">&nbsp;)&nbsp;</td>
509          <td class="md" nowrap></td>
510        </tr>
511
512      </table>
513    </td>
514  </tr>
515</table>
516<table cellspacing=5 cellpadding=0 border=0>
517  <tr>
518    <td>
519      &nbsp;
520    </td>
521    <td>
522
523<p>
524Flips (mirrors) the image around the Y-axis.
525<p>
526<dl compact><dt><b>Remarks:</b></dt><dd>An example of an original and flipped image: <pre><div>                
527                originalimg
528                00000000000
529                00000000000
530                00000000000
531                00000000000
532                00000000000
533                ------------&gt; flip axis
534                00000000000
535                00000000000
536                00000000000
537                00000000000
538                00000000000
539                originalimg
540                </pre></div> </dd></dl>
541    </td>
542  </tr>
543</table>
544<a class="anchor" name="Ogre_1_1Imagea24" doxytag="Ogre::Image::getBPP" ></a><p>
545<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
546  <tr>
547    <td class="mdRow">
548      <table cellpadding="0" cellspacing="0" border="0">
549        <tr>
550          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a421">uchar</a> Ogre::Image::getBPP </td>
551          <td class="md" valign="top">(&nbsp;</td>
552          <td class="mdname1" valign="top" nowrap>          </td>
553          <td class="md" valign="top">&nbsp;)&nbsp;</td>
554          <td class="md" nowrap> const</td>
555        </tr>
556
557      </table>
558    </td>
559  </tr>
560</table>
561<table cellspacing=5 cellpadding=0 border=0>
562  <tr>
563    <td>
564      &nbsp;
565    </td>
566    <td>
567
568<p>
569Returns the number of bits per pixel.
570<p>
571    </td>
572  </tr>
573</table>
574<a class="anchor" name="Ogre_1_1Imagea26" doxytag="Ogre::Image::getColourAt" ></a><p>
575<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
576  <tr>
577    <td class="mdRow">
578      <table cellpadding="0" cellspacing="0" border="0">
579        <tr>
580          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ColourValue.html">ColourValue</a> Ogre::Image::getColourAt </td>
581          <td class="md" valign="top">(&nbsp;</td>
582          <td class="md" nowrap valign="top">int&nbsp;</td>
583          <td class="mdname" nowrap> <em>x</em>, </td>
584        </tr>
585        <tr>
586          <td class="md" nowrap align="right"></td>
587          <td></td>
588          <td class="md" nowrap>int&nbsp;</td>
589          <td class="mdname" nowrap> <em>y</em>, </td>
590        </tr>
591        <tr>
592          <td class="md" nowrap align="right"></td>
593          <td></td>
594          <td class="md" nowrap>int&nbsp;</td>
595          <td class="mdname" nowrap> <em>z</em></td>
596        </tr>
597        <tr>
598          <td></td>
599          <td class="md">)&nbsp;</td>
600          <td class="md" colspan="2"></td>
601        </tr>
602
603      </table>
604    </td>
605  </tr>
606</table>
607<table cellspacing=5 cellpadding=0 border=0>
608  <tr>
609    <td>
610      &nbsp;
611    </td>
612    <td>
613
614<p>
615Get colour value from a certain location in the image.
616<p>
617The z coordinate is only valid for cubemaps and volume textures. This uses the first (largest) mipmap.     </td>
618  </tr>
619</table>
620<a class="anchor" name="Ogre_1_1Imagea14" doxytag="Ogre::Image::getData" ></a><p>
621<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
622  <tr>
623    <td class="mdRow">
624      <table cellpadding="0" cellspacing="0" border="0">
625        <tr>
626          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a421">uchar</a>* Ogre::Image::getData </td>
627          <td class="md" valign="top">(&nbsp;</td>
628          <td class="mdname1" valign="top" nowrap>          </td>
629          <td class="md" valign="top">&nbsp;)&nbsp;</td>
630          <td class="md" nowrap> const</td>
631        </tr>
632
633      </table>
634    </td>
635  </tr>
636</table>
637<table cellspacing=5 cellpadding=0 border=0>
638  <tr>
639    <td>
640      &nbsp;
641    </td>
642    <td>
643
644<p>
645Returns a const pointer to the internal image buffer.
646<p>
647    </td>
648  </tr>
649</table>
650<a class="anchor" name="Ogre_1_1Imagea13" doxytag="Ogre::Image::getData" ></a><p>
651<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
652  <tr>
653    <td class="mdRow">
654      <table cellpadding="0" cellspacing="0" border="0">
655        <tr>
656          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a421">uchar</a>* Ogre::Image::getData </td>
657          <td class="md" valign="top">(&nbsp;</td>
658          <td class="md" nowrap valign="top">void&nbsp;</td>
659          <td class="mdname1" valign="top" nowrap>          </td>
660          <td class="md" valign="top">&nbsp;)&nbsp;</td>
661          <td class="md" nowrap></td>
662        </tr>
663
664      </table>
665    </td>
666  </tr>
667</table>
668<table cellspacing=5 cellpadding=0 border=0>
669  <tr>
670    <td>
671      &nbsp;
672    </td>
673    <td>
674
675<p>
676Returns a pointer to the internal image buffer.
677<p>
678    </td>
679  </tr>
680</table>
681<a class="anchor" name="Ogre_1_1Imagea20" doxytag="Ogre::Image::getDepth" ></a><p>
682<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
683  <tr>
684    <td class="mdRow">
685      <table cellpadding="0" cellspacing="0" border="0">
686        <tr>
687          <td class="md" nowrap valign="top"> size_t Ogre::Image::getDepth </td>
688          <td class="md" valign="top">(&nbsp;</td>
689          <td class="md" nowrap valign="top">void&nbsp;</td>
690          <td class="mdname1" valign="top" nowrap>          </td>
691          <td class="md" valign="top">&nbsp;)&nbsp;</td>
692          <td class="md" nowrap> const</td>
693        </tr>
694
695      </table>
696    </td>
697  </tr>
698</table>
699<table cellspacing=5 cellpadding=0 border=0>
700  <tr>
701    <td>
702      &nbsp;
703    </td>
704    <td>
705
706<p>
707Gets the depth of the image.
708<p>
709    </td>
710  </tr>
711</table>
712<a class="anchor" name="Ogre_1_1Imagea23" doxytag="Ogre::Image::getFormat" ></a><p>
713<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
714  <tr>
715    <td class="mdRow">
716      <table cellpadding="0" cellspacing="0" border="0">
717        <tr>
718          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> Ogre::Image::getFormat </td>
719          <td class="md" valign="top">(&nbsp;</td>
720          <td class="mdname1" valign="top" nowrap>          </td>
721          <td class="md" valign="top">&nbsp;)&nbsp;</td>
722          <td class="md" nowrap> const</td>
723        </tr>
724
725      </table>
726    </td>
727  </tr>
728</table>
729<table cellspacing=5 cellpadding=0 border=0>
730  <tr>
731    <td>
732      &nbsp;
733    </td>
734    <td>
735
736<p>
737Returns the image format.
738<p>
739    </td>
740  </tr>
741</table>
742<a class="anchor" name="Ogre_1_1Imagea25" doxytag="Ogre::Image::getHasAlpha" ></a><p>
743<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
744  <tr>
745    <td class="mdRow">
746      <table cellpadding="0" cellspacing="0" border="0">
747        <tr>
748          <td class="md" nowrap valign="top"> bool Ogre::Image::getHasAlpha </td>
749          <td class="md" valign="top">(&nbsp;</td>
750          <td class="mdname1" valign="top" nowrap>          </td>
751          <td class="md" valign="top">&nbsp;)&nbsp;</td>
752          <td class="md" nowrap> const</td>
753        </tr>
754
755      </table>
756    </td>
757  </tr>
758</table>
759<table cellspacing=5 cellpadding=0 border=0>
760  <tr>
761    <td>
762      &nbsp;
763    </td>
764    <td>
765
766<p>
767Returns true if the image has an alpha component.
768<p>
769    </td>
770  </tr>
771</table>
772<a class="anchor" name="Ogre_1_1Imagea19" doxytag="Ogre::Image::getHeight" ></a><p>
773<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
774  <tr>
775    <td class="mdRow">
776      <table cellpadding="0" cellspacing="0" border="0">
777        <tr>
778          <td class="md" nowrap valign="top"> size_t Ogre::Image::getHeight </td>
779          <td class="md" valign="top">(&nbsp;</td>
780          <td class="md" nowrap valign="top">void&nbsp;</td>
781          <td class="mdname1" valign="top" nowrap>          </td>
782          <td class="md" valign="top">&nbsp;)&nbsp;</td>
783          <td class="md" nowrap> const</td>
784        </tr>
785
786      </table>
787    </td>
788  </tr>
789</table>
790<table cellspacing=5 cellpadding=0 border=0>
791  <tr>
792    <td>
793      &nbsp;
794    </td>
795    <td>
796
797<p>
798Gets the height of the image in pixels.
799<p>
800    </td>
801  </tr>
802</table>
803<a class="anchor" name="Ogre_1_1Imagea21" doxytag="Ogre::Image::getNumFaces" ></a><p>
804<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
805  <tr>
806    <td class="mdRow">
807      <table cellpadding="0" cellspacing="0" border="0">
808        <tr>
809          <td class="md" nowrap valign="top"> size_t Ogre::Image::getNumFaces </td>
810          <td class="md" valign="top">(&nbsp;</td>
811          <td class="md" nowrap valign="top">void&nbsp;</td>
812          <td class="mdname1" valign="top" nowrap>          </td>
813          <td class="md" valign="top">&nbsp;)&nbsp;</td>
814          <td class="md" nowrap> const</td>
815        </tr>
816
817      </table>
818    </td>
819  </tr>
820</table>
821<table cellspacing=5 cellpadding=0 border=0>
822  <tr>
823    <td>
824      &nbsp;
825    </td>
826    <td>
827
828<p>
829Get the numer of faces of the image.
830<p>
831This is usually 6 for a cubemap, and 1 for a normal image.    </td>
832  </tr>
833</table>
834<a class="anchor" name="Ogre_1_1Imagea16" doxytag="Ogre::Image::getNumMipmaps" ></a><p>
835<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
836  <tr>
837    <td class="mdRow">
838      <table cellpadding="0" cellspacing="0" border="0">
839        <tr>
840          <td class="md" nowrap valign="top"> size_t Ogre::Image::getNumMipmaps </td>
841          <td class="md" valign="top">(&nbsp;</td>
842          <td class="mdname1" valign="top" nowrap>          </td>
843          <td class="md" valign="top">&nbsp;)&nbsp;</td>
844          <td class="md" nowrap> const</td>
845        </tr>
846
847      </table>
848    </td>
849  </tr>
850</table>
851<table cellspacing=5 cellpadding=0 border=0>
852  <tr>
853    <td>
854      &nbsp;
855    </td>
856    <td>
857
858<p>
859Returns the number of mipmaps contained in the image.
860<p>
861    </td>
862  </tr>
863</table>
864<a class="anchor" name="Ogre_1_1Imagea27" doxytag="Ogre::Image::getPixelBox" ></a><p>
865<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
866  <tr>
867    <td class="mdRow">
868      <table cellpadding="0" cellspacing="0" border="0">
869        <tr>
870          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> Ogre::Image::getPixelBox </td>
871          <td class="md" valign="top">(&nbsp;</td>
872          <td class="md" nowrap valign="top">size_t&nbsp;</td>
873          <td class="mdname" nowrap> <em>face</em> = 0, </td>
874        </tr>
875        <tr>
876          <td class="md" nowrap align="right"></td>
877          <td></td>
878          <td class="md" nowrap>size_t&nbsp;</td>
879          <td class="mdname" nowrap> <em>mipmap</em> = 0</td>
880        </tr>
881        <tr>
882          <td></td>
883          <td class="md">)&nbsp;</td>
884          <td class="md" colspan="2"> const</td>
885        </tr>
886
887      </table>
888    </td>
889  </tr>
890</table>
891<table cellspacing=5 cellpadding=0 border=0>
892  <tr>
893    <td>
894      &nbsp;
895    </td>
896    <td>
897
898<p>
899Get a <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> encapsulating the image data of a mipmap.
900<p>
901    </td>
902  </tr>
903</table>
904<a class="anchor" name="Ogre_1_1Imagea22" doxytag="Ogre::Image::getRowSpan" ></a><p>
905<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
906  <tr>
907    <td class="mdRow">
908      <table cellpadding="0" cellspacing="0" border="0">
909        <tr>
910          <td class="md" nowrap valign="top"> size_t Ogre::Image::getRowSpan </td>
911          <td class="md" valign="top">(&nbsp;</td>
912          <td class="md" nowrap valign="top">void&nbsp;</td>
913          <td class="mdname1" valign="top" nowrap>          </td>
914          <td class="md" valign="top">&nbsp;)&nbsp;</td>
915          <td class="md" nowrap> const</td>
916        </tr>
917
918      </table>
919    </td>
920  </tr>
921</table>
922<table cellspacing=5 cellpadding=0 border=0>
923  <tr>
924    <td>
925      &nbsp;
926    </td>
927    <td>
928
929<p>
930Gets the physical width in bytes of each row of pixels.
931<p>
932    </td>
933  </tr>
934</table>
935<a class="anchor" name="Ogre_1_1Imagea15" doxytag="Ogre::Image::getSize" ></a><p>
936<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
937  <tr>
938    <td class="mdRow">
939      <table cellpadding="0" cellspacing="0" border="0">
940        <tr>
941          <td class="md" nowrap valign="top"> size_t Ogre::Image::getSize </td>
942          <td class="md" valign="top">(&nbsp;</td>
943          <td class="mdname1" valign="top" nowrap>          </td>
944          <td class="md" valign="top">&nbsp;)&nbsp;</td>
945          <td class="md" nowrap> const</td>
946        </tr>
947
948      </table>
949    </td>
950  </tr>
951</table>
952<table cellspacing=5 cellpadding=0 border=0>
953  <tr>
954    <td>
955      &nbsp;
956    </td>
957    <td>
958
959<p>
960Returns the size of the data buffer.
961<p>
962    </td>
963  </tr>
964</table>
965<a class="anchor" name="Ogre_1_1Imagea18" doxytag="Ogre::Image::getWidth" ></a><p>
966<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
967  <tr>
968    <td class="mdRow">
969      <table cellpadding="0" cellspacing="0" border="0">
970        <tr>
971          <td class="md" nowrap valign="top"> size_t Ogre::Image::getWidth </td>
972          <td class="md" valign="top">(&nbsp;</td>
973          <td class="md" nowrap valign="top">void&nbsp;</td>
974          <td class="mdname1" valign="top" nowrap>          </td>
975          <td class="md" valign="top">&nbsp;)&nbsp;</td>
976          <td class="md" nowrap> const</td>
977        </tr>
978
979      </table>
980    </td>
981  </tr>
982</table>
983<table cellspacing=5 cellpadding=0 border=0>
984  <tr>
985    <td>
986      &nbsp;
987    </td>
988    <td>
989
990<p>
991Gets the width of the image in pixels.
992<p>
993    </td>
994  </tr>
995</table>
996<a class="anchor" name="Ogre_1_1Imagea17" doxytag="Ogre::Image::hasFlag" ></a><p>
997<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
998  <tr>
999    <td class="mdRow">
1000      <table cellpadding="0" cellspacing="0" border="0">
1001        <tr>
1002          <td class="md" nowrap valign="top"> bool Ogre::Image::hasFlag </td>
1003          <td class="md" valign="top">(&nbsp;</td>
1004          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a657">ImageFlags</a>&nbsp;</td>
1005          <td class="mdname1" valign="top" nowrap> <em>imgFlag</em>          </td>
1006          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1007          <td class="md" nowrap> const</td>
1008        </tr>
1009
1010      </table>
1011    </td>
1012  </tr>
1013</table>
1014<table cellspacing=5 cellpadding=0 border=0>
1015  <tr>
1016    <td>
1017      &nbsp;
1018    </td>
1019    <td>
1020
1021<p>
1022Returns true if the image has the appropriate flag set.
1023<p>
1024    </td>
1025  </tr>
1026</table>
1027<a class="anchor" name="Ogre_1_1Imagea6" doxytag="Ogre::Image::Image::loadDynamicImage" ></a><p>
1028<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1029  <tr>
1030    <td class="mdRow">
1031      <table cellpadding="0" cellspacing="0" border="0">
1032        <tr>
1033          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Image.html">Image</a>&amp; Ogre::Image::Image::loadDynamicImage </td>
1034          <td class="md" valign="top">(&nbsp;</td>
1035          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a421">uchar</a> *&nbsp;</td>
1036          <td class="mdname" nowrap> <em>pData</em>, </td>
1037        </tr>
1038        <tr>
1039          <td class="md" nowrap align="right"></td>
1040          <td></td>
1041          <td class="md" nowrap>size_t&nbsp;</td>
1042          <td class="mdname" nowrap> <em>uWidth</em>, </td>
1043        </tr>
1044        <tr>
1045          <td class="md" nowrap align="right"></td>
1046          <td></td>
1047          <td class="md" nowrap>size_t&nbsp;</td>
1048          <td class="mdname" nowrap> <em>uHeight</em>, </td>
1049        </tr>
1050        <tr>
1051          <td class="md" nowrap align="right"></td>
1052          <td></td>
1053          <td class="md" nowrap>size_t&nbsp;</td>
1054          <td class="mdname" nowrap> <em>depth</em>, </td>
1055        </tr>
1056        <tr>
1057          <td class="md" nowrap align="right"></td>
1058          <td></td>
1059          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
1060          <td class="mdname" nowrap> <em>eFormat</em>, </td>
1061        </tr>
1062        <tr>
1063          <td class="md" nowrap align="right"></td>
1064          <td></td>
1065          <td class="md" nowrap>bool&nbsp;</td>
1066          <td class="mdname" nowrap> <em>autoDelete</em> = false, </td>
1067        </tr>
1068        <tr>
1069          <td class="md" nowrap align="right"></td>
1070          <td></td>
1071          <td class="md" nowrap>size_t&nbsp;</td>
1072          <td class="mdname" nowrap> <em>numFaces</em> = 1, </td>
1073        </tr>
1074        <tr>
1075          <td class="md" nowrap align="right"></td>
1076          <td></td>
1077          <td class="md" nowrap>size_t&nbsp;</td>
1078          <td class="mdname" nowrap> <em>numMipMaps</em> = 0</td>
1079        </tr>
1080        <tr>
1081          <td></td>
1082          <td class="md">)&nbsp;</td>
1083          <td class="md" colspan="2"></td>
1084        </tr>
1085
1086      </table>
1087    </td>
1088  </tr>
1089</table>
1090<table cellspacing=5 cellpadding=0 border=0>
1091  <tr>
1092    <td>
1093      &nbsp;
1094    </td>
1095    <td>
1096
1097<p>
1098Stores a pointer to raw data in memory.
1099<p>
1100The pixel format has to be specified. <dl compact><dt><b>Remarks:</b></dt><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_1Imagea23">getFormat()</a>. </dd></dl>
1101<dl compact><dt><b>Parameters:</b></dt><dd>
1102  <table border="0" cellspacing="2" cellpadding="0">
1103    <tr><td valign=top><em>The</em>&nbsp;</td><td>data pointer </td></tr>
1104    <tr><td valign=top><em>Width</em>&nbsp;</td><td>of image </td></tr>
1105    <tr><td valign=top><em>Height</em>&nbsp;</td><td>of image </td></tr>
1106    <tr><td valign=top><em>Image</em>&nbsp;</td><td>Depth (in 3d images, numbers of layers, otherwhise 1) </td></tr>
1107    <tr><td valign=top><em>Pixel</em>&nbsp;</td><td>Format </td></tr>
1108    <tr><td valign=top><em>if</em>&nbsp;</td><td>memory associated with this buffer is to be destroyed with the <a class="el" href="classOgre_1_1Image.html">Image</a> object. </td></tr>
1109    <tr><td valign=top><em>the</em>&nbsp;</td><td>number of faces the image data has inside (6 for cubemaps, 1 otherwise) </td></tr>
1110    <tr><td valign=top><em>the</em>&nbsp;</td><td>number of mipmaps the image data has inside </td></tr>
1111  </table>
1112</dl>
1113<dl compact><dt><b>Note:</b></dt><dd>The memory associated with this buffer is NOT destroyed with the <a class="el" href="classOgre_1_1Image.html">Image</a> object, unless autoDelete is set to true. </dd></dl>
1114<dl compact><dt><b>Remarks:</b></dt><dd>The size of the buffer must be numFaces*PixelUtil::getMemorySize(width, height, depth, format) </dd></dl>
1115    </td>
1116  </tr>
1117</table>
1118<a class="anchor" name="Ogre_1_1Imagea11" doxytag="Ogre::Image::load" ></a><p>
1119<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1120  <tr>
1121    <td class="mdRow">
1122      <table cellpadding="0" cellspacing="0" border="0">
1123        <tr>
1124          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Image.html">Image</a>&amp; Ogre::Image::load </td>
1125          <td class="md" valign="top">(&nbsp;</td>
1126          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;&nbsp;</td>
1127          <td class="mdname" nowrap> <em>stream</em>, </td>
1128        </tr>
1129        <tr>
1130          <td class="md" nowrap align="right"></td>
1131          <td></td>
1132          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
1133          <td class="mdname" nowrap> <em>type</em></td>
1134        </tr>
1135        <tr>
1136          <td></td>
1137          <td class="md">)&nbsp;</td>
1138          <td class="md" colspan="2"></td>
1139        </tr>
1140
1141      </table>
1142    </td>
1143  </tr>
1144</table>
1145<table cellspacing=5 cellpadding=0 border=0>
1146  <tr>
1147    <td>
1148      &nbsp;
1149    </td>
1150    <td>
1151
1152<p>
1153Loads an image file from a stream.
1154<p>
1155<dl compact><dt><b>Remarks:</b></dt><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_1DataStream.html">DataStream</a> object. This <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> is expected to contain the encoded data as it would be held in a file. </dd></dl>
1156<dl compact><dt><b>Parameters:</b></dt><dd>
1157  <table border="0" cellspacing="2" cellpadding="0">
1158    <tr><td valign=top><em>stream</em>&nbsp;</td><td>The source data. </td></tr>
1159    <tr><td valign=top><em>type</em>&nbsp;</td><td>The type of the image. Used to decide what decompression codec to use. </td></tr>
1160  </table>
1161</dl>
1162<dl compact><dt><b>See also:</b></dt><dd>Image::load( const String&amp; strFileName ) </dd></dl>
1163    </td>
1164  </tr>
1165</table>
1166<a class="anchor" name="Ogre_1_1Imagea10" doxytag="Ogre::Image::load" ></a><p>
1167<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1168  <tr>
1169    <td class="mdRow">
1170      <table cellpadding="0" cellspacing="0" border="0">
1171        <tr>
1172          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Image.html">Image</a>&amp; Ogre::Image::load </td>
1173          <td class="md" valign="top">(&nbsp;</td>
1174          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
1175          <td class="mdname" nowrap> <em>strFileName</em>, </td>
1176        </tr>
1177        <tr>
1178          <td class="md" nowrap align="right"></td>
1179          <td></td>
1180          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
1181          <td class="mdname" nowrap> <em>groupName</em></td>
1182        </tr>
1183        <tr>
1184          <td></td>
1185          <td class="md">)&nbsp;</td>
1186          <td class="md" colspan="2"></td>
1187        </tr>
1188
1189      </table>
1190    </td>
1191  </tr>
1192</table>
1193<table cellspacing=5 cellpadding=0 border=0>
1194  <tr>
1195    <td>
1196      &nbsp;
1197    </td>
1198    <td>
1199
1200<p>
1201Loads an image file.
1202<p>
1203<dl compact><dt><b>Remarks:</b></dt><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_1Imagea23">getFormat()</a>. </dd></dl>
1204<dl compact><dt><b>Parameters:</b></dt><dd>
1205  <table border="0" cellspacing="2" cellpadding="0">
1206    <tr><td valign=top><em>strFileName</em>&nbsp;</td><td>Name of a file file to load. </td></tr>
1207    <tr><td valign=top><em>groupName</em>&nbsp;</td><td>Name of the resource group to search for the image </td></tr>
1208  </table>
1209</dl>
1210<dl compact><dt><b>Note:</b></dt><dd>The memory associated with this buffer is destroyed with the <a class="el" href="classOgre_1_1Image.html">Image</a> object. </dd></dl>
1211    </td>
1212  </tr>
1213</table>
1214<a class="anchor" name="Ogre_1_1Imagea7" doxytag="Ogre::Image::loadDynamicImage" ></a><p>
1215<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1216  <tr>
1217    <td class="mdRow">
1218      <table cellpadding="0" cellspacing="0" border="0">
1219        <tr>
1220          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Image.html">Image</a>&amp; Ogre::Image::loadDynamicImage </td>
1221          <td class="md" valign="top">(&nbsp;</td>
1222          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a421">uchar</a> *&nbsp;</td>
1223          <td class="mdname" nowrap> <em>pData</em>, </td>
1224        </tr>
1225        <tr>
1226          <td class="md" nowrap align="right"></td>
1227          <td></td>
1228          <td class="md" nowrap>size_t&nbsp;</td>
1229          <td class="mdname" nowrap> <em>uWidth</em>, </td>
1230        </tr>
1231        <tr>
1232          <td class="md" nowrap align="right"></td>
1233          <td></td>
1234          <td class="md" nowrap>size_t&nbsp;</td>
1235          <td class="mdname" nowrap> <em>uHeight</em>, </td>
1236        </tr>
1237        <tr>
1238          <td class="md" nowrap align="right"></td>
1239          <td></td>
1240          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
1241          <td class="mdname" nowrap> <em>eFormat</em></td>
1242        </tr>
1243        <tr>
1244          <td></td>
1245          <td class="md">)&nbsp;</td>
1246          <td class="md" colspan="2"></td>
1247        </tr>
1248
1249      </table>
1250    </td>
1251  </tr>
1252</table>
1253<table cellspacing=5 cellpadding=0 border=0>
1254  <tr>
1255    <td>
1256      &nbsp;
1257    </td>
1258    <td>
1259
1260<p>
1261Stores a pointer to raw data in memory.
1262<p>
1263The pixel format has to be specified. <dl compact><dt><b>Remarks:</b></dt><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_1Imagea23">getFormat()</a>. </dd></dl>
1264<dl compact><dt><b>Parameters:</b></dt><dd>
1265  <table border="0" cellspacing="2" cellpadding="0">
1266    <tr><td valign=top><em>The</em>&nbsp;</td><td>data pointer </td></tr>
1267    <tr><td valign=top><em>Width</em>&nbsp;</td><td>of image </td></tr>
1268    <tr><td valign=top><em>Height</em>&nbsp;</td><td>of image </td></tr>
1269    <tr><td valign=top><em>Pixel</em>&nbsp;</td><td>Format </td></tr>
1270  </table>
1271</dl>
1272<dl compact><dt><b>Note:</b></dt><dd>The memory associated with this buffer is NOT destroyed with the <a class="el" href="classOgre_1_1Image.html">Image</a> object. </dd></dl>
1273<dl compact><dt><b>Remarks:</b></dt><dd>This function is deprecated; one should really use the <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea7">Image::loadDynamicImage</a>(pData, width, height, depth, format, ...) to be compatible with future <a class="el" href="namespaceOgre.html">Ogre</a> versions. </dd></dl>
1274
1275<p>
1276Definition at line <a class="el" href="OgreImage_8h-source.html#l00165">165</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
1277<p>
1278References <a class="el" href="OgrePrerequisites_8h-source.html#l00139">Ogre::uchar</a>.    </td>
1279  </tr>
1280</table>
1281<a class="anchor" name="Ogre_1_1Imagea9" doxytag="Ogre::Image::loadRawData" ></a><p>
1282<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1283  <tr>
1284    <td class="mdRow">
1285      <table cellpadding="0" cellspacing="0" border="0">
1286        <tr>
1287          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Image.html">Image</a>&amp; Ogre::Image::loadRawData </td>
1288          <td class="md" valign="top">(&nbsp;</td>
1289          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;&nbsp;</td>
1290          <td class="mdname" nowrap> <em>stream</em>, </td>
1291        </tr>
1292        <tr>
1293          <td class="md" nowrap align="right"></td>
1294          <td></td>
1295          <td class="md" nowrap>size_t&nbsp;</td>
1296          <td class="mdname" nowrap> <em>uWidth</em>, </td>
1297        </tr>
1298        <tr>
1299          <td class="md" nowrap align="right"></td>
1300          <td></td>
1301          <td class="md" nowrap>size_t&nbsp;</td>
1302          <td class="mdname" nowrap> <em>uHeight</em>, </td>
1303        </tr>
1304        <tr>
1305          <td class="md" nowrap align="right"></td>
1306          <td></td>
1307          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
1308          <td class="mdname" nowrap> <em>eFormat</em></td>
1309        </tr>
1310        <tr>
1311          <td></td>
1312          <td class="md">)&nbsp;</td>
1313          <td class="md" colspan="2"></td>
1314        </tr>
1315
1316      </table>
1317    </td>
1318  </tr>
1319</table>
1320<table cellspacing=5 cellpadding=0 border=0>
1321  <tr>
1322    <td>
1323      &nbsp;
1324    </td>
1325    <td>
1326
1327<p>
1328Loads raw data from a stream.
1329<p>
1330The pixel format has to be specified. <dl compact><dt><b>Remarks:</b></dt><dd>This function is deprecated; one should really use the <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagea8">Image::loadRawData</a>(stream, width, height, depth, format, ...) to be compatible with future <a class="el" href="namespaceOgre.html">Ogre</a> versions. </dd></dl>
1331
1332<p>
1333Definition at line <a class="el" href="OgreImage_8h-source.html#l00185">185</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.
1334<p>
1335References <a class="el" href="OgreDataStream_8h-source.html#l00149">Ogre::DataStreamPtr</a>.    </td>
1336  </tr>
1337</table>
1338<a class="anchor" name="Ogre_1_1Imagea8" doxytag="Ogre::Image::loadRawData" ></a><p>
1339<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1340  <tr>
1341    <td class="mdRow">
1342      <table cellpadding="0" cellspacing="0" border="0">
1343        <tr>
1344          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Image.html">Image</a>&amp; Ogre::Image::loadRawData </td>
1345          <td class="md" valign="top">(&nbsp;</td>
1346          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;&nbsp;</td>
1347          <td class="mdname" nowrap> <em>stream</em>, </td>
1348        </tr>
1349        <tr>
1350          <td class="md" nowrap align="right"></td>
1351          <td></td>
1352          <td class="md" nowrap>size_t&nbsp;</td>
1353          <td class="mdname" nowrap> <em>uWidth</em>, </td>
1354        </tr>
1355        <tr>
1356          <td class="md" nowrap align="right"></td>
1357          <td></td>
1358          <td class="md" nowrap>size_t&nbsp;</td>
1359          <td class="mdname" nowrap> <em>uHeight</em>, </td>
1360        </tr>
1361        <tr>
1362          <td class="md" nowrap align="right"></td>
1363          <td></td>
1364          <td class="md" nowrap>size_t&nbsp;</td>
1365          <td class="mdname" nowrap> <em>uDepth</em>, </td>
1366        </tr>
1367        <tr>
1368          <td class="md" nowrap align="right"></td>
1369          <td></td>
1370          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
1371          <td class="mdname" nowrap> <em>eFormat</em>, </td>
1372        </tr>
1373        <tr>
1374          <td class="md" nowrap align="right"></td>
1375          <td></td>
1376          <td class="md" nowrap>size_t&nbsp;</td>
1377          <td class="mdname" nowrap> <em>numFaces</em> = 1, </td>
1378        </tr>
1379        <tr>
1380          <td class="md" nowrap align="right"></td>
1381          <td></td>
1382          <td class="md" nowrap>size_t&nbsp;</td>
1383          <td class="mdname" nowrap> <em>numMipMaps</em> = 0</td>
1384        </tr>
1385        <tr>
1386          <td></td>
1387          <td class="md">)&nbsp;</td>
1388          <td class="md" colspan="2"></td>
1389        </tr>
1390
1391      </table>
1392    </td>
1393  </tr>
1394</table>
1395<table cellspacing=5 cellpadding=0 border=0>
1396  <tr>
1397    <td>
1398      &nbsp;
1399    </td>
1400    <td>
1401
1402<p>
1403Loads raw data from a stream.
1404<p>
1405See the function loadDynamicImage for a description of the parameters. <dl compact><dt><b>Remarks:</b></dt><dd>The size of the buffer must be numFaces*PixelUtil::getMemorySize(width, height, depth, format) </dd></dl>
1406    </td>
1407  </tr>
1408</table>
1409<a class="anchor" name="Ogre_1_1Imagea3" doxytag="Ogre::Image::operator=" ></a><p>
1410<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1411  <tr>
1412    <td class="mdRow">
1413      <table cellpadding="0" cellspacing="0" border="0">
1414        <tr>
1415          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Image.html">Image</a>&amp; Ogre::Image::operator= </td>
1416          <td class="md" valign="top">(&nbsp;</td>
1417          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Image.html">Image</a> &amp;&nbsp;</td>
1418          <td class="mdname1" valign="top" nowrap> <em>img</em>          </td>
1419          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1420          <td class="md" nowrap></td>
1421        </tr>
1422
1423      </table>
1424    </td>
1425  </tr>
1426</table>
1427<table cellspacing=5 cellpadding=0 border=0>
1428  <tr>
1429    <td>
1430      &nbsp;
1431    </td>
1432    <td>
1433
1434<p>
1435Assignment operator - copies all the data from the target image.
1436<p>
1437    </td>
1438  </tr>
1439</table>
1440<a class="anchor" name="Ogre_1_1Imagea28" doxytag="Ogre::Image::resize" ></a><p>
1441<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1442  <tr>
1443    <td class="mdRow">
1444      <table cellpadding="0" cellspacing="0" border="0">
1445        <tr>
1446          <td class="md" nowrap valign="top"> void Ogre::Image::resize </td>
1447          <td class="md" valign="top">(&nbsp;</td>
1448          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a422">ushort</a>&nbsp;</td>
1449          <td class="mdname" nowrap> <em>width</em>, </td>
1450        </tr>
1451        <tr>
1452          <td class="md" nowrap align="right"></td>
1453          <td></td>
1454          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a422">ushort</a>&nbsp;</td>
1455          <td class="mdname" nowrap> <em>height</em>, </td>
1456        </tr>
1457        <tr>
1458          <td class="md" nowrap align="right"></td>
1459          <td></td>
1460          <td class="md" nowrap><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8">Filter</a>&nbsp;</td>
1461          <td class="mdname" nowrap> <em>filter</em> = FILTER_BILINEAR</td>
1462        </tr>
1463        <tr>
1464          <td></td>
1465          <td class="md">)&nbsp;</td>
1466          <td class="md" colspan="2"></td>
1467        </tr>
1468
1469      </table>
1470    </td>
1471  </tr>
1472</table>
1473<table cellspacing=5 cellpadding=0 border=0>
1474  <tr>
1475    <td>
1476      &nbsp;
1477    </td>
1478    <td>
1479
1480<p>
1481Resize a 2D image, applying the appropriate filter.
1482<p>
1483    </td>
1484  </tr>
1485</table>
1486<a class="anchor" name="Ogre_1_1Imagea12" doxytag="Ogre::Image::save" ></a><p>
1487<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1488  <tr>
1489    <td class="mdRow">
1490      <table cellpadding="0" cellspacing="0" border="0">
1491        <tr>
1492          <td class="md" nowrap valign="top"> void Ogre::Image::save </td>
1493          <td class="md" valign="top">(&nbsp;</td>
1494          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
1495          <td class="mdname1" valign="top" nowrap> <em>filename</em>          </td>
1496          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1497          <td class="md" nowrap></td>
1498        </tr>
1499
1500      </table>
1501    </td>
1502  </tr>
1503</table>
1504<table cellspacing=5 cellpadding=0 border=0>
1505  <tr>
1506    <td>
1507      &nbsp;
1508    </td>
1509    <td>
1510
1511<p>
1512Save the image as a file.
1513<p>
1514    </td>
1515  </tr>
1516</table>
1517<a class="anchor" name="Ogre_1_1Imagee1" doxytag="Ogre::Image::scale" ></a><p>
1518<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1519  <tr>
1520    <td class="mdRow">
1521      <table cellpadding="0" cellspacing="0" border="0">
1522        <tr>
1523          <td class="md" nowrap valign="top"> void Ogre::Image::scale </td>
1524          <td class="md" valign="top">(&nbsp;</td>
1525          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;&nbsp;</td>
1526          <td class="mdname" nowrap> <em>src</em>, </td>
1527        </tr>
1528        <tr>
1529          <td class="md" nowrap align="right"></td>
1530          <td></td>
1531          <td class="md" nowrap>const <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;&nbsp;</td>
1532          <td class="mdname" nowrap> <em>dst</em>, </td>
1533        </tr>
1534        <tr>
1535          <td class="md" nowrap align="right"></td>
1536          <td></td>
1537          <td class="md" nowrap><a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imagew8">Filter</a>&nbsp;</td>
1538          <td class="mdname" nowrap> <em>filter</em> = FILTER_BILINEAR</td>
1539        </tr>
1540        <tr>
1541          <td></td>
1542          <td class="md">)&nbsp;</td>
1543          <td class="md" colspan="2"><code> [static]</code></td>
1544        </tr>
1545
1546      </table>
1547    </td>
1548  </tr>
1549</table>
1550<table cellspacing=5 cellpadding=0 border=0>
1551  <tr>
1552    <td>
1553      &nbsp;
1554    </td>
1555    <td>
1556
1557<p>
1558Scale a 1D, 2D or 3D image volume.
1559<p>
1560<dl compact><dt><b>Parameters:</b></dt><dd>
1561  <table border="0" cellspacing="2" cellpadding="0">
1562    <tr><td valign=top><em>src</em>&nbsp;</td><td><a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> containing the source pointer, dimensions and format </td></tr>
1563    <tr><td valign=top><em>dst</em>&nbsp;</td><td><a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> containing the destination pointer, dimensions and format </td></tr>
1564    <tr><td valign=top><em>filter</em>&nbsp;</td><td>Which filter to use </td></tr>
1565  </table>
1566</dl>
1567<dl compact><dt><b>Remarks:</b></dt><dd>This function can do pixel format conversion in the process. </dd></dl>
1568<dl compact><dt><b>Note:</b></dt><dd>dst and src can point to the same <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> object without any problem</dd></dl>
1569    </td>
1570  </tr>
1571</table>
1572<hr><h2>Member Data Documentation</h2>
1573<a class="anchor" name="Ogre_1_1Imager9" doxytag="Ogre::Image::m_bAutoDelete" ></a><p>
1574<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1575  <tr>
1576    <td class="mdRow">
1577      <table cellpadding="0" cellspacing="0" border="0">
1578        <tr>
1579          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager9">Ogre::Image::m_bAutoDelete</a><code> [private]</code>
1580      </table>
1581    </td>
1582  </tr>
1583</table>
1584<table cellspacing=5 cellpadding=0 border=0>
1585  <tr>
1586    <td>
1587      &nbsp;
1588    </td>
1589    <td>
1590
1591<p>
1592
1593<p>
1594Definition at line <a class="el" href="OgreImage_8h-source.html#l00345">345</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
1595  </tr>
1596</table>
1597<a class="anchor" name="Ogre_1_1Imager6" doxytag="Ogre::Image::m_eFormat" ></a><p>
1598<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1599  <tr>
1600    <td class="mdRow">
1601      <table cellpadding="0" cellspacing="0" border="0">
1602        <tr>
1603          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager6">Ogre::Image::m_eFormat</a><code> [private]</code>
1604      </table>
1605    </td>
1606  </tr>
1607</table>
1608<table cellspacing=5 cellpadding=0 border=0>
1609  <tr>
1610    <td>
1611      &nbsp;
1612    </td>
1613    <td>
1614
1615<p>
1616
1617<p>
1618Definition at line <a class="el" href="OgreImage_8h-source.html#l00338">338</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
1619  </tr>
1620</table>
1621<a class="anchor" name="Ogre_1_1Imager8" doxytag="Ogre::Image::m_pBuffer" ></a><p>
1622<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1623  <tr>
1624    <td class="mdRow">
1625      <table cellpadding="0" cellspacing="0" border="0">
1626        <tr>
1627          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a421">uchar</a>* <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager8">Ogre::Image::m_pBuffer</a><code> [private]</code>
1628      </table>
1629    </td>
1630  </tr>
1631</table>
1632<table cellspacing=5 cellpadding=0 border=0>
1633  <tr>
1634    <td>
1635      &nbsp;
1636    </td>
1637    <td>
1638
1639<p>
1640
1641<p>
1642Definition at line <a class="el" href="OgreImage_8h-source.html#l00342">342</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
1643  </tr>
1644</table>
1645<a class="anchor" name="Ogre_1_1Imager7" doxytag="Ogre::Image::m_ucPixelSize" ></a><p>
1646<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1647  <tr>
1648    <td class="mdRow">
1649      <table cellpadding="0" cellspacing="0" border="0">
1650        <tr>
1651          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a421">uchar</a> <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager7">Ogre::Image::m_ucPixelSize</a><code> [private]</code>
1652      </table>
1653    </td>
1654  </tr>
1655</table>
1656<table cellspacing=5 cellpadding=0 border=0>
1657  <tr>
1658    <td>
1659      &nbsp;
1660    </td>
1661    <td>
1662
1663<p>
1664
1665<p>
1666Definition at line <a class="el" href="OgreImage_8h-source.html#l00341">341</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
1667  </tr>
1668</table>
1669<a class="anchor" name="Ogre_1_1Imager2" doxytag="Ogre::Image::m_uDepth" ></a><p>
1670<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1671  <tr>
1672    <td class="mdRow">
1673      <table cellpadding="0" cellspacing="0" border="0">
1674        <tr>
1675          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager2">Ogre::Image::m_uDepth</a><code> [private]</code>
1676      </table>
1677    </td>
1678  </tr>
1679</table>
1680<table cellspacing=5 cellpadding=0 border=0>
1681  <tr>
1682    <td>
1683      &nbsp;
1684    </td>
1685    <td>
1686
1687<p>
1688
1689<p>
1690Definition at line <a class="el" href="OgreImage_8h-source.html#l00329">329</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
1691  </tr>
1692</table>
1693<a class="anchor" name="Ogre_1_1Imager5" doxytag="Ogre::Image::m_uFlags" ></a><p>
1694<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1695  <tr>
1696    <td class="mdRow">
1697      <table cellpadding="0" cellspacing="0" border="0">
1698        <tr>
1699          <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager5">Ogre::Image::m_uFlags</a><code> [private]</code>
1700      </table>
1701    </td>
1702  </tr>
1703</table>
1704<table cellspacing=5 cellpadding=0 border=0>
1705  <tr>
1706    <td>
1707      &nbsp;
1708    </td>
1709    <td>
1710
1711<p>
1712
1713<p>
1714Definition at line <a class="el" href="OgreImage_8h-source.html#l00335">335</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
1715  </tr>
1716</table>
1717<a class="anchor" name="Ogre_1_1Imager1" doxytag="Ogre::Image::m_uHeight" ></a><p>
1718<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1719  <tr>
1720    <td class="mdRow">
1721      <table cellpadding="0" cellspacing="0" border="0">
1722        <tr>
1723          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager1">Ogre::Image::m_uHeight</a><code> [private]</code>
1724      </table>
1725    </td>
1726  </tr>
1727</table>
1728<table cellspacing=5 cellpadding=0 border=0>
1729  <tr>
1730    <td>
1731      &nbsp;
1732    </td>
1733    <td>
1734
1735<p>
1736
1737<p>
1738Definition at line <a class="el" href="OgreImage_8h-source.html#l00327">327</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
1739  </tr>
1740</table>
1741<a class="anchor" name="Ogre_1_1Imager4" doxytag="Ogre::Image::m_uNumMipmaps" ></a><p>
1742<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1743  <tr>
1744    <td class="mdRow">
1745      <table cellpadding="0" cellspacing="0" border="0">
1746        <tr>
1747          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager4">Ogre::Image::m_uNumMipmaps</a><code> [private]</code>
1748      </table>
1749    </td>
1750  </tr>
1751</table>
1752<table cellspacing=5 cellpadding=0 border=0>
1753  <tr>
1754    <td>
1755      &nbsp;
1756    </td>
1757    <td>
1758
1759<p>
1760
1761<p>
1762Definition at line <a class="el" href="OgreImage_8h-source.html#l00333">333</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
1763  </tr>
1764</table>
1765<a class="anchor" name="Ogre_1_1Imager3" doxytag="Ogre::Image::m_uSize" ></a><p>
1766<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1767  <tr>
1768    <td class="mdRow">
1769      <table cellpadding="0" cellspacing="0" border="0">
1770        <tr>
1771          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager3">Ogre::Image::m_uSize</a><code> [private]</code>
1772      </table>
1773    </td>
1774  </tr>
1775</table>
1776<table cellspacing=5 cellpadding=0 border=0>
1777  <tr>
1778    <td>
1779      &nbsp;
1780    </td>
1781    <td>
1782
1783<p>
1784
1785<p>
1786Definition at line <a class="el" href="OgreImage_8h-source.html#l00331">331</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
1787  </tr>
1788</table>
1789<a class="anchor" name="Ogre_1_1Imager0" doxytag="Ogre::Image::m_uWidth" ></a><p>
1790<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1791  <tr>
1792    <td class="mdRow">
1793      <table cellpadding="0" cellspacing="0" border="0">
1794        <tr>
1795          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1Image.html#Ogre_1_1Imager0">Ogre::Image::m_uWidth</a><code> [private]</code>
1796      </table>
1797    </td>
1798  </tr>
1799</table>
1800<table cellspacing=5 cellpadding=0 border=0>
1801  <tr>
1802    <td>
1803      &nbsp;
1804    </td>
1805    <td>
1806
1807<p>
1808
1809<p>
1810Definition at line <a class="el" href="OgreImage_8h-source.html#l00325">325</a> of file <a class="el" href="OgreImage_8h-source.html">OgreImage.h</a>.    </td>
1811  </tr>
1812</table>
1813<hr>The documentation for this class was generated from the following file:<ul>
1814<li><a class="el" href="OgreImage_8h-source.html">OgreImage.h</a></ul>
1815<hr>
1816<p>
1817Copyright &copy; 2000-2005 by The OGRE Team<br />
1818<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
1819This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
1820                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
1821                <Work rdf:about="">
1822                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1823        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1824                </Work>
1825                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
1826
1827Last modified Sun Feb 12 13:00:49 2006
1828</p>
1829</body>
1830</html>
Note: See TracBrowser for help on using the repository browser.