Image Class Reference

mudbox::Image::m_bDownsampleProxyTo8Bit

ImageDescriptor m_Descriptor

Definition: image.h:1543

void setProxyDownsampleTo8Bit ( bool downsampleTo8Bit = true )

inline

The default when generating proxys is to downsample them to 8 bit/channel this can make them significantly smaller.

This is not appropriate for bump or normal maps where greater precision is required. This API lets you turn off the downsampling on a per image basis

Definition at line 1608 of file image.h.

     { 
         if (m_bDownsampleProxyTo8Bit != downsampleTo8Bit) {
             m_bDownsampleProxyTo8Bit = downsampleTo8Bit; 
             markProxyDirty();
         }
     }

bool getProxyDownsampleTo8Bit ( ) const

inline

Definition at line 1616 of file image.h.

1616 { return m_bDownsampleProxyTo8Bit; }

bool m_bDownsampleProxyTo8Bit

Definition: image.h:1549

void clearProxyImages ( )

inline

clear and deallocate any proxy images.

Definition at line 1619 of file image.h.

1619 { markProxyDirty(); }

mudbox::Image::markProxyDirty

void markProxyDirty()

Definition: image.h:1553

void SetProxyInterruptFunction ( ProxyInterruptFunction fcnPtr = 0 )

inline

When generating proxy images, periodically, the interrupt function will be polled.

if it returns true, the proxy generation will be interrupted. Any work done in this function should complete very quickly. (budget no more than 10 milliseconds)

Definition at line 1624 of file image.h.

1625 { m_pProxyIntFcn = fcnPtr; }

mudbox::Image::m_pProxyIntFcn

ProxyInterruptFunction m_pProxyIntFcn

Definition: image.h:1551

unsigned char getProxyLevel ( ) const

inline

get the Proxy level of the image – 0 = no proxying.

1 = 0.5x, 2 = 0.25x, 3 = 0.125x.

Note: Currently only tiled images may be proxied. Attempting to set a non 0 proxy level on any other type of image will result in an exception being thrown.

Definition at line 1635 of file image.h.

1635 { return m_ProxyLevel; }

mudbox::Image::m_ProxyLevel

unsigned char m_ProxyLevel

Definition: image.h:1547

bool setProxyLevel ( unsigned char newLevel )

inline

set the current proxy level

Definition at line 1638 of file image.h.

                                                       { 
         if ( xSize()>>newLevel == 0 || ySize()>>newLevel == 0 )
             return false;
         if (newLevel > MAX_PROXY_LEVEL) newLevel = MAX_PROXY_LEVEL;
         if (newLevel != m_ProxyLevel) {
             m_ProxyLevel = newLevel;
         }
 
         return true;
     }

Image* getProxyImage ( )

inline

get the proxy image.

If the proxy level is 0, it just returns this image. If the proxy is dirty, it gets regenerated first before returning. Note – if the interrupt function is set, and the generation of the proxy is interrupted, this will return NULL

Definition at line 1654 of file image.h.

     {
         if (m_ProxyLevel == 0) return this;
         
         if ( m_pProxyImages[m_ProxyLevel] ) return m_pProxyImages[m_ProxyLevel];
         
         bool generated = regenerateProxy();
         if (!generated && m_pProxyImages[m_ProxyLevel] != 0) {
             delete m_pProxyImages[m_ProxyLevel];
             m_pProxyImages[m_ProxyLevel] = 0;
         }
         return m_pProxyImages[m_ProxyLevel];
     }

int xSize ( ) const

inline

Get the x size of the image.

Definition at line 1669 of file image.h.

1669 { return m_Descriptor.xSize(); }

mudbox::ImageDescriptor::xSize

ImageDescriptor m_Descriptor

Definition: image.h:1543

int xSize() const

return the x Size of the image

Definition: image.h:1421

int ySize ( ) const

inline

Get the y size of the image.

Definition at line 1672 of file image.h.

1672 { return m_Descriptor.ySize(); }

mudbox::ImageDescriptor::ySize

ImageDescriptor m_Descriptor

Definition: image.h:1543

int ySize() const

return the y Size of the image

Definition: image.h:1424

int cSize ( ) const

inline

Get the channel count of the image.

Definition at line 1675 of file image.h.

1675 { return m_Descriptor.cSize(); }

mudbox::ImageDescriptor::cSize

ImageDescriptor m_Descriptor

Definition: image.h:1543

int cSize() const

return the channel count of the image

Definition: image.h:1427

int curWidth ( ) const

