#include <image.h>
This is the base image type defining the interface to images.
There are three differend kinds of images;
The first kind is the fastest, but least memory efficient. If the system is not able to allocate the required memory in one piece, a striped image will be created. A striped image consists of several stripes of 1 or more rows of pixels.
The third type of image is the most versatile – It is stored as 128 pixel square tiles – tiles are copy-on-write, versioned, and have their own virtual memory system optimized for images. Texture layers are typically stored in this third type of image so that paint operations on them are easily undoable.
Public Types | |
enum | ImageType { Type_Invalid = 0, Type_Memory, Type_Virtual } |
used to identify what type of image any particular instance is. More... | |
enum | Format { e8integer = 0, e16integer, e32integer, e16float, e32float, e16depth, e24depth, e32depth, eUnknown, eInvalid } |
Image channel datatype type. More... | |
![]() | |
enum | DiagnosticLevel { dgnLevel1, dgnLevel2, dgnLevel3 } |
Indicates the level of validity checking that is performed in CheckValidity() More... | |
Public Member Functions | |
virtual | ~Image (void) |
void | UnitTest (int iterations) |
cause the image storage mechanisms to be tested randomly for the specified number of iterations. More... | |
virtual bool | isAllocated () const |
ImageType | getType () const |
return the image type. More... | |
const ImageDescriptor & | getDescriptor () const |
get the full descriptor for the image More... | |
void | setProxyDownsampleTo8Bit (bool downsampleTo8Bit=true) |
The default when generating proxys is to downsample them to 8 bit/channel this can make them significantly smaller. More... | |
bool | getProxyDownsampleTo8Bit () const |
void | clearProxyImages () |
clear and deallocate any proxy images. More... | |
void | SetProxyInterruptFunction (ProxyInterruptFunction fcnPtr=0) |
When generating proxy images, periodically, the interrupt function will be polled. More... | |
unsigned char | getProxyLevel () const |
get the Proxy level of the image – 0 = no proxying. More... | |
bool | setProxyLevel (unsigned char newLevel) |
set the current proxy level More... | |
Image * | getProxyImage () |
get the proxy image. More... | |
int | xSize () const |
Get the x size of the image. More... | |
int | ySize () const |
Get the y size of the image. More... | |
int | cSize () const |
Get the channel count of the image. More... | |
int | curWidth () const |
get the width of the current proxy level of the image More... | |
int | curHeight () const |
get the height of the current proxy level of the image More... | |
ImageDescriptor::MemoryChannelOrder | channelOrder () const |
Get the channel ordering of the image. More... | |
const ImgTile & | getBounds () const |
returns the bounds of the image – the origin of this rect may not be at 0,0 More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
void | getTile (const ImgTile &srcTile, void *data, const PixelDescriptor *pd=0) |
Reads a rectangular region of pixels from the image into a buffer. More... | |
virtual void | getSubTile (const ImgTile &srcTile, void *data, const ImgTile &targetBounds, const PixelDescriptor *pd=0) |
Reads a rectangular region of pixels from the image into a buffer. More... | |
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. More... | |
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. More... | |
void | setTile (const ImgTile &dstTile, const void *data, const PixelDescriptor *pd=0) |
Writes a rectangular region of pixels to the image from a buffer. More... | |
virtual void | setSubTile (const ImgTile &dstTile, const void *data, const ImgTile &sourceBounds, const PixelDescriptor *pd=0) |
Writes a rectangular region of pixels from the image into a buffer. More... | |
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. More... | |
virtual void | copyTile (const ImgTile &dstTile, Image &fromImg, int ox, int oy) |
Copies a rectangular region of pixels from a source image to this image. More... | |
virtual void | copyAll (Image &fromImg) |
Copies all of the pixels from a source image to this image. More... | |
virtual void | Clear () |
Clear all the pixels of the image to 0 in all channels. More... | |
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. More... | |
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. More... | |
virtual void | fillTile (const ImgTile &dstTile, const void *pixelData, const PixelDescriptor *pd=0) |
Fills a rectangular region of pixels in the image with a constant color. More... | |
virtual void | getPageSize (int &nx, int &ny) |
Returns the size of an image page. More... | |
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. More... | |
virtual ImgPageIterator * | getPageIterator (const ImgTile &srcTile) |
Returns a tile iterator that will iterate over the pages of this image in an optimal order. More... | |
ImgLockPageIterator * | lockPageSet (int x, int y, int nx, int ny, ImgLockPageIterator::AccessMode mode) |
Returns a tile iterator that will iterate over the pages of this image in an optimal order. More... | |
virtual ImgLockPageIterator * | lockPageSet (const ImgTile &srcTile, ImgLockPageIterator::AccessMode mode) |
Returns a tile iterator that will iterate over the pages of this image in an optimal order. More... | |
void | CopyInverseLuminance (const Image &srcImage) |
copies 1-luminance from the source image into this image More... | |
void | CopyLuminance (const Image &srcImage) |
copies the luminance of the source image into this image More... | |
virtual void | PutInverseLuminance (Image &targetImage) const |
copies 1-luminance of this image to the target image More... | |
virtual void | PutLuminance (Image &targetImage) const |
copies the luminance of this image to the target image More... | |
virtual QString | SupportedExtensions (bool bRGBAOnly=false, bool bRead=true, bool bDesc=false, bool bPSD=true, QString sDelimiter=";") const |
Returns the supported file extensions, separated by ';'. More... | |
virtual void | Create (unsigned int iWidth, unsigned int iHeight, unsigned int iChannelCount, Format eFormat=e8integer, bool Tiled=false, ImageDescriptor::MemoryChannelOrder eOrder=ImageDescriptor::orderRGBA) |
Create a new image. More... | |
virtual void | Load (const QString &sFileName, int iLayerIndex=0, bool tiled=false) |
Load a whole image from an external file. More... | |
virtual bool | GetPSDLayerMeta (void *pPSDFile, int iLayerIndex, QString &layerName, int &blendMode, float &opacity, bool &locked, bool &visible, bool &transLocked) |
virtual bool | LoadPSDLayer (void *pPSDFile, int iLayerIndex, bool Tiled=false, bool premult=true) |
Load this image from a layer in a Photoshop file. More... | |
virtual Image * | ComputeDifferenceMask (Image *otherImg, int expansionRadius, int AARadius, bool &anyDiffs) |
virtual bool | SavePSDLayerMeta (void *pPSDFile, int iLayerIndex, const QString &pLayerName, float opacity=1.0f, bool visible=true, bool locked=false, int xOff=0, int yOff=0, int blendMode=-1) |
Save this image metadata to the layer metadata in a Photoshop file. More... | |
virtual bool | SavePSDLayer (void *pPSDFile, int iLayerIndex, const QString &pLayerName, float opacity=1.0f, bool visible=true, bool locked=false, bool needs_unpremult=true, int xOff=0, int yOff=0) |
Save this image to a layer in a Photoshop file. More... | |
virtual void * | OpenPSDFile (const QString &pFileName, bool writing=false) |
Open a PSD file for reading or writing – returns a pointer to blind data representing the open file, or NULL if it was unable to open the file. More... | |
virtual bool | GetPSDFileInfo (void *psdFile, int *width, int *height, int *numChannels, int *bitDepth, int *numLayers, int *curLayer) |
Returns the basic file scope metadata for a PSD file. More... | |
virtual bool | SetPSDFileInfo (void *psdFile, int width, int height, int numChannels, int bitDepth, int numLayers, int curLayer) |
Sets the file scope metadata for a writable PSD file. More... | |
virtual bool | ClosePSDFile (void *psdFile) |
Close a PSD file. More... | |
virtual void | Save (const QString &sFileName, bool bForce=true, Material *pMaterial=NULL, float uStart=0.0f, float vStart=0.0f, bool force_1_Channel_To_4_Channel=false) |
Save the image to an external file. More... | |
virtual unsigned int | Width (void) const |
Return the width of the image in pixels. More... | |
virtual unsigned int | Height (void) const |
Return the height of the image in pixels. More... | |
virtual Format | Format (void) const |
Return the format of the image. More... | |
virtual unsigned int | ChannelCount (void) const |
Return the number of channels in the image. More... | |
virtual unsigned int | BytesPerPixel (void) const |
Return the number of bytes used by a pixel. More... | |
unsigned int | curBytesPerPixel () const |
Return the number of bytes used by a pixel at the current proxy level. More... | |
virtual unsigned int | TotalBytes (void) const |
Return the number of bytes used by the whole image. More... | |
unsigned int | curTotalBytes (void) const |
Return the number of bytes used by the whole image (current proxy level) More... | |
virtual void | SetValueAt (unsigned int iXPos, unsigned int iYPos, unsigned int iChannel, float fValue) |
Set value for a specified texel. More... | |
virtual float | ValueAt (unsigned int iXPos, unsigned int iYPos, unsigned int iChannel) const |
Get the value at a given coordinate. More... | |
virtual float | ValueAt (float fXPos, float fYPos, unsigned int iChannel) const |
Get interpolated value at a given coordinate. More... | |
virtual void | SetColorAt (unsigned int iXPos, unsigned int iYPos, const Color &cColor) |
Set value for a specified texel. More... | |
virtual Color | ColorAt (unsigned int iXPos, unsigned int iYPos) const |
Get the value at a given coordinate. More... | |
virtual Color | ColorAt (float fXPos, float fYPos) const |
Get interpolated value at a given coordinate. More... | |
virtual QImage * | ConvertToQImage () |
Create a QImage object from the image data for display purposes. More... | |
virtual void | ConvertFromQImage (QImage &qImg, bool tiled=false) |
Creates the image from a QImage. More... | |
virtual bool | Fragmented () const |
returns true if the image is not stored in one physically contiguous piece of CPU visible memory – If so, you must use lockPageSet to get at portions of the image data... More... | |
virtual bool | Tiled () const |
returns true if this is a tiled and versioned image More... | |
bool | Versioned () const |
returns true if this is a tiled and versioned image More... | |
virtual bool | NewVersion () |
checkpoint and create a new version of this image. More... | |
virtual bool | PrevVersion () |
makes the previous version current – used for undo returns true if it worked, false otherwise marks the proxy dirty More... | |
virtual bool | NextVersion () |
makes the next version current – used for redo returns true if it worked, false otherwise marks the proxy dirty More... | |
virtual int | NumVersions () |
returns the number of versions. returns 1 for unversioned images More... | |
virtual bool | MergeOldestVersions () |
merges the oldest two versions – used to limit the number of items on the undo queue. More... | |
virtual bool | PurgeNewerVersions () |
Creating a new version will implicitly purge nerer versions, but if another operation takes place that puts a new item on the undo queue, this should be called to purge newer versions of this image returns true if it worked, false otherwise. More... | |
virtual bool | PurgeAllButCurrentVersion () |
Releases all but the current version – used to flush the undo queue. More... | |
virtual void * | Data (int iRow=-1, bool writing=true) |
Get a pointer to the raw data of a row of the image. More... | |
virtual const void * | Data (int iRow=-1, bool writing=false) const |
virtual void | DrawUVs (Material *pMaterial, float uStart=0.0f, float vStart=0.0f, bool baseLevel=true) |
Draw the uv mesh for a given material into this image – either the base or active level. More... | |
virtual void | scaleTileBilinear_4Chan_uchar (float x, float y, float nx, float ny, unsigned int *data, int dx, int dy, int dnx, int dny, float xScale, float yScale) const |
Fast, thread safe image scaler. More... | |
virtual void | GenerateUpscaled (Image *targetImg, int factor) |
This upscales an image with good filtering (bilinear to Lanczos as needed based on the scale factor. More... | |
virtual bool | isDirty () const |
Query if the contents of this image have changed since the last call to setClean. More... | |
virtual void | setDirty () |
Explicitly set the image state to dirty. More... | |
virtual void | setClean () |
explicitly set the image state to clean. More... | |
virtual void | VerticalFlip () |
vertically flip the image (make it upside down) More... | |
virtual void | AdjustImageCacheSize () |
Causes the image cache size to adjust based on the amount of memory available. More... | |
virtual void | ConvertTo4Channel () |
makes the image 4 channels. with the alphas 1.0. More... | |
![]() | |
Node (const QString &sStringID="", const QString &sDisplayName="") | |
Standard constructor. More... | |
virtual | ~Node (void) |
virtual void | Initialize (void) |
void | LoadTemplate (const QString &sFileName="", bool bStartEvent=false) |
Use an external XML file to initialize the attributes. More... | |
void | SaveTemplate (const QString &sFileName="", bool bSaveOnlyVisible=false) |
Save current attributes as an XML template. More... | |
unsigned int | Version (void) const |
Returns the current version of the node. This number increases when the content of the node changed (when ContentChanged() called). More... | |
void | SetVersion (unsigned int iVersion) |
Sets the current version number for the node. More... | |
unsigned int | ReferenceCount (void) const |
Returns the number of pointers referencing this node. More... | |
Attribute * | ReferencePointer (unsigned int iIndex) const |
Returns the address of an attribute which refers to this node. The type of the attribute is always aptr. More... | |
Node * | ReferenceNode (unsigned int iIndex) const |
Returns the address of a node referencing this node. More... | |
virtual QString | Name (const ClassDesc *pClass=0) const |
Deprecated. More... | |
virtual void | SetName (const QString &sName) |
Deprecated. More... | |
virtual QString | StringID (const ClassDesc *pClass=0) const |
Returns the string id of the node. More... | |
virtual void | SetStringID (const QString &sStringID) |
Sets the string id of the node. More... | |
virtual QString | DisplayName (void) const |
Returns the display name of the node. More... | |
virtual void | SetDisplayName (const QString &sDisplayName) |
Sets the display name of the node. More... | |
virtual QString | HelpID (void) const |
Returns the help entry id of the node. Can be overwritten in derived classes. More... | |
virtual void | SetHelpID (const QString &sHelpID) |
Sets the help entry id of the node. More... | |
void | Annex (Node *pSource, const QString &sCategory="") |
Relink all the attributes of the source node to this one. More... | |
virtual void | Serialize (Stream &s) |
Serializes the node. More... | |
bool | IsKindOf (const ClassDesc *pClass) const |
Returns true if this node is derived from the pClass class. More... | |
void | ContentChanged (void) const |
This function must be called if the content of the node is changed. More... | |
virtual void | CheckValidity (DiagnosticLevel iLevel=dgnLevel2) const |
Checks the validity of this node. More... | |
virtual void | CopyTo (Node *pNode) const |
virtual Node * | Duplicate (void) const |
virtual void | OnNodeEvent (const Attribute &cAttribute, NodeEventType cType) |
This function is called if an event occurs with any of the attributes of the node. More... | |
virtual void | OnEvent (const EventGate &cEvent) |
This function is called when a generic event occurs. See EventGate class. More... | |
void | RequestDeferredEvent (Attribute &cAttribute) |
Request for a deferred event, which will occur only in the main loop. More... | |
unsigned int | AttributeCount (void) const |
Returns the number of attributes owned by the node. More... | |
Attribute * | AttributeByIndex (int iIndex) const |
Returns a specified attribute (or 0 if iIndex is greater than the number of attributes). More... | |
Attribute * | AttributeByName (const QString &sName) const |
Returns a specified attribute by its name. Returns 0 if the attribute not found. More... | |
Attribute * | AttributeByID (const QString &sID) const |
Returns a specified attribute by its ID. Returns 0 if the attribute not found. More... | |
void | SetAttributeValue (const QString &sAttributeID, const QString &sNewValue) |
Set the value of an attribute from a string. More... | |
QString | AttributeValue (const QString &sAttributeID) const |
Returns the current value of an attribute as a string. More... | |
void | LogAttributes (void) const |
Write all attributes into the log file. More... | |
virtual QWidget * | CreatePropertiesWindow (QWidget *pParent) |
Create a window which displays the attributes of the node. Can be overriden to provide a custom interface. More... | |
Attribute * | AddAttribute (Attribute::AttributeType type, const QString &id) |
Allows SDK users to add attributes at runtime. More... | |
Node * | Next (void) const |
Returns the next node in the chain. Used to enumerate the current nodes. See also First(). More... | |
int | ID (void) const |
Returns an ID for the node. The ID is unique in the whole application life. More... | |
bool | SetID (int iID) |
Set ID for the node. More... | |
Static Public Member Functions | |
static QString | AllSupportedExtensions (bool bRGBAOnly=false, bool bRead=true, bool bDesc=false, bool bPSD=true, QString sDelimiter=";") |
static ImageDescriptor::MemoryChannelOrder | optimizedChannelOrder () |
static void | ConvertPixels (void *dst, const void *src, int numPix, const PixelDescriptor &dstDesc, const PixelDescriptor *srcDesc=0) |
static void | MultiplyRGBByAlpha_uc4 (unsigned char *buffer, int numPixels) |
multiply alpha into RGB for the specified number of pixels. More... | |
![]() | |
static void | StartHashing () |
This is called once in main once static ctors are done. More... | |
static Node * | First (void) |
This function will return the first node in the memory. Used to enumerate all the current nodes. See also Next(). More... | |
static Node * | ByID (int iID) |
Returns the node with the specified ID, or zero if such a node does not exists. More... | |
static Node * | ByName (const QString &sClass, const QString &sName) |
Search for a node with the name sName. More... | |
Protected Member Functions | |
Image (void) | |
void | markProxyDirty () |
virtual bool | regenerateProxy () |
bool | isProxyDirty () const |
virtual bool | GenerateProxy (Image *targetImg, int level, bool DownsampleTo8Bits=true) |
Protected Attributes | |
unsigned char | m_FillPixel [16] |
ImageDescriptor | m_Descriptor |
ImageType | m_ImageType |
unsigned char | m_ProxyLevel |
Image * | m_pProxyImages [MAX_PROXY_LEVEL+1] |
bool | m_bDownsampleProxyTo8Bit |
ProxyInterruptFunction | m_pProxyIntFcn |
Friends | |
class | ImgPageIterator |
class | ImgLockPageIterator |
Additional Inherited Members | |
![]() | |
AttributeThisPointer | m_pThis |
DECLARE_CLASS | |
enum ImageType |
used to identify what type of image any particular instance is.
Enumerator | |
---|---|
Type_Invalid | |
Type_Memory |
physically contiguous image or striped |
Type_Virtual |
Tiled & versioned, not contiguous. |
Definition at line 1515 of file image.h.
enum Format |
Image channel datatype type.
Enumerator | |
---|---|
e8integer | |
e16integer | |
e32integer | |
e16float | |
e32float | |
e16depth | |
e24depth | |
e32depth | |
eUnknown | |
eInvalid |
Definition at line 1522 of file image.h.
|
protectedvirtual |
|
protectedvirtual |
cause the image storage mechanisms to be tested randomly for the specified number of iterations.
|
virtual |
|
static |
|
inline |
|
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.
|
inline |
|
inline |
|
inline |
|
inline |
|
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.
|
inline |
Get the x size of the image.
Definition at line 1669 of file image.h.
|
inline |
Get the y size of the image.
Definition at line 1672 of file image.h.
|
inline |
Get the channel count of the image.
Definition at line 1675 of file image.h.
|
inline |
get the width of the current proxy level of the image
Definition at line 1678 of file image.h.
|
inline |
get the height of the current proxy level of the image
Definition at line 1681 of file image.h.
|
inline |
Get the channel ordering of the image.
Definition at line 1684 of file image.h.
|
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.
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.
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.
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 |
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
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.
|
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
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.
|
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
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.
|
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
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 |
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.
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 |
Definition at line 1833 of file image.h.
|
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.
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.
|
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.
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.
|
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.
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 |
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.
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.
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.
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). . |
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.
fromImage | The source image. |
Definition at line 1981 of file image.h.
|
virtual |
Clear all the pixels of the image to 0 in all channels.
|
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.
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.
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.
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 |
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.
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 |
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.
nx | width of a page |
ny | height of a page |
|
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.
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 |
Definition at line 2092 of file image.h.
|
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.
srcTile | the region to iterate over |
|
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.
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. |
Definition at line 2123 of file image.h.
|
virtual |
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.
srcTile | the region to lock and iterate over |
mode | the access mode – read only, read/write or write only. |
|
static |
|
static |
copies 1-luminance from the source image into this image
copies the luminance of the source image into this image
copies 1-luminance of this image to the target image
copies the luminance of this image to the target image
|
virtual |
Returns the supported file extensions, separated by ';'.
bRGBAOnly | true to return a list of file formats that support 4 channels. false to return a list of all supported formats. Not all returned formats may support 4 channels (like JPEG). |
bRead | true to return list of readable formats, false for writable formats. Not all readable formats may be writable and vice versa. |
bDesc | true to prepend descriptive text to each extension. i.e "JPG [8 bit, RGB]" |
bPSD | true to support PSD files... |
|
virtual |
Create a new image.
Data will be undefined. The Tiled argument creates a tiled versioned image. (the Data method will not work on these type of images, you must use get/set/copy tile or page locking to access them)
Load a whole image from an external file.
The extension in the filename must be included. If the file is a PSD file, the bottom bost image layer is loaded into this image.
|
virtual |
|
virtual |
Load this image from a layer in a Photoshop file.
The image will be created at the bit-depth and format of the PSD file (either 8 bit int, 16 bit int, or 32 bit float), and will be the size of the PSD file (not the size of the layer, which can be smaller). The image will be tiled as specified. The pPSDFile must have been created with OpenPSDFile. 0 is the bottom layer, and they increase as you go up in the layer stack.
|
virtual |
|
virtual |
Save this image metadata to the layer metadata in a Photoshop file.
The image must be the same size and bit-depth as the PSD file The pPSDFile must have been created with PSDOpen. 0 is the bottom layer, and they increase as you go up in the layer stack -1 for the layer index indicates that you want to save the RGB of this image into the composite image in the PSD file. In that case, the remaining parameters are ignored. All layer metadata must be set before any layer images are written
|
virtual |
Save this image to a layer in a Photoshop file.
The image must be the same size and bit-depth as the PSD file The pPSDFile must have been created with PSDOpen. 0 is the bottom layer, and they increase as you go up in the layer stack -1 for the layer index indicates that you want to save the RGB of this image into the composite image in the PSD file. In that case, the remaining parameters are ignored. The layer metata for this and all other layers must have been set before calling this function.
Open a PSD file for reading or writing – returns a pointer to blind data representing the open file, or NULL if it was unable to open the file.
When creating a PSD file, first open it, then set the FileInfo, then save the layes from the bottom up (index 0 to n), and lastly save the composite layer (index -1.) Then close the file.
|
virtual |
Returns the basic file scope metadata for a PSD file.
Returns true if successful. (if any of the pointers are NULL, the informaton is not retrieved)
|
virtual |
Sets the file scope metadata for a writable PSD file.
Returns true if successful. This must be called before saving any layers.
|
virtual |
Close a PSD file.
|
virtual |
Save the image to an external file.
The extension of the file will determine the file type. If bForce is true the image should be saved even it means data loss. Otherwise an exception should drop. Optionally, when saving to PSD, if you specify a material and a uv offset for this texture, it can draw the base uv mesh on a layer above the image layer.
Return the number of channels in the image.
Return the number of bytes used by a pixel.
|
inline |
Return the number of bytes used by a pixel at the current proxy level.
Definition at line 2304 of file image.h.
Return the number of bytes used by the whole image.
Return the number of bytes used by the whole image (current proxy level)
Definition at line 2310 of file image.h.
|
virtual |
Set value for a specified texel.
For integer maps 1 should be mapped for the maximum value (255 for 8 bit images and 65535 for 16 bit images) This fcn is very slow and deprecated. Use LockPageSet, or the fast templated pixel accessor classes.
|
virtual |
Get the value at a given coordinate.
This fcn is very slow and deprecated. Use LockPageSet, or the fast templated pixel accessor classes.
|
virtual |
Get interpolated value at a given coordinate.
This fcn is very slow and deprecated. Use LockPageSet, or the fast templated pixel accessor classes.
Set value for a specified texel.
For integer maps 1 should be mapped for the maximum value (255 for 8 bit images and 65535 for 16 bit images)
Get the value at a given coordinate.
|
virtual |
Get interpolated value at a given coordinate.
|
virtual |
Creates the image from a QImage.
|
virtual |
returns true if the image is not stored in one physically contiguous piece of CPU visible memory – If so, you must use lockPageSet to get at portions of the image data...
|
virtual |
returns true if this is a tiled and versioned image
|
inline |
|
virtual |
checkpoint and create a new version of this image.
returns true if it worked, false otherwise
|
virtual |
makes the previous version current – used for undo returns true if it worked, false otherwise marks the proxy dirty
|
virtual |
makes the next version current – used for redo returns true if it worked, false otherwise marks the proxy dirty
|
virtual |
returns the number of versions. returns 1 for unversioned images
|
virtual |
merges the oldest two versions – used to limit the number of items on the undo queue.
returns true if it worked, false otherwise
|
virtual |
Creating a new version will implicitly purge nerer versions, but if another operation takes place that puts a new item on the undo queue, this should be called to purge newer versions of this image returns true if it worked, false otherwise.
|
virtual |
Releases all but the current version – used to flush the undo queue.
returns true if it worked, false otherwise
Get a pointer to the raw data of a row of the image.
If the given row index is -1, then a pointer - if exists - to the whole data block is returned. These are deprecated and are going away shortly. DO NOT USE THEM IN NEW CODE. Use LockPageSet instead. These will not work on tiled images at all.
|
virtual |
Draw the uv mesh for a given material into this image – either the base or active level.
uv offset can be specified for tiled materials. These offsets should be 0.0, 1.0, 1.0 etc... The default is to draw from 0.0, 0.0 to 1.0, 1.0 marks the proxy dirty
|
virtual |
Fast, thread safe image scaler.
Works only on 4 channel 8 bit/channel images Note: Not a permanent part of the API.
This upscales an image with good filtering (bilinear to Lanczos as needed based on the scale factor.
The upscaled image will be the same bit depth as the source Current factors supported is 2. Soon to come, 4, 8, and 16. this function only works on tiled images. Not yet implemented TODO.
multiply alpha into RGB for the specified number of pixels.
4 Byte per pixel, 8 bit unsigned char per channel only.
|
virtual |
Query if the contents of this image have changed since the last call to setClean.
|
virtual |
Explicitly set the image state to dirty.
All calls to the image class that change the contents of an image will automatically set the dirty flag, so in the normal course of affairs, you should not have to call this function.
|
virtual |
explicitly set the image state to clean.
|
virtual |
vertically flip the image (make it upside down)
|
virtual |
Causes the image cache size to adjust based on the amount of memory available.
|
virtual |
makes the image 4 channels. with the alphas 1.0.
|
friend |
|
friend |
|
protected |
|
protected |
|
protected |