ImgLockPageIterator Class Reference
ImgLockPageIterator Class Reference
Related help topics: #include <image.h>
Class Description
Iterate over a specified region of an image in optimal order, and locking it in CPU memory.
Inheritance diagram for ImgLockPageIterator:
Public Types | |
| enum | AccessMode { ReadOnly, ReadWrite, WriteOnly } |
Public Member Functions | |
| ImgLockPageIterator (Image *img, const ImgTile *srcTile=0, AccessMode mode=ReadOnly) | |
| ~ImgLockPageIterator () | |
| virtual bool | next () |
| void * | dataPtr () |
| Public Member Functions inherited from ImgPageIterator | |
| ImgPageIterator (Image *img, const ImgTile *srcTile=0, bool writing=false) | |
| Create an iterator to cover the specified region of the image. More... | |
| virtual | ~ImgPageIterator () |
| void * | dataPtr () |
| Public Member Functions inherited from ImgTile | |
| ImgTile () | |
| Create a default empty tile. More... | |
| ImgTile (int X, int Y, int NX, int NY) | |
| Create a tile as specified in the parameters. More... | |
| ImgTile (const ImgTile &a, const ImgTile &b) | |
| Construct a tile by computing the intersection fo the two input tiles. More... | |
| bool | isEqualTile (const ImgTile &t) const |
| bool | operator== (const ImgTile &t) const |
| bool | operator!= (const ImgTile &t) const |
| bool | isEmpty () const |
| return true of this tile is empty More... | |
| void | setEmpty () |
| bool | contains (const ImgTile &a) const |
| return true if this tile includes the specified tile More... | |
| bool | contains (int x_, int y_) const |
| return true if this tile includes the specified point More... | |
| void | clipPositive () |
| Clip the tile so it will not extend into the negative quadrants. More... | |
| void | ExpandToInclude (int x_, int y_) |
| Expand this tile to include the specified point. More... | |
| void | Expand (int numPixels=1) |
| Grow the tile by the specified number of pixels on all 4 sides. More... | |
| int | numPixels () const |
| return the number of pixels contained in this tile More... | |
Protected Attributes | |
| bool | m_SmartImage |
| AccessMode | m_Mode |
| Protected Attributes inherited from ImgPageIterator | |
| void * | m_BlindData |
| Image * | m_Image |
| int | m_Type |
| void * | m_PixelData |
| ImgTile | m_SrcTile |
Additional Inherited Members | |
| Public Attributes inherited from ImgTile | |
| int | x |
| x origin of the tile More... | |
| int | y |
| y origin of the tile More... | |
| int | nx |
| x size of the tile (width) More... | |
| int | ny |
| y size of the tile (height) More... | |
Member Enumeration Documentation
| enum AccessMode |
| Enumerator | |
|---|---|
| ReadOnly |
A promise that the data in this page will not be modified. |
| ReadWrite |
self explanitory |
| WriteOnly |
The page data will be allocated bye the contents will be undefined. |
Definition at line 1227 of file image.h.
The page data will be allocated bye the contents will be undefined.
Definition: image.h:1230
A promise that the data in this page will not be modified.
Definition: image.h:1228
Constructor & Destructor Documentation
| ImgLockPageIterator | ( | Image * | img, |
| const ImgTile * | srcTile = 0, |
||
| AccessMode | mode = ReadOnly |
||
| ) |
| ~ImgLockPageIterator | ( | ) |
Member Function Documentation
|
virtual |
Reimplemented from ImgPageIterator.
| void* dataPtr | ( | ) |
Member Data Documentation
|
protected |
The documentation for this class was generated from the following file:
- Mudbox/image.h