inline

get the width of the current proxy level of the image

Definition at line 1678 of file image.h.

1678 { return Width() >> getProxyLevel(); }

mudbox::Image::Width

virtual unsigned int Width(void) const

Return the width of the image in pixels.

mudbox::Image::getProxyLevel

unsigned char getProxyLevel() const

get the Proxy level of the image – 0 = no proxying.

Definition: image.h:1635

int curHeight ( ) const

inline

get the height of the current proxy level of the image

Definition at line 1681 of file image.h.

1681 { return Height() >> getProxyLevel(); }

mudbox::Image::Height

virtual unsigned int Height(void) const

Return the height of the image in pixels.

mudbox::Image::getProxyLevel

unsigned char getProxyLevel() const

get the Proxy level of the image – 0 = no proxying.

Definition: image.h:1635

ImageDescriptor::MemoryChannelOrder channelOrder ( ) const

inline

Get the channel ordering of the image.

Definition at line 1684 of file image.h.

1684 { return m_Descriptor.m_channelOrder; }

mudbox::PixelDescriptor::m_channelOrder

ImageDescriptor m_Descriptor

Definition: image.h:1543

MemoryChannelOrder m_channelOrder

channel ordering

Definition: image.h:1286

const ImgTile& getBounds ( ) const

inline

returns the bounds of the image – the origin of this rect may not be at 0,0

Definition at line 1687 of file image.h.

1687 { return m_Descriptor.getBounds(); }

mudbox::ImageDescriptor::getBounds

ImageDescriptor m_Descriptor

Definition: image.h:1543

const ImgTile & getBounds() const

return the bounds of the image

Definition: image.h:1439

void getFillColor	(	void *	fillPixel,
		const PixelDescriptor *	pd = `0`
	)		const

Reads the fill color into the provided buffer, in the specified format – if no format is provided, it uses the pixel format of this image.

Parameters

fillPixel	Pointer to the target where the fill color will be written
pd	Desired pixelformat for the fill color – if 0, it uses the pixel format of this image

void setFillColor	(	const void *	fillPixel,
		const PixelDescriptor *	pd = `0`
	)

Sets the fill color into the provided buffer, in the specified format – if no format is provided, it uses the pixel format of this image.

Parameters

fillPixel	Pointer to the source where the fill color will be read from
pd	Desired pixelformat for the fill color – if 0, it uses the pixel format of this image

void getTile	(	int	x,
		int	y,
		int	nx,
		int	ny,
		void *	data,
		const PixelDescriptor *	pd = `0`
	)

inline

Reads a rectangular region of pixels from the image into a buffer.

The buffer must be exactly the size of the region being read. If the region is outside or partly outside the bounds of the image, those areas of the target buffer will be filled with the image's FillColor

Note: this operation is atomic – no other threads can write to the image while this is being performed.

Parameters

x	x coord of the lower left corner of the region to be read.
y	y coord of the lower left corner of the region to be read.
nx	width of the region to be read.
ny	height of the region to be read.
data	Pointer to the target buffer.
pd	Desired pixelformat for the buffer color – if 0, it uses the pixel format of this image

Definition at line 1733 of file image.h.

1735 { getTile(ImgTile(x, y, nx, ny), data, pd); }

GLenum GLint GLint y

Definition: GLee.h:876

GLfloat ny

Definition: GLee.h:5410

GLsizei GLsizei GLenum GLenum const GLvoid * data

Definition: GLee.h:880

GLenum GLint x

Definition: GLee.h:876

GLfloat GLfloat GLfloat GLfloat nx

Definition: GLee.h:5412

mudbox::Image::getTile

void getTile(int x, int y, int nx, int ny, void *data, const PixelDescriptor *pd=0)

Reads a rectangular region of pixels from the image into a buffer.

Definition: image.h:1733

void getSubTile	(	int	x,
		int	y,
		int	nx,
		int	ny,
		void *	data,
		int	dx,
		int	dy,
		int	dnx,
		int	dny,
		const PixelDescriptor *	pd = `0`
	)

inline

Reads a rectangular region of pixels from the image into a buffer.

The buffer may be be different than the size of the region being read. If the region is outside or partly outside the bounds of the image, those areas of the target buffer will be filled with the image's FillColor

Note: this operation is atomic – no other threads can write to the image while this is being performed.

Parameters

x	x coord of the lower left corner of the region to be read.
y	y coord of the lower left corner of the region to be read.
nx	width of the region to be read.
ny	height of the region to be read.
data	Pointer to the target buffer.
dx	x coord of the lower left corner of the buffer (in image coords).
dy	y coord of the lower left corner of the buffer (in image coords).
dnx	width of the target buffer.
dny	height of the target buffer.
pd	Desired pixelformat for the buffer color – if 0, it uses the pixel format of this image

Definition at line 1762 of file image.h.

1765 { getSubTile(ImgTile(x, y, nx, ny), data, ImgTile(dx, dy, dnx, dny), pd); }

GLenum GLint GLint y

Definition: GLee.h:876

dy

int int int int * dy

Definition: GLee.h:10535

GLfloat ny

Definition: GLee.h:5410

GLsizei GLsizei GLenum GLenum const GLvoid * data

Definition: GLee.h:880

mudbox::Image::getSubTile

GLenum GLint x

Definition: GLee.h:876

void getSubTile(int x, int y, int nx, int ny, void *data, int dx, int dy, int dnx, int dny, const PixelDescriptor *pd=0)

Reads a rectangular region of pixels from the image into a buffer.

Definition: image.h:1762

GLfloat GLfloat GLfloat GLfloat nx

Definition: GLee.h:5412

dx

int int int * dx

Definition: GLee.h:10535

void getTile	(	const ImgTile &	srcTile,
		void *	data,
		const PixelDescriptor *	pd = `0`
	)

inline

Reads a rectangular region of pixels from the image into a buffer.

The buffer must be exactly the size of the region being read. If the region is outside or partly outside the bounds of the image, those areas of the target buffer will be filled with the image's FillColor

Note: this operation is atomic – no other threads can write to the image while this is being performed.

Parameters

srcTile	the rectangle of the image to be read into the buffer.
data	Pointer to the target buffer.
pd	Desired pixelformat for the buffer color – if 0, it uses the pixel format of this image

Definition at line 1784 of file image.h.

1786 { getSubTile(srcTile, data, srcTile, pd); }

mudbox::Image::getSubTile

GLsizei GLsizei GLenum GLenum const GLvoid * data

Definition: GLee.h:880

void getSubTile(int x, int y, int nx, int ny, void *data, int dx, int dy, int dnx, int dny, const PixelDescriptor *pd=0)

Reads a rectangular region of pixels from the image into a buffer.

Definition: image.h:1762

virtual void getSubTile	(	const ImgTile &	srcTile,
		void *	data,
		const ImgTile &	targetBounds,
		const PixelDescriptor *	pd = `0`
	)

virtual

Reads a rectangular region of pixels from the image into a buffer.

The buffer may be be different than the size of the region being read. If the region is outside or partly outside the bounds of the image, those areas of the target buffer will be filled with the image's FillColor

Note: this operation is atomic – no other threads can write to the image while this is being performed.; this is the only member of the getTile family that must be provided by subclasses of this Image class.

Parameters

srcTile	The rectangle of the image to be read into the buffer.
data	Pointer to the target buffer.
targetBounds	bounds of the target buffer (in image coords).
pd	Desired pixelformat for the buffer color – if 0, it uses the pixel format of this image

void setTile	(	int	x,
		int	y,
		int	nx,
		int	ny,
		void *	data,
		const PixelDescriptor *	pd = `0`
	)

inline

Writes a rectangular region of pixels to the image from a buffer.

The buffer must be exactly the size of the region being written. If the image has dynamic bounds, the image bounds will be expanded as required so that the entire operation can complete. Otherwise the region that is outside the bounds of the image will not be written.

Note: this operation is atomic – no other threads can read or write to the image while this is being performed.

Parameters

x	x coord of the lower left corner of the region to be written.
y	y coord of the lower left corner of the region to be written.
nx	width of the region to be written.
ny	height of the region to be written.
data	Pointer to the source buffer.
pd	Pixelformat for the buffer color – if 0, it uses the pixel format of this image

Examples:: ImageIOHandlerRAW/ImageIOHandlerRAW.cpp.

Definition at line 1833 of file image.h.

1835 { setTile(ImgTile(x, y, nx, ny), data, pd); }

GLenum GLint GLint y

Definition: GLee.h:876

GLfloat ny

Definition: GLee.h:5410

GLsizei GLsizei GLenum GLenum const GLvoid * data

Definition: GLee.h:880

GLenum GLint x

Definition: GLee.h:876

GLfloat GLfloat GLfloat GLfloat nx

Definition: GLee.h:5412

mudbox::Image::setTile

void setTile(int x, int y, int nx, int ny, void *data, const PixelDescriptor *pd=0)

