#include <OgrePixelFormat.h>
Inheritance diagram for Ogre::PixelBox:
Public Member Functions | |
PixelBox () | |
Parameter constructor for setting the members manually. | |
PixelBox (const Box &extents, PixelFormat pixelFormat, void *pixelData=0) | |
Constructor providing extents in the form of a Box object. | |
PixelBox (size_t width, size_t height, size_t depth, PixelFormat pixelFormat, void *pixelData=0) | |
Constructor providing width, height and depth. | |
void | setConsecutive () |
Set the rowPitch and slicePitch so that the buffer is laid out consecutive in memory. | |
size_t | getRowSkip () const |
Get the number of elements between one past the rightmost pixel of one row and the leftmost pixel of the next row. | |
size_t | getSliceSkip () const |
Get the number of elements between one past the right bottom pixel of one slice and the left top pixel of the next slice. | |
bool | isConsecutive () const |
Return whether this buffer is laid out consecutive in memory (ie the pitches are equal to the dimensions). | |
size_t | getConsecutiveSize () const |
Return the size (in bytes) this image would take if it was laid out consecutive in memory. | |
PixelBox | getSubVolume (const Box &def) const |
Return a subvolume of this PixelBox. | |
bool | contains (const Box &def) const |
Return true if the other box is a part of this one. | |
size_t | getWidth () const |
Get the width of this box. | |
size_t | getHeight () const |
Get the height of this box. | |
size_t | getDepth () const |
Get the depth of this box. | |
Public Attributes | |
void * | data |
The data pointer. | |
PixelFormat | format |
The pixel format. | |
size_t | rowPitch |
Number of elements between the leftmost pixel of one row and the left pixel of the next. | |
size_t | slicePitch |
Number of elements between the top left pixel of one (depth) slice and the top left pixel of the next. | |
size_t | left |
size_t | top |
size_t | right |
size_t | bottom |
size_t | front |
size_t | back |
In case of a rectangle, depth must be 1. Pixels are stored as a succession of "depth" slices, each containing "height" rows of "width" pixels.
Definition at line 179 of file OgrePixelFormat.h.
|
Parameter constructor for setting the members manually.
Definition at line 182 of file OgrePixelFormat.h. |
|
Constructor providing extents in the form of a Box object. This constructor assumes the pixel data is laid out consecutively in memory. (this means row after row, slice after slice, with no space in between)
Definition at line 190 of file OgrePixelFormat.h. |
|
Constructor providing width, height and depth. This constructor assumes the pixel data is laid out consecutively in memory. (this means row after row, slice after slice, with no space in between)
Definition at line 204 of file OgrePixelFormat.h. |
|
Return true if the other box is a part of this one.
Definition at line 393 of file OgreCommon.h. References Ogre::Box::back, Ogre::Box::bottom, Ogre::Box::front, Ogre::Box::left, Ogre::Box::right, and Ogre::Box::top. |
|
Return the size (in bytes) this image would take if it was laid out consecutive in memory.
|
|
Get the depth of this box.
Definition at line 404 of file OgreCommon.h. References Ogre::Box::back, and Ogre::Box::front. |
|
Get the height of this box.
Definition at line 402 of file OgreCommon.h. References Ogre::Box::bottom, and Ogre::Box::top. |
|
Get the number of elements between one past the rightmost pixel of one row and the leftmost pixel of the next row. (IE this is zero if rows are consecutive). Definition at line 239 of file OgrePixelFormat.h. |
|
Get the number of elements between one past the right bottom pixel of one slice and the left top pixel of the next slice. (IE this is zero if slices are consecutive). Definition at line 244 of file OgrePixelFormat.h. |
|
Return a subvolume of this PixelBox.
|
|
Get the width of this box.
Definition at line 400 of file OgreCommon.h. References Ogre::Box::left, and Ogre::Box::right. |
|
Return whether this buffer is laid out consecutive in memory (ie the pitches are equal to the dimensions).
Definition at line 249 of file OgrePixelFormat.h. |
|
Set the rowPitch and slicePitch so that the buffer is laid out consecutive in memory.
Definition at line 230 of file OgrePixelFormat.h. |
|
Definition at line 346 of file OgreCommon.h. Referenced by Ogre::Box::Box(), Ogre::Box::contains(), and Ogre::Box::getDepth(). |
|
Definition at line 346 of file OgreCommon.h. Referenced by Ogre::Box::Box(), Ogre::Box::contains(), and Ogre::Box::getHeight(). |
|
The data pointer.
Definition at line 212 of file OgrePixelFormat.h. |
|
The pixel format.
Definition at line 214 of file OgrePixelFormat.h. |
|
Definition at line 346 of file OgreCommon.h. Referenced by Ogre::Box::Box(), Ogre::Box::contains(), and Ogre::Box::getDepth(). |
|
Definition at line 346 of file OgreCommon.h. Referenced by Ogre::Box::Box(), Ogre::Box::contains(), and Ogre::Box::getWidth(). |
|
Definition at line 346 of file OgreCommon.h. Referenced by Ogre::Box::Box(), Ogre::Box::contains(), and Ogre::Box::getWidth(). |
|
Number of elements between the leftmost pixel of one row and the left pixel of the next. This value must always be equal to getWidth() (consecutive) for compressed formats. Definition at line 219 of file OgrePixelFormat.h. |
|
Number of elements between the top left pixel of one (depth) slice and the top left pixel of the next. This can be a negative value. Must be a multiple of rowPitch. This value must always be equal to getWidth()*getHeight() (consecutive) for compressed formats. Definition at line 225 of file OgrePixelFormat.h. |
|
Definition at line 346 of file OgreCommon.h. Referenced by Ogre::Box::Box(), Ogre::Box::contains(), and Ogre::Box::getHeight(). |
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Aug 20 13:54:21 2007