![]() |
OGRE-Next
2.3
Object-Oriented Graphics Rendering Engine
|
For cubemaps, the face is in sliceStart, (see CubemapSide::CubemapSide) For cubemap arrays, the cubemaps are addressed as sliceStart * 6. More...
#include <OgreTextureBox.h>
Public Member Functions | |
TextureBox () | |
TextureBox (uint32 _width, uint32 _height, uint32 _depth, uint32 _numSlices, uint32 _bytesPerPixel, uint32 _bytesPerRow, uint32 _bytesPerImage) | |
void * | at (size_t xPos, size_t yPos, size_t zPos) const |
x, y & z are in pixels. More... | |
void * | atFromOffsettedOrigin (size_t xPos, size_t yPos, size_t zPos) const |
void | copyFrom (const TextureBox &src) |
void | copyFrom (const void *srcData, uint32 _width, uint32 _height, uint32 _bytesPerRow) |
bool | equalSize (const TextureBox &other) const |
Returns true if 'other' & 'this' have the same dimensions. More... | |
bool | fullyContains (const TextureBox &other) const |
Returns true if 'other' fits inside 'this' (fully, not partially) More... | |
ColourValue | getColourAt (size_t _x, size_t _y, size_t _z, PixelFormatGpu pixelFormat) const |
Get colour value from a certain location in the image. More... | |
PixelFormatGpu | getCompressedPixelFormat () const |
uint32 | getDepthOrSlices () const |
uint32 | getMaxSlice () const |
uint32 | getMaxX () const |
uint32 | getMaxY () const |
uint32 | getMaxZ () const |
size_t | getSizeBytes () const |
uint32 | getZOrSlice () const |
bool | isCompressed () const |
bool | isSubtextureRegion () const |
Returns true if this TextureBox does not represent a contiguous region of a single slice of full texture, and is instead a 2D subregion of a larger texture. More... | |
bool | overlaps (const TextureBox &other) const |
Returns true if 'this' and 'other' are in partial or full collision. More... | |
void | setColourAt (const ColourValue &cv, size_t _x, size_t _y, size_t _z, PixelFormatGpu pixelFormat) |
Set colour value at a certain location in the image. More... | |
void | setCompressedPixelFormat (PixelFormatGpu pixelFormat) |
Public Attributes | |
size_t | bytesPerImage |
size_t | bytesPerPixel |
When TextureBox contains a compressed format, bytesPerPixel contains the pixel format instead. More... | |
size_t | bytesPerRow |
void * | data |
Pointer is never owned by us. More... | |
uint32 | depth |
uint32 | height |
uint32 | numSlices |
uint32 | sliceStart |
uint32 | width |
uint32 | x |
uint32 | y |
uint32 | z |
For cubemaps, the face is in sliceStart, (see CubemapSide::CubemapSide) For cubemap arrays, the cubemaps are addressed as sliceStart * 6.
|
inline |
|
inline |
|
inline |
x, y & z are in pixels.
Only works for non-compressed formats. It can work for compressed formats if xPos & yPos are 0.
References Ogre::PixelFormatGpuUtils::getCompressedBlockHeight(), Ogre::PixelFormatGpuUtils::getCompressedBlockSize(), and Ogre::PixelFormatGpuUtils::getCompressedBlockWidth().
Referenced by copyFrom().
|
inline |
|
inline |
|
inline |
References data.
|
inline |
|
inline |
Returns true if 'other' fits inside 'this' (fully, not partially)
References getMaxSlice(), getMaxX(), getMaxY(), getMaxZ(), sliceStart, x, y, and z.
ColourValue Ogre::TextureBox::getColourAt | ( | size_t | _x, |
size_t | _y, | ||
size_t | _z, | ||
PixelFormatGpu | pixelFormat | ||
) | const |
Get colour value from a certain location in the image.
|
inline |
References Ogre::PFG_UNKNOWN.
|
inline |
|
inline |
Referenced by fullyContains(), and overlaps().
|
inline |
Referenced by fullyContains(), and overlaps().
|
inline |
Referenced by fullyContains(), and overlaps().
|
inline |
Referenced by fullyContains(), and overlaps().
|
inline |
|
inline |
Referenced by copyFrom().
|
inline |
|
inline |
Returns true if this TextureBox does not represent a contiguous region of a single slice of full texture, and is instead a 2D subregion of a larger texture.
References Ogre::PixelFormatGpuUtils::getCompressedBlockHeight(), Ogre::PixelFormatGpuUtils::getCompressedBlockSize(), and Ogre::PixelFormatGpuUtils::getCompressedBlockWidth().
Referenced by copyFrom().
|
inline |
Returns true if 'this' and 'other' are in partial or full collision.
References getMaxSlice(), getMaxX(), getMaxY(), getMaxZ(), sliceStart, x, y, and z.
void Ogre::TextureBox::setColourAt | ( | const ColourValue & | cv, |
size_t | _x, | ||
size_t | _y, | ||
size_t | _z, | ||
PixelFormatGpu | pixelFormat | ||
) |
Set colour value at a certain location in the image.
|
inline |
References Ogre::PixelFormatGpuUtils::isCompressed().
size_t Ogre::TextureBox::bytesPerImage |
size_t Ogre::TextureBox::bytesPerPixel |
When TextureBox contains a compressed format, bytesPerPixel contains the pixel format instead.
See getCompressedPixelFormat.
size_t Ogre::TextureBox::bytesPerRow |
void* Ogre::TextureBox::data |
Pointer is never owned by us.
Do not alter where data points to (e.g. do not increment it)
Referenced by copyFrom().
uint32 Ogre::TextureBox::depth |
uint32 Ogre::TextureBox::height |
uint32 Ogre::TextureBox::numSlices |
Referenced by equalSize().
uint32 Ogre::TextureBox::sliceStart |
Referenced by fullyContains(), and overlaps().
uint32 Ogre::TextureBox::width |
uint32 Ogre::TextureBox::x |
Referenced by copyFrom(), fullyContains(), and overlaps().
uint32 Ogre::TextureBox::y |
Referenced by copyFrom(), fullyContains(), and overlaps().
uint32 Ogre::TextureBox::z |
Referenced by fullyContains(), and overlaps().