Writes a rectangular region of pixels to the image from a buffer.

Definition: image.h:1833

void setSubTile	(	int	x,
		int	y,
		int	nx,
		int	ny,
		const void *	data,
		int	dx,
		int	dy,
		int	dnx,
		int	dny,
		const PixelDescriptor *	pd = `0`
	)

inline

Writes a rectangular region of pixels from the image into a buffer.

The buffer may be be different than the size of the region being written. If the image has dynamic bounds, the image bounds will be expanded as required so that the entire operation can complete. Otherwise the region that is outside the bounds of the image will not be written.

Note: this operation is atomic – no other threads can read or write to the image while this is being performed.

Parameters

x	x coord of the lower left corner of the region to be written.
y	y coord of the lower left corner of the region to be written.
nx	width of the region to be written.
ny	height of the region to be written.
data	Pointer to the source buffer.
dx	x coord of the lower left corner of the buffer (in image coords).
dy	y coord of the lower left corner of the buffer (in image coords).
dnx	width of the target buffer.
dny	height of the target buffer.
pd	Pixelformat for the buffer color – if 0, it uses the pixel format of this image

Definition at line 1864 of file image.h.

1867 { setSubTile(ImgTile(x, y, nx, ny), data, ImgTile(dx, dy, dnx, dny), pd); }

GLenum GLint GLint y

Definition: GLee.h:876

dy

int int int int * dy

Definition: GLee.h:10535

GLfloat ny

Definition: GLee.h:5410

mudbox::Image::setSubTile

GLsizei GLsizei GLenum GLenum const GLvoid * data

Definition: GLee.h:880

void setSubTile(int x, int y, int nx, int ny, const void *data, int dx, int dy, int dnx, int dny, const PixelDescriptor *pd=0)

Writes a rectangular region of pixels from the image into a buffer.

Definition: image.h:1864

GLenum GLint x

Definition: GLee.h:876

GLfloat GLfloat GLfloat GLfloat nx

Definition: GLee.h:5412

dx

int int int * dx

Definition: GLee.h:10535

void setTile	(	const ImgTile &	dstTile,
		const void *	data,
		const PixelDescriptor *	pd = `0`
	)

inline

Writes a rectangular region of pixels to the image from a buffer.

The buffer must be exactly the size of the region being written. If the image has dynamic bounds, the image bounds will be expanded as required so that the entire operation can complete. Otherwise the region that is outside the bounds of the image will not be written.

Note: this operation is atomic – no other threads can read or write to the image while this is being performed.

Parameters

dstTile	rectangle of the image to be written.
data	Pointer to the source buffer.
pd	Desired pixelformat for the buffer color – if 0, it uses the pixel format of this image

Definition at line 1885 of file image.h.

1887 { setSubTile(dstTile, data, dstTile, pd); }

mudbox::Image::setSubTile

GLsizei GLsizei GLenum GLenum const GLvoid * data

Definition: GLee.h:880

void setSubTile(int x, int y, int nx, int ny, const void *data, int dx, int dy, int dnx, int dny, const PixelDescriptor *pd=0)

Writes a rectangular region of pixels from the image into a buffer.

Definition: image.h:1864

virtual void setSubTile	(	const ImgTile &	dstTile,
		const void *	data,
		const ImgTile &	sourceBounds,
		const PixelDescriptor *	pd = `0`
	)

virtual

Writes a rectangular region of pixels from the image into a buffer.

The buffer may be be different than the size of the region being written. If the image has dynamic bounds, the image bounds will be expanded as required so that the entire operation can complete. Otherwise the region that is outside the bounds of the image will not be written.

Note: this operation is atomic – no other threads can read or write to the image while this is being performed.; this is the only member of the setTile family that must be provided by subclasses of this Image class.

Parameters

dstTile	rectangle of the image to be written.
data	Pointer to the source buffer.
sourceBounds	bounds of the source buffer (in image coords).
pd	Pixelformat for the buffer color – if 0, it uses the pixel format of this image

void copyTile	(	int	x,
		int	y,
		int	nx,
		int	ny,
		Image &	fromImg,
		int	ox,
		int	oy
	)

inline

Copies a rectangular region of pixels from a source image to this image.

If the image has dynamic bounds, the image bounds will be expanded as required so that the entire operation can complete. Otherwise the region that is outside the bounds of the image will not be written. Regions outsude the bounds of the source image will be filled with the FillColor of the source image.

