For cubemaps, the face is in sliceStart, (see CubemapSide::CubemapSide) For cubemap arrays, the cubemaps are addressed as sliceStart * 6.
More...
#include <OgreTextureBox.h>
|
| | TextureBox () |
| |
| | TextureBox (uint32 _width, uint32 _height, uint32 _depth, uint32 _numSlices, uint32 _bytesPerPixel, uint32 _bytesPerRow, size_t _bytesPerImage) |
| |
| void * | at (size_t xPos, size_t yPos, size_t zPos) const |
| | x, y & z are in pixels.
|
| |
| 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.
|
| |
| bool | fullyContains (const TextureBox &other) const |
| | Returns true if 'other' fits inside 'this' (fully, not partially)
|
| |
| ColourValue | getColourAt (size_t _x, size_t _y, size_t _z, PixelFormatGpu pixelFormat) const |
| | Get colour value from a certain location in the image.
|
| |
| 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.
|
| |
| bool | overlaps (const TextureBox &other) const |
| | Returns true if 'this' and 'other' are in partial or full collision.
|
| |
| 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.
|
| |
| void | setCompressedPixelFormat (PixelFormatGpu pixelFormat) |
| |
For cubemaps, the face is in sliceStart, (see CubemapSide::CubemapSide) For cubemap arrays, the cubemaps are addressed as sliceStart * 6.
◆ TextureBox() [1/2]
| Ogre::TextureBox::TextureBox |
( |
| ) |
|
|
inline |
◆ TextureBox() [2/2]
◆ at()
| void * Ogre::TextureBox::at |
( |
size_t | xPos, |
|
|
size_t | yPos, |
|
|
size_t | zPos ) const |
|
inline |
x, y & z are in pixels.
Only works for non-compressed formats. It can work for compressed formats if xPos & yPos are 0.
Referenced by copyFrom().
◆ atFromOffsettedOrigin()
| void * Ogre::TextureBox::atFromOffsettedOrigin |
( |
size_t | xPos, |
|
|
size_t | yPos, |
|
|
size_t | zPos ) const |
|
inline |
◆ copyFrom() [1/2]
| void Ogre::TextureBox::copyFrom |
( |
const TextureBox & | src | ) |
|
|
inline |
◆ copyFrom() [2/2]
| void Ogre::TextureBox::copyFrom |
( |
const void * | srcData, |
|
|
uint32 | _width, |
|
|
uint32 | _height, |
|
|
uint32 | _bytesPerRow ) |
|
inline |
◆ equalSize()
| bool Ogre::TextureBox::equalSize |
( |
const TextureBox & | other | ) |
const |
|
inline |
◆ fullyContains()
| bool Ogre::TextureBox::fullyContains |
( |
const TextureBox & | other | ) |
const |
|
inline |
◆ getColourAt()
Get colour value from a certain location in the image.
◆ getCompressedPixelFormat()
◆ getDepthOrSlices()
| uint32 Ogre::TextureBox::getDepthOrSlices |
( |
| ) |
const |
|
inline |
◆ getMaxSlice()
| uint32 Ogre::TextureBox::getMaxSlice |
( |
| ) |
const |
|
inline |
◆ getMaxX()
| uint32 Ogre::TextureBox::getMaxX |
( |
| ) |
const |
|
inline |
◆ getMaxY()
| uint32 Ogre::TextureBox::getMaxY |
( |
| ) |
const |
|
inline |
◆ getMaxZ()
| uint32 Ogre::TextureBox::getMaxZ |
( |
| ) |
const |
|
inline |
◆ getSizeBytes()
| size_t Ogre::TextureBox::getSizeBytes |
( |
| ) |
const |
|
inline |
◆ getZOrSlice()
| uint32 Ogre::TextureBox::getZOrSlice |
( |
| ) |
const |
|
inline |
◆ isCompressed()
| bool Ogre::TextureBox::isCompressed |
( |
| ) |
const |
|
inline |
◆ isSubtextureRegion()
| bool Ogre::TextureBox::isSubtextureRegion |
( |
| ) |
const |
|
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.
Referenced by copyFrom().
◆ overlaps()
| bool Ogre::TextureBox::overlaps |
( |
const TextureBox & | other | ) |
const |
|
inline |
◆ setColourAt()
Set colour value at a certain location in the image.
◆ setCompressedPixelFormat()
| void Ogre::TextureBox::setCompressedPixelFormat |
( |
PixelFormatGpu | pixelFormat | ) |
|
|
inline |
◆ bytesPerImage
| size_t Ogre::TextureBox::bytesPerImage |
◆ bytesPerPixel
| uint32 Ogre::TextureBox::bytesPerPixel |
When TextureBox contains a compressed format, bytesPerPixel contains the pixel format instead.
See getCompressedPixelFormat.
◆ bytesPerRow
| uint32 Ogre::TextureBox::bytesPerRow |
◆ data
| 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().
◆ depth
| uint32 Ogre::TextureBox::depth |
◆ height
| uint32 Ogre::TextureBox::height |
◆ numSlices
| uint32 Ogre::TextureBox::numSlices |
◆ sliceStart
| uint32 Ogre::TextureBox::sliceStart |
◆ width
| uint32 Ogre::TextureBox::width |
The documentation for this struct was generated from the following file: