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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::PixelBox 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::PixelBox Class Reference</h1>A primitive describing a volume (3D), image (2D) or line (1D) of pixels in memory. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::PixelBox:
16<p><center><img src="classOgre_1_1PixelBox.png" usemap="#Ogre::PixelBox_map" border="0" alt=""></center>
17<map name="Ogre::PixelBox_map">
18<area href="structOgre_1_1Box.html" alt="Ogre::Box" shape="rect" coords="0,0,95,24">
19</map>
20<a href="classOgre_1_1PixelBox-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxa0">PixelBox</a> ()</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parameter constructor for setting the members manually.  <a href="#Ogre_1_1PixelBoxa0"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxa1">PixelBox</a> (const <a class="el" href="structOgre_1_1Box.html">Box</a> &amp;extents, <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> pixelFormat, void *pixelData=0)</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor providing extents in the form of a <a class="el" href="structOgre_1_1Box.html">Box</a> object.  <a href="#Ogre_1_1PixelBoxa1"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxa2">PixelBox</a> (size_t width, size_t height, size_t depth, <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> pixelFormat, void *pixelData=0)</td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor providing width, height and depth.  <a href="#Ogre_1_1PixelBoxa2"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxa3">setConsecutive</a> ()</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the rowPitch and slicePitch so that the buffer is laid out consecutive in memory.  <a href="#Ogre_1_1PixelBoxa3"></a><br><br></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxa4">getRowSkip</a> () const </td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of elements between one past the rightmost pixel of one row and the leftmost pixel of the next row.  <a href="#Ogre_1_1PixelBoxa4"></a><br><br></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxa5">getSliceSkip</a> () const </td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of elements between one past the right bottom pixel of one slice and the left top pixel of the next slice.  <a href="#Ogre_1_1PixelBoxa5"></a><br><br></td></tr>
41<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxa6">isConsecutive</a> () const </td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return whether this buffer is laid out consecutive in memory (ie the pitches are equal to the dimensions).  <a href="#Ogre_1_1PixelBoxa6"></a><br><br></td></tr>
44<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxa7">getConsecutiveSize</a> () const </td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the size (in bytes) this image would take if it was laid out consecutive in memory.  <a href="#Ogre_1_1PixelBoxa7"></a><br><br></td></tr>
47<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_1PixelBox.html#Ogre_1_1PixelBoxa8">getSubVolume</a> (const <a class="el" href="structOgre_1_1Box.html">Box</a> &amp;def) const </td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a subvolume of this <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a>.  <a href="#Ogre_1_1PixelBoxa8"></a><br><br></td></tr>
50<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxa9">contains</a> (const <a class="el" href="structOgre_1_1Box.html">Box</a> &amp;def) const </td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if the other box is a part of this one.  <a href="#Ogre_1_1PixelBoxa9"></a><br><br></td></tr>
53<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxa10">getWidth</a> () const </td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the width of this box.  <a href="#Ogre_1_1PixelBoxa10"></a><br><br></td></tr>
56<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxa11">getHeight</a> () const </td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the height of this box.  <a href="#Ogre_1_1PixelBoxa11"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxa12">getDepth</a> () const </td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the depth of this box.  <a href="#Ogre_1_1PixelBoxa12"></a><br><br></td></tr>
62<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
63<tr><td class="memItemLeft" nowrap align=right valign=top>void *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxo0">data</a></td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The data pointer.  <a href="#Ogre_1_1PixelBoxo0"></a><br><br></td></tr>
66<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_1PixelBox.html#Ogre_1_1PixelBoxo1">format</a></td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The pixel format.  <a href="#Ogre_1_1PixelBoxo1"></a><br><br></td></tr>
69<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxo2">rowPitch</a></td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of elements between the leftmost pixel of one row and the left pixel of the next.  <a href="#Ogre_1_1PixelBoxo2"></a><br><br></td></tr>
72<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxo3">slicePitch</a></td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of elements between the top left pixel of one (depth) slice and the top left pixel of the next.  <a href="#Ogre_1_1PixelBoxo3"></a><br><br></td></tr>
75<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo4">left</a></td></tr>
76
77<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo5">top</a></td></tr>
78
79<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo6">right</a></td></tr>
80
81<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo7">bottom</a></td></tr>
82
83<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo8">front</a></td></tr>
84
85<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo9">back</a></td></tr>
86
87</table>
88<hr><a name="_details"></a><h2>Detailed Description</h2>
89A primitive describing a volume (3D), image (2D) or line (1D) of pixels in memory.
90<p>
91In case of a rectangle, depth must be 1. Pixels are stored as a succession of "depth" slices, each containing "height" rows of "width" pixels.
92<p>
93
94<p>
95Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00156">156</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
96<a class="anchor" name="Ogre_1_1PixelBoxa0" doxytag="Ogre::PixelBox::PixelBox" ></a><p>
97<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
98  <tr>
99    <td class="mdRow">
100      <table cellpadding="0" cellspacing="0" border="0">
101        <tr>
102          <td class="md" nowrap valign="top"> Ogre::PixelBox::PixelBox </td>
103          <td class="md" valign="top">(&nbsp;</td>
104          <td class="mdname1" valign="top" nowrap>          </td>
105          <td class="md" valign="top">&nbsp;)&nbsp;</td>
106          <td class="md" nowrap></td>
107        </tr>
108
109      </table>
110    </td>
111  </tr>
112</table>
113<table cellspacing=5 cellpadding=0 border=0>
114  <tr>
115    <td>
116      &nbsp;
117    </td>
118    <td>
119
120<p>
121Parameter constructor for setting the members manually.
122<p>
123
124<p>
125Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00159">159</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.    </td>
126  </tr>
127</table>
128<a class="anchor" name="Ogre_1_1PixelBoxa1" doxytag="Ogre::PixelBox::PixelBox" ></a><p>
129<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
130  <tr>
131    <td class="mdRow">
132      <table cellpadding="0" cellspacing="0" border="0">
133        <tr>
134          <td class="md" nowrap valign="top"> Ogre::PixelBox::PixelBox </td>
135          <td class="md" valign="top">(&nbsp;</td>
136          <td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1Box.html">Box</a> &amp;&nbsp;</td>
137          <td class="mdname" nowrap> <em>extents</em>, </td>
138        </tr>
139        <tr>
140          <td class="md" nowrap align="right"></td>
141          <td></td>
142          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
143          <td class="mdname" nowrap> <em>pixelFormat</em>, </td>
144        </tr>
145        <tr>
146          <td class="md" nowrap align="right"></td>
147          <td></td>
148          <td class="md" nowrap>void *&nbsp;</td>
149          <td class="mdname" nowrap> <em>pixelData</em> = 0</td>
150        </tr>
151        <tr>
152          <td></td>
153          <td class="md">)&nbsp;</td>
154          <td class="md" colspan="2"></td>
155        </tr>
156
157      </table>
158    </td>
159  </tr>
160</table>
161<table cellspacing=5 cellpadding=0 border=0>
162  <tr>
163    <td>
164      &nbsp;
165    </td>
166    <td>
167
168<p>
169Constructor providing extents in the form of a <a class="el" href="structOgre_1_1Box.html">Box</a> object.
170<p>
171This constructor assumes the pixel data is laid out consecutively in memory. (this means row after row, slice after slice, with no space in between) <dl compact><dt><b>Parameters:</b></dt><dd>
172  <table border="0" cellspacing="2" cellpadding="0">
173    <tr><td valign=top><em>extents</em>&nbsp;</td><td>Extents of the region defined by data </td></tr>
174    <tr><td valign=top><em>pixelFormat</em>&nbsp;</td><td>Format of this buffer </td></tr>
175    <tr><td valign=top><em>pixelData</em>&nbsp;</td><td>Pointer to the actual data</td></tr>
176  </table>
177</dl>
178
179<p>
180Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00167">167</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.    </td>
181  </tr>
182</table>
183<a class="anchor" name="Ogre_1_1PixelBoxa2" doxytag="Ogre::PixelBox::PixelBox" ></a><p>
184<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
185  <tr>
186    <td class="mdRow">
187      <table cellpadding="0" cellspacing="0" border="0">
188        <tr>
189          <td class="md" nowrap valign="top"> Ogre::PixelBox::PixelBox </td>
190          <td class="md" valign="top">(&nbsp;</td>
191          <td class="md" nowrap valign="top">size_t&nbsp;</td>
192          <td class="mdname" nowrap> <em>width</em>, </td>
193        </tr>
194        <tr>
195          <td class="md" nowrap align="right"></td>
196          <td></td>
197          <td class="md" nowrap>size_t&nbsp;</td>
198          <td class="mdname" nowrap> <em>height</em>, </td>
199        </tr>
200        <tr>
201          <td class="md" nowrap align="right"></td>
202          <td></td>
203          <td class="md" nowrap>size_t&nbsp;</td>
204          <td class="mdname" nowrap> <em>depth</em>, </td>
205        </tr>
206        <tr>
207          <td class="md" nowrap align="right"></td>
208          <td></td>
209          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
210          <td class="mdname" nowrap> <em>pixelFormat</em>, </td>
211        </tr>
212        <tr>
213          <td class="md" nowrap align="right"></td>
214          <td></td>
215          <td class="md" nowrap>void *&nbsp;</td>
216          <td class="mdname" nowrap> <em>pixelData</em> = 0</td>
217        </tr>
218        <tr>
219          <td></td>
220          <td class="md">)&nbsp;</td>
221          <td class="md" colspan="2"></td>
222        </tr>
223
224      </table>
225    </td>
226  </tr>
227</table>
228<table cellspacing=5 cellpadding=0 border=0>
229  <tr>
230    <td>
231      &nbsp;
232    </td>
233    <td>
234
235<p>
236Constructor providing width, height and depth.
237<p>
238This constructor assumes the pixel data is laid out consecutively in memory. (this means row after row, slice after slice, with no space in between) <dl compact><dt><b>Parameters:</b></dt><dd>
239  <table border="0" cellspacing="2" cellpadding="0">
240    <tr><td valign=top><em>width</em>&nbsp;</td><td>Width of the region </td></tr>
241    <tr><td valign=top><em>height</em>&nbsp;</td><td>Height of the region </td></tr>
242    <tr><td valign=top><em>depth</em>&nbsp;</td><td>Depth of the region </td></tr>
243    <tr><td valign=top><em>pixelFormat</em>&nbsp;</td><td>Format of this buffer </td></tr>
244    <tr><td valign=top><em>pixelData</em>&nbsp;</td><td>Pointer to the actual data</td></tr>
245  </table>
246</dl>
247
248<p>
249Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00181">181</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.    </td>
250  </tr>
251</table>
252<hr><h2>Member Function Documentation</h2>
253<a class="anchor" name="Ogre_1_1PixelBoxa9" doxytag="Ogre::PixelBox::contains" ></a><p>
254<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
255  <tr>
256    <td class="mdRow">
257      <table cellpadding="0" cellspacing="0" border="0">
258        <tr>
259          <td class="md" nowrap valign="top"> bool Ogre::Box::contains </td>
260          <td class="md" valign="top">(&nbsp;</td>
261          <td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1Box.html">Box</a> &amp;&nbsp;</td>
262          <td class="mdname1" valign="top" nowrap> <em>def</em>          </td>
263          <td class="md" valign="top">&nbsp;)&nbsp;</td>
264          <td class="md" nowrap> const<code> [inherited]</code></td>
265        </tr>
266
267      </table>
268    </td>
269  </tr>
270</table>
271<table cellspacing=5 cellpadding=0 border=0>
272  <tr>
273    <td>
274      &nbsp;
275    </td>
276    <td>
277
278<p>
279Return true if the other box is a part of this one.
280<p>
281
282<p>
283Definition at line <a class="el" href="OgreCommon_8h-source.html#l00283">283</a> of file <a class="el" href="OgreCommon_8h-source.html">OgreCommon.h</a>.
284<p>
285References <a class="el" href="OgreCommon_8h-source.html#l00236">Ogre::Box::back</a>, <a class="el" href="OgreCommon_8h-source.html#l00236">Ogre::Box::bottom</a>, <a class="el" href="OgreCommon_8h-source.html#l00236">Ogre::Box::front</a>, <a class="el" href="OgreCommon_8h-source.html#l00236">Ogre::Box::left</a>, <a class="el" href="OgreCommon_8h-source.html#l00236">Ogre::Box::right</a>, and <a class="el" href="OgreCommon_8h-source.html#l00236">Ogre::Box::top</a>.    </td>
286  </tr>
287</table>
288<a class="anchor" name="Ogre_1_1PixelBoxa7" doxytag="Ogre::PixelBox::getConsecutiveSize" ></a><p>
289<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
290  <tr>
291    <td class="mdRow">
292      <table cellpadding="0" cellspacing="0" border="0">
293        <tr>
294          <td class="md" nowrap valign="top"> size_t Ogre::PixelBox::getConsecutiveSize </td>
295          <td class="md" valign="top">(&nbsp;</td>
296          <td class="mdname1" valign="top" nowrap>          </td>
297          <td class="md" valign="top">&nbsp;)&nbsp;</td>
298          <td class="md" nowrap> const</td>
299        </tr>
300
301      </table>
302    </td>
303  </tr>
304</table>
305<table cellspacing=5 cellpadding=0 border=0>
306  <tr>
307    <td>
308      &nbsp;
309    </td>
310    <td>
311
312<p>
313Return the size (in bytes) this image would take if it was laid out consecutive in memory.
314<p>
315    </td>
316  </tr>
317</table>
318<a class="anchor" name="Ogre_1_1PixelBoxa12" doxytag="Ogre::PixelBox::getDepth" ></a><p>
319<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
320  <tr>
321    <td class="mdRow">
322      <table cellpadding="0" cellspacing="0" border="0">
323        <tr>
324          <td class="md" nowrap valign="top"> size_t Ogre::Box::getDepth </td>
325          <td class="md" valign="top">(&nbsp;</td>
326          <td class="mdname1" valign="top" nowrap>          </td>
327          <td class="md" valign="top">&nbsp;)&nbsp;</td>
328          <td class="md" nowrap> const<code> [inherited]</code></td>
329        </tr>
330
331      </table>
332    </td>
333  </tr>
334</table>
335<table cellspacing=5 cellpadding=0 border=0>
336  <tr>
337    <td>
338      &nbsp;
339    </td>
340    <td>
341
342<p>
343Get the depth of this box.
344<p>
345
346<p>
347Definition at line <a class="el" href="OgreCommon_8h-source.html#l00294">294</a> of file <a class="el" href="OgreCommon_8h-source.html">OgreCommon.h</a>.
348<p>
349References <a class="el" href="OgreCommon_8h-source.html#l00236">Ogre::Box::back</a>, and <a class="el" href="OgreCommon_8h-source.html#l00236">Ogre::Box::front</a>.
350<p>
351Referenced by <a class="el" href="OgreImageResampler_8h-source.html#l00284">Ogre::LinearResampler_Byte&lt; channels &gt;::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
352  </tr>
353</table>
354<a class="anchor" name="Ogre_1_1PixelBoxa11" doxytag="Ogre::PixelBox::getHeight" ></a><p>
355<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
356  <tr>
357    <td class="mdRow">
358      <table cellpadding="0" cellspacing="0" border="0">
359        <tr>
360          <td class="md" nowrap valign="top"> size_t Ogre::Box::getHeight </td>
361          <td class="md" valign="top">(&nbsp;</td>
362          <td class="mdname1" valign="top" nowrap>          </td>
363          <td class="md" valign="top">&nbsp;)&nbsp;</td>
364          <td class="md" nowrap> const<code> [inherited]</code></td>
365        </tr>
366
367      </table>
368    </td>
369  </tr>
370</table>
371<table cellspacing=5 cellpadding=0 border=0>
372  <tr>
373    <td>
374      &nbsp;
375    </td>
376    <td>
377
378<p>
379Get the height of this box.
380<p>
381
382<p>
383Definition at line <a class="el" href="OgreCommon_8h-source.html#l00292">292</a> of file <a class="el" href="OgreCommon_8h-source.html">OgreCommon.h</a>.
384<p>
385Referenced by <a class="el" href="OgreImageResampler_8h-source.html#l00284">Ogre::LinearResampler_Byte&lt; channels &gt;::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
386  </tr>
387</table>
388<a class="anchor" name="Ogre_1_1PixelBoxa4" doxytag="Ogre::PixelBox::getRowSkip" ></a><p>
389<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
390  <tr>
391    <td class="mdRow">
392      <table cellpadding="0" cellspacing="0" border="0">
393        <tr>
394          <td class="md" nowrap valign="top"> size_t Ogre::PixelBox::getRowSkip </td>
395          <td class="md" valign="top">(&nbsp;</td>
396          <td class="mdname1" valign="top" nowrap>          </td>
397          <td class="md" valign="top">&nbsp;)&nbsp;</td>
398          <td class="md" nowrap> const</td>
399        </tr>
400
401      </table>
402    </td>
403  </tr>
404</table>
405<table cellspacing=5 cellpadding=0 border=0>
406  <tr>
407    <td>
408      &nbsp;
409    </td>
410    <td>
411
412<p>
413Get the number of elements between one past the rightmost pixel of one row and the leftmost pixel of the next row.
414<p>
415(IE this is zero if rows are consecutive).
416<p>
417Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00216">216</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.
418<p>
419Referenced by <a class="el" href="OgreImageResampler_8h-source.html#l00284">Ogre::LinearResampler_Byte&lt; channels &gt;::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
420  </tr>
421</table>
422<a class="anchor" name="Ogre_1_1PixelBoxa5" doxytag="Ogre::PixelBox::getSliceSkip" ></a><p>
423<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
424  <tr>
425    <td class="mdRow">
426      <table cellpadding="0" cellspacing="0" border="0">
427        <tr>
428          <td class="md" nowrap valign="top"> size_t Ogre::PixelBox::getSliceSkip </td>
429          <td class="md" valign="top">(&nbsp;</td>
430          <td class="mdname1" valign="top" nowrap>          </td>
431          <td class="md" valign="top">&nbsp;)&nbsp;</td>
432          <td class="md" nowrap> const</td>
433        </tr>
434
435      </table>
436    </td>
437  </tr>
438</table>
439<table cellspacing=5 cellpadding=0 border=0>
440  <tr>
441    <td>
442      &nbsp;
443    </td>
444    <td>
445
446<p>
447Get the number of elements between one past the right bottom pixel of one slice and the left top pixel of the next slice.
448<p>
449(IE this is zero if slices are consecutive).
450<p>
451Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00221">221</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.
452<p>
453Referenced by <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
454  </tr>
455</table>
456<a class="anchor" name="Ogre_1_1PixelBoxa8" doxytag="Ogre::PixelBox::getSubVolume" ></a><p>
457<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
458  <tr>
459    <td class="mdRow">
460      <table cellpadding="0" cellspacing="0" border="0">
461        <tr>
462          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> Ogre::PixelBox::getSubVolume </td>
463          <td class="md" valign="top">(&nbsp;</td>
464          <td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1Box.html">Box</a> &amp;&nbsp;</td>
465          <td class="mdname1" valign="top" nowrap> <em>def</em>          </td>
466          <td class="md" valign="top">&nbsp;)&nbsp;</td>
467          <td class="md" nowrap> const</td>
468        </tr>
469
470      </table>
471    </td>
472  </tr>
473</table>
474<table cellspacing=5 cellpadding=0 border=0>
475  <tr>
476    <td>
477      &nbsp;
478    </td>
479    <td>
480
481<p>
482Return a subvolume of this <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a>.
483<p>
484<dl compact><dt><b>Parameters:</b></dt><dd>
485  <table border="0" cellspacing="2" cellpadding="0">
486    <tr><td valign=top><em>def</em>&nbsp;</td><td>Defines the bounds of the subregion to return </td></tr>
487  </table>
488</dl>
489<dl compact><dt><b>Returns:</b></dt><dd>A pixel box describing the region and the data in it </dd></dl>
490<dl compact><dt><b>Remarks:</b></dt><dd>This function does not copy any data, it just returns a <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> object with a data pointer pointing somewhere inside the data of object. </dd></dl>
491<dl compact><dt><b>Exceptions:</b></dt><dd>
492  <table border="0" cellspacing="2" cellpadding="0">
493    <tr><td valign=top><em>Exception(ERR_INVALIDPARAMS)</em>&nbsp;</td><td>if def is not fully contained</td></tr>
494  </table>
495</dl>
496    </td>
497  </tr>
498</table>
499<a class="anchor" name="Ogre_1_1PixelBoxa10" doxytag="Ogre::PixelBox::getWidth" ></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"> size_t Ogre::Box::getWidth </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> const<code> [inherited]</code></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>
524Get the width of this box.
525<p>
526
527<p>
528Definition at line <a class="el" href="OgreCommon_8h-source.html#l00290">290</a> of file <a class="el" href="OgreCommon_8h-source.html">OgreCommon.h</a>.
529<p>
530Referenced by <a class="el" href="OgreImageResampler_8h-source.html#l00284">Ogre::LinearResampler_Byte&lt; channels &gt;::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
531  </tr>
532</table>
533<a class="anchor" name="Ogre_1_1PixelBoxa6" doxytag="Ogre::PixelBox::isConsecutive" ></a><p>
534<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
535  <tr>
536    <td class="mdRow">
537      <table cellpadding="0" cellspacing="0" border="0">
538        <tr>
539          <td class="md" nowrap valign="top"> bool Ogre::PixelBox::isConsecutive </td>
540          <td class="md" valign="top">(&nbsp;</td>
541          <td class="mdname1" valign="top" nowrap>          </td>
542          <td class="md" valign="top">&nbsp;)&nbsp;</td>
543          <td class="md" nowrap> const</td>
544        </tr>
545
546      </table>
547    </td>
548  </tr>
549</table>
550<table cellspacing=5 cellpadding=0 border=0>
551  <tr>
552    <td>
553      &nbsp;
554    </td>
555    <td>
556
557<p>
558Return whether this buffer is laid out consecutive in memory (ie the pitches are equal to the dimensions).
559<p>
560
561<p>
562Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00226">226</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.    </td>
563  </tr>
564</table>
565<a class="anchor" name="Ogre_1_1PixelBoxa3" doxytag="Ogre::PixelBox::setConsecutive" ></a><p>
566<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
567  <tr>
568    <td class="mdRow">
569      <table cellpadding="0" cellspacing="0" border="0">
570        <tr>
571          <td class="md" nowrap valign="top"> void Ogre::PixelBox::setConsecutive </td>
572          <td class="md" valign="top">(&nbsp;</td>
573          <td class="mdname1" valign="top" nowrap>          </td>
574          <td class="md" valign="top">&nbsp;)&nbsp;</td>
575          <td class="md" nowrap></td>
576        </tr>
577
578      </table>
579    </td>
580  </tr>
581</table>
582<table cellspacing=5 cellpadding=0 border=0>
583  <tr>
584    <td>
585      &nbsp;
586    </td>
587    <td>
588
589<p>
590Set the rowPitch and slicePitch so that the buffer is laid out consecutive in memory.
591<p>
592
593<p>
594Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00207">207</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.    </td>
595  </tr>
596</table>
597<hr><h2>Member Data Documentation</h2>
598<a class="anchor" name="Ogre_1_1PixelBoxo9" doxytag="Ogre::PixelBox::back" ></a><p>
599<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
600  <tr>
601    <td class="mdRow">
602      <table cellpadding="0" cellspacing="0" border="0">
603        <tr>
604          <td class="md" nowrap valign="top"> size_t <a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo9">Ogre::Box::back</a><code> [inherited]</code>
605      </table>
606    </td>
607  </tr>
608</table>
609<table cellspacing=5 cellpadding=0 border=0>
610  <tr>
611    <td>
612      &nbsp;
613    </td>
614    <td>
615
616<p>
617
618<p>
619Definition at line <a class="el" href="OgreCommon_8h-source.html#l00236">236</a> of file <a class="el" href="OgreCommon_8h-source.html">OgreCommon.h</a>.
620<p>
621Referenced by <a class="el" href="OgreCommon_8h-source.html#l00250">Ogre::Box::Box()</a>, <a class="el" href="OgreCommon_8h-source.html#l00283">Ogre::Box::contains()</a>, <a class="el" href="OgreCommon_8h-source.html#l00294">Ogre::Box::getDepth()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
622  </tr>
623</table>
624<a class="anchor" name="Ogre_1_1PixelBoxo7" doxytag="Ogre::PixelBox::bottom" ></a><p>
625<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
626  <tr>
627    <td class="mdRow">
628      <table cellpadding="0" cellspacing="0" border="0">
629        <tr>
630          <td class="md" nowrap valign="top"> size_t <a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo7">Ogre::Box::bottom</a><code> [inherited]</code>
631      </table>
632    </td>
633  </tr>
634</table>
635<table cellspacing=5 cellpadding=0 border=0>
636  <tr>
637    <td>
638      &nbsp;
639    </td>
640    <td>
641
642<p>
643
644<p>
645Definition at line <a class="el" href="OgreCommon_8h-source.html#l00236">236</a> of file <a class="el" href="OgreCommon_8h-source.html">OgreCommon.h</a>.
646<p>
647Referenced by <a class="el" href="OgreCommon_8h-source.html#l00283">Ogre::Box::contains()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00284">Ogre::LinearResampler_Byte&lt; channels &gt;::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
648  </tr>
649</table>
650<a class="anchor" name="Ogre_1_1PixelBoxo0" doxytag="Ogre::PixelBox::data" ></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"> void* <a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxo0">Ogre::PixelBox::data</a>
657      </table>
658    </td>
659  </tr>
660</table>
661<table cellspacing=5 cellpadding=0 border=0>
662  <tr>
663    <td>
664      &nbsp;
665    </td>
666    <td>
667
668<p>
669The data pointer.
670<p>
671
672<p>
673Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00189">189</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.
674<p>
675Referenced by <a class="el" href="OgreImageResampler_8h-source.html#l00284">Ogre::LinearResampler_Byte&lt; channels &gt;::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
676  </tr>
677</table>
678<a class="anchor" name="Ogre_1_1PixelBoxo1" doxytag="Ogre::PixelBox::format" ></a><p>
679<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
680  <tr>
681    <td class="mdRow">
682      <table cellpadding="0" cellspacing="0" border="0">
683        <tr>
684          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> <a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxo1">Ogre::PixelBox::format</a>
685      </table>
686    </td>
687  </tr>
688</table>
689<table cellspacing=5 cellpadding=0 border=0>
690  <tr>
691    <td>
692      &nbsp;
693    </td>
694    <td>
695
696<p>
697The pixel format.
698<p>
699
700<p>
701Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00191">191</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.
702<p>
703Referenced by <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>.    </td>
704  </tr>
705</table>
706<a class="anchor" name="Ogre_1_1PixelBoxo8" doxytag="Ogre::PixelBox::front" ></a><p>
707<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
708  <tr>
709    <td class="mdRow">
710      <table cellpadding="0" cellspacing="0" border="0">
711        <tr>
712          <td class="md" nowrap valign="top"> size_t <a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo8">Ogre::Box::front</a><code> [inherited]</code>
713      </table>
714    </td>
715  </tr>
716</table>
717<table cellspacing=5 cellpadding=0 border=0>
718  <tr>
719    <td>
720      &nbsp;
721    </td>
722    <td>
723
724<p>
725
726<p>
727Definition at line <a class="el" href="OgreCommon_8h-source.html#l00236">236</a> of file <a class="el" href="OgreCommon_8h-source.html">OgreCommon.h</a>.
728<p>
729Referenced by <a class="el" href="OgreCommon_8h-source.html#l00250">Ogre::Box::Box()</a>, <a class="el" href="OgreCommon_8h-source.html#l00283">Ogre::Box::contains()</a>, <a class="el" href="OgreCommon_8h-source.html#l00294">Ogre::Box::getDepth()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
730  </tr>
731</table>
732<a class="anchor" name="Ogre_1_1PixelBoxo4" doxytag="Ogre::PixelBox::left" ></a><p>
733<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
734  <tr>
735    <td class="mdRow">
736      <table cellpadding="0" cellspacing="0" border="0">
737        <tr>
738          <td class="md" nowrap valign="top"> size_t <a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo4">Ogre::Box::left</a><code> [inherited]</code>
739      </table>
740    </td>
741  </tr>
742</table>
743<table cellspacing=5 cellpadding=0 border=0>
744  <tr>
745    <td>
746      &nbsp;
747    </td>
748    <td>
749
750<p>
751
752<p>
753Definition at line <a class="el" href="OgreCommon_8h-source.html#l00236">236</a> of file <a class="el" href="OgreCommon_8h-source.html">OgreCommon.h</a>.
754<p>
755Referenced by <a class="el" href="OgreCommon_8h-source.html#l00283">Ogre::Box::contains()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00284">Ogre::LinearResampler_Byte&lt; channels &gt;::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
756  </tr>
757</table>
758<a class="anchor" name="Ogre_1_1PixelBoxo6" doxytag="Ogre::PixelBox::right" ></a><p>
759<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
760  <tr>
761    <td class="mdRow">
762      <table cellpadding="0" cellspacing="0" border="0">
763        <tr>
764          <td class="md" nowrap valign="top"> size_t <a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo6">Ogre::Box::right</a><code> [inherited]</code>
765      </table>
766    </td>
767  </tr>
768</table>
769<table cellspacing=5 cellpadding=0 border=0>
770  <tr>
771    <td>
772      &nbsp;
773    </td>
774    <td>
775
776<p>
777
778<p>
779Definition at line <a class="el" href="OgreCommon_8h-source.html#l00236">236</a> of file <a class="el" href="OgreCommon_8h-source.html">OgreCommon.h</a>.
780<p>
781Referenced by <a class="el" href="OgreCommon_8h-source.html#l00283">Ogre::Box::contains()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00284">Ogre::LinearResampler_Byte&lt; channels &gt;::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
782  </tr>
783</table>
784<a class="anchor" name="Ogre_1_1PixelBoxo2" doxytag="Ogre::PixelBox::rowPitch" ></a><p>
785<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
786  <tr>
787    <td class="mdRow">
788      <table cellpadding="0" cellspacing="0" border="0">
789        <tr>
790          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxo2">Ogre::PixelBox::rowPitch</a>
791      </table>
792    </td>
793  </tr>
794</table>
795<table cellspacing=5 cellpadding=0 border=0>
796  <tr>
797    <td>
798      &nbsp;
799    </td>
800    <td>
801
802<p>
803Number of elements between the leftmost pixel of one row and the left pixel of the next.
804<p>
805This value must always be equal to <a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxa10">getWidth()</a> (consecutive) for compressed formats.
806<p>
807Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00196">196</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.
808<p>
809Referenced by <a class="el" href="OgreImageResampler_8h-source.html#l00284">Ogre::LinearResampler_Byte&lt; channels &gt;::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
810  </tr>
811</table>
812<a class="anchor" name="Ogre_1_1PixelBoxo3" doxytag="Ogre::PixelBox::slicePitch" ></a><p>
813<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
814  <tr>
815    <td class="mdRow">
816      <table cellpadding="0" cellspacing="0" border="0">
817        <tr>
818          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1PixelBox.html#Ogre_1_1PixelBoxo3">Ogre::PixelBox::slicePitch</a>
819      </table>
820    </td>
821  </tr>
822</table>
823<table cellspacing=5 cellpadding=0 border=0>
824  <tr>
825    <td>
826      &nbsp;
827    </td>
828    <td>
829
830<p>
831Number of elements between the top left pixel of one (depth) slice and the top left pixel of the next.
832<p>
833This can be a negative value. Must be a multiple of rowPitch. This value must always be equal to <a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxa10">getWidth()</a>*getHeight() (consecutive) for compressed formats.
834<p>
835Definition at line <a class="el" href="OgrePixelFormat_8h-source.html#l00202">202</a> of file <a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a>.
836<p>
837Referenced by <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
838  </tr>
839</table>
840<a class="anchor" name="Ogre_1_1PixelBoxo5" doxytag="Ogre::PixelBox::top" ></a><p>
841<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
842  <tr>
843    <td class="mdRow">
844      <table cellpadding="0" cellspacing="0" border="0">
845        <tr>
846          <td class="md" nowrap valign="top"> size_t <a class="el" href="structOgre_1_1Box.html#Ogre_1_1PixelBoxo5">Ogre::Box::top</a><code> [inherited]</code>
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>
859
860<p>
861Definition at line <a class="el" href="OgreCommon_8h-source.html#l00236">236</a> of file <a class="el" href="OgreCommon_8h-source.html">OgreCommon.h</a>.
862<p>
863Referenced by <a class="el" href="OgreCommon_8h-source.html#l00283">Ogre::Box::contains()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00284">Ogre::LinearResampler_Byte&lt; channels &gt;::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00176">Ogre::LinearResampler_Float32::scale()</a>, <a class="el" href="OgreImageResampler_8h-source.html#l00093">Ogre::LinearResampler::scale()</a>, and <a class="el" href="OgreImageResampler_8h-source.html#l00053">Ogre::NearestResampler&lt; elemsize &gt;::scale()</a>.    </td>
864  </tr>
865</table>
866<hr>The documentation for this class was generated from the following file:<ul>
867<li><a class="el" href="OgrePixelFormat_8h-source.html">OgrePixelFormat.h</a></ul>
868<hr>
869<p>
870Copyright &copy; 2000-2005 by The OGRE Team<br />
871<!--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/>
872This 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/>
873                <!--/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#">
874                <Work rdf:about="">
875                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
876        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
877                </Work>
878                <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> -->
879
880Last modified Sun Feb 12 13:02:07 2006
881</p>
882</body>
883</html>
Note: See TracBrowser for help on using the repository browser.