Note: this operation is atomic – no other threads can read or write to the target image while this is being performed, and no other threads can write to the source image.; Format conversions are automatically performed as required.

Parameters

x	x target coord of the lower left corner of the region to be copied.
y	y target coord of the lower left corner of the region to be copied.
nx	width of the region to be copied.
ny	height of the region to be copied.
fromImg	The source image.
ox	x source coord of the lower left corner of the region to be copied (in souce image coordinates).
oy	y source coord of the lower left corner of the region to be copied (in souce image coordinates). .

Definition at line 1937 of file image.h.

1939 { copyTile(ImgTile(x, y, nx, ny), fromImg, ox, oy); }

GLenum GLint GLint y

Definition: GLee.h:876

mudbox::Image::copyTile

void copyTile(int x, int y, int nx, int ny, Image &fromImg, int ox, int oy)

Copies a rectangular region of pixels from a source image to this image.

Definition: image.h:1937

GLfloat ny

Definition: GLee.h:5410

GLenum GLint x

Definition: GLee.h:876

GLfloat GLfloat GLfloat GLfloat nx

Definition: GLee.h:5412

virtual void copyTile	(	const ImgTile &	dstTile,
		Image &	fromImg,
		int	ox,
		int	oy
	)

virtual

Copies a rectangular region of pixels from a source image to this image.

If the image has dynamic bounds, the image bounds will be expanded as required so that the entire operation can complete. Otherwise the region that is outside the bounds of the image will not be written. Regions outsude the bounds of the source image will be filled with the FillColor of the source image.

Note: this operation is atomic – no other threads can read or write to the target image while this is being performed, and no other threads can write to the source image.; Format conversions are automatically performed as required.; this is the only member of the copyTile family that must be provided by subclasses of this Image class.

Parameters

dstTile	target rectangle to be copied.
fromImage	The source image.
ox	x source coord of the lower left corner of the region to be copied (in souce image coordinates).
oy	y source coord of the lower left corner of the region to be copied (in souce image coordinates). .

virtual void copyAll ( Image & fromImg )

inlinevirtual

Copies all of the pixels from a source image to this image.

If the image has dynamic bounds, the image bounds will be expanded as required so that the entire operation can complete. Otherwise the region that is outside the bounds of the image will not be written. Regions outsude the bounds of the source image will be filled with the FillColor of the source image.

Note: this operation is atomic – no other threads can read or write to the target image while this is being performed, and no other threads can write to the source image.; Format conversions are automatically performed as required.

Parameters

fromImage The source image.

Definition at line 1981 of file image.h.

     {
         ImgTile srcBounds(fromImg.getBounds());
         copyTile(srcBounds, fromImg, srcBounds.x, srcBounds.y);
     }

virtual void Clear ( )

virtual

Clear all the pixels of the image to 0 in all channels.

void fillTile	(	int	x,
		int	y,
		int	nx,
		int	ny,
		void *	pixelData,
		const PixelDescriptor *	pd = `0`,
		const ImgTile *	maskTile = `0`
	)

inline

Fills a rectangular region of pixels in the image with a constant color.

Optionally a rectangular region can be "masked off" and not filled. If the image has dynamic bounds, the image bounds will be expanded as required so that the entire operation can complete. Otherwise the region that is outside the bounds of the image will not be written.

Note: this operation is atomic – no other threads can read or write to the image while this is being performed.

Parameters

x	x target coord of the lower left corner of the region to be filled.
y	y target coord of the lower left corner of the region to be filled.
nx	width of the region to be filled.
ny	height of the region to be filled.
pixelData	Pointer to the source pixel data. If 0, all 0s are used instead.
pd	Pixelformat for the source pixel color – if 0, it uses the pixel format of this image
masktTile	an optional pointer to a mask rectangle. If present, the contents of this rectangle of the image will remain unchanged by this operation.

Definition at line 2015 of file image.h.

2018 { fillTile(ImgTile(x, y, nx, ny), pixelData, pd, maskTile); }

GLenum GLint GLint y

Definition: GLee.h:876

mudbox::Image::fillTile

void fillTile(int x, int y, int nx, int ny, void *pixelData, const PixelDescriptor *pd=0, const ImgTile *maskTile=0)

Fills a rectangular region of pixels in the image with a constant color.

Definition: image.h:2015

GLfloat ny

Definition: GLee.h:5410

GLenum GLint x

Definition: GLee.h:876

GLfloat GLfloat GLfloat GLfloat nx

Definition: GLee.h:5412

void fillTile	(	const ImgTile &	dstTile,
		const void *	pixelData,
		const PixelDescriptor *	pd,
		const ImgTile *	maskTile
	)

Fills a rectangular region of pixels in the image with a constant color.

Optionally a rectangular region can be "masked off" and not filled. If the image has dynamic bounds, the image bounds will be expanded as required so that the entire operation can complete. Otherwise the region that is outside the bounds of the image will not be written.

Note: this operation is atomic – no other threads can read or write to the image while this is being performed.

Parameters

dstTile	Rectangle of the image to be written.
pixelData	Pointer to the source pixel data. If 0, all 0s are used instead.
pd	Pixelformat for the source pixel color – if 0, it uses the pixel format of this image
masktTile	an optional pointer to a mask rectangle. If present, the contents of this rectangle of the image will remain unchanged by this operation.

virtual void fillTile	(	const ImgTile &	dstTile,
		const void *	pixelData,
		const PixelDescriptor *	pd = `0`
	)

virtual

Fills a rectangular region of pixels in the image with a constant color.

Optionally a rectangular region can be "masked off" and not filled. If the image has dynamic bounds, the image bounds will be expanded as required so that the entire operation can complete. Otherwise the region that is outside the bounds of the image will not be written.

Note: this operation is atomic – no other threads can read or write to the image while this is being performed.; this is the only member of the fillTile family that must be provided by subclasses of this Image class.

Parameters

dstTile	Rectangle of the image to be written.
pixelData	Pointer to the source pixel data. If 0, all 0s are used instead.
pd	Pixelformat for the source pixel color – if 0, it uses the pixel format of this image

virtual void getPageSize	(	int &	nx,
		int &	ny
	)

virtual

Returns the size of an image page.

Some images may be carved up into 1 or more image pages – this method returns the page size for this image. MemoryImages will be a single page that is the size of the entire images. virtualImages will have have a page size of 128 x 128 pixels.

Parameters

nx	width of a page
ny	height of a page

ImgPageIterator* getPageIterator	(	int	x,
		int	y,
		int	nx,
		int	ny
	)

inline

Returns a tile iterator that will iterate over the pages of this image in an optimal order.

For MemoryImages and other non paged images this iterator will only produce one tile.

Parameters

x	x origin of the region to iterate over
y	yorigin of the region to iterate over
nx	width of the region to iterate over
ny	height of the region to iterate over

Returns: the tileIterator

Note: this function allocates the iterator – when the caller is finished with it, the caller must delete it.

Definition at line 2092 of file image.h.

2093 { return getPageIterator(ImgTile(x, y, nx, ny)); }

GLenum GLint GLint y

Definition: GLee.h:876

GLfloat ny

Definition: GLee.h:5410

GLenum GLint x

Definition: GLee.h:876

mudbox::Image::getPageIterator

GLfloat GLfloat GLfloat GLfloat nx

Definition: GLee.h:5412

ImgPageIterator * getPageIterator(int x, int y, int nx, int ny)

Returns a tile iterator that will iterate over the pages of this image in an optimal order...

Definition: image.h:2092

virtual ImgPageIterator* getPageIterator ( const ImgTile & srcTile )

virtual

Returns a tile iterator that will iterate over the pages of this image in an optimal order.

For MemoryImages and other non paged images this iterator will only produce one tile.

Parameters

srcTile the region to iterate over

Returns: the tileIterator

Note: this function allocates the iterator – when the caller is finished with it, the caller must delete it.

ImgLockPageIterator* lockPageSet	(	int	x,
		int	y,
		int	nx,
		int	ny,
		ImgLockPageIterator::AccessMode	mode
	)

inline

Returns a tile iterator that will iterate over the pages of this image in an optimal order.

These pages are locked at the start of this operation, and unlocked 1 by one as they are iterated over. For MemoryImages and other non paged images this iterator will only produce one tile.

Parameters

x	x origin of the region to lock and iterate over
y	yorigin of the region to lock and iterate over
nx	width of the region to lock and iterate over
ny	height of the region to lock and iterate over
mode	the access mode – read only, read/write or write only.

Returns: the tileIterator

Note: this function allocates the iterator – when the caller is finished with it, the caller must delete it.

Definition at line 2123 of file image.h.

2125 { return lockPageSet(ImgTile(x, y, nx, ny), mode); }

GLenum GLint GLint y

Definition: GLee.h:876

mode

GLint mode

Definition: GLee.h:4479

GLfloat ny

Definition: GLee.h:5410

GLenum GLint x

Definition: GLee.h:876