MultimediaPixelImage CATPixelImage
Usage: you must use this class as is. You should never derive it.
public class CATPixelImage
Class to represent a pixel image or texture in memory.
Role: This object is used to read, visualize, write pixel images.
Supported internal formats are RGBA, RGB, LA, L (where L stands for
Luminance, that is a 8-bit Grey Scale value, and A for Alpha), RGB_S3TC_DXT1,
RGBA_S3TC_DXT1, RGBA_S3TC_DXT3, RGBA_S3TC_DXT5, RGB_f, RGBA_f.
The image can be locked to a ReadOnly State. This allows to create only one
image, and to reference it many times, with little risks for modification
conflicts.
You can create a CATPixelImage from RGB, TIFF, JPEG, BMP, PNG files.
You can visualize a CATPixelImage using the class.
The pointer to the pixel data points to the first pixel of the bottom line (or row) of the image.
Origin is bottom left corner.
The data is not stored by colors planes, but pixel by pixel
(that is : RGBRGBRGB... or RGBARGBARGBA...).
- See also:
- , , , , ,
Constructor and Destructor Index
- o
CATPixelImage()
- Default constructor.
- o
CATPixelImage(CATPixelImage&)
- Copy constructor.
- o
CATPixelImage(int,int,CATPixelImageFormat)
- Constructs a blank image.
- o
CATPixelImage(int,int,CATPixelImageFormat,float*,CATDeallocatePixels)
- Constructs an image from a pixel array, pixel data is not duplicated.
- o
CATPixelImage(int,int,CATPixelImageFormat,unsigned char*,CATDeallocatePixels)
- Constructs an image from a pixel array, pixel data is not duplicated.
- o
~CATPixelImage()
-
Method Index
- o
ChangeFormat(CATPixelImageFormat)
- Changes the image format.
- o
ChangeFormatBilevel(DITHER_MODE)
- Changes the image format to BILEVEL using DITHER_MODE algorithm.
- o
ChangeTransparencyToColor(unsigned char,unsigned char,unsigned char)
- Replaces every pixel whose alpha component is smaller than 128 by a new color.
- o
CreateFromFile(CATString&,CATReadOnlyState,int)
- Creates an image from a file.
- o
CreateFromFile(CATString&,CATString&,CATReadOnlyState,int)
- Creates an image from a file given an explicit file format.
- o
CreateRotatedImage(int)
- Creates a rotated image from an existing image.
- o
CreateSubImage(int,int,int,int)
- Creates a new CATPixelImage from a region of the image.
- o
CreateZoomedImage(float,int)
- Creates a zoomed image from an existing image.
- o
CreateZoomedImage(int,int,int)
- Creates a zoomed image from an existing image.
- o
Dither()
- Grey levels to Black and White conversion using Floyd-Steinberg algorithm.
- o
DitherAverageThreshold()
- Grey levels to Black and White conversion using average threshold algorithm.
- o
Duplicate()
- Duplicates an image.
- o
Duplicate(CATPixelImageFormat)
- Duplicates an image and changes the format of the resulting image.
- o
GetBgColor(unsigned char*,unsigned int)
- Returns an array of the most frequent colors.
- o
GetBitsPerPixel()
- Returns the number of bits per pixel.
- o
GetColorAtPixel(unsigned int,unsigned int,unsigned int*,unsigned int*,unsigned int*,unsigned int*)
- Retrieves the color of a pixel.
- o
GetDXTnLineProgression()
- Gets the line progression for DXTn compressed pixel image.
- o
GetFileCommentList(CATListValCATString&)
- Get a list of the supported file formats comments.
- o
GetFileExtensionList(CATListValCATString&)
- Get the list of the supported file formats extensions.
- o
GetFileFormatList(CATListValCATString&)
- Get the list of the supported file formats.
- o
GetFileFormatProperties(CATString&,CATString&,CATString**,CATString**,CATString**,CATString**)
- Retrieves the properties of a given file format.
- o
GetFileOptionsList(CATListValCATString&)
- Get a list of the supported file formats options.
- o
GetFileRWList(CATListValCATString&)
- Get a list of the supported file formats Read and Write properties.
- o
GetFormat()
- Returns the image format.
- o
GetFormatStr()
- Returns the image format as a string.
- o
GetHBITMAP()
- Creates a HBITMAP from a CATPixelImage (MS-Windows only).
- o
GetLastError()
- Returns the latest error.
- o
GetNumberOfPages(CATString&)
- Returns the number of pages for a multipage file.
- o
GetPixelsToModify()
- Returns the pixel data for modification.
- o
GetPixelsToRead()
- Returns the pixel data for consultation.
- o
GetSecondaryPixelsToRead(CATSecondaryPixelImageFormat,CATLineProgression)
- Returns the secondary image pixel data for consultation.
- o
GetSize(int&,int&)
- Retrieves the image size in pixels.
- o
GetXPixelSize()
- Returns the size in mm of one pixel in X direction.
- o
GetYPixelSize()
- Returns the size in mm of one pixel in Y direction.
- o
GetbytesPerPixel()
- Returns the number of bytes per pixel.
- o
InsertPixelImage(int,int,CATPixelImage*,int)
- Inserts a CATPixelImage inside the image.
- o
InvertLineProgression()
- Inverts the line progression (flips the image).
- o
InvertTransparency()
- Replaces the A (alpha) component by 255-A.
- o
IsReadOnly()
- Returns TRUE if the image is locked as read only.
- o
IsValidBitmapFile(CATString&)
- Says whether the given file is a valid bitmap file or not.
- o
LockAsReadOnly()
- Prevents modifications on the image.
- o
Modify(int,int,CATPixelImageFormat,unsigned char*,CATDeallocatePixels)
- Redefines an image.
- o
ModifyBgColor(unsigned int,unsigned char,unsigned char,unsigned char)
- Looks for the most frequent colors and replaces them.
- o
ModifyColor(unsigned char,unsigned char,unsigned char,unsigned char,unsigned char,unsigned char)
- Changes a specific color in the whole image.
- o
SetDXTnLineProgression(CATLineProgression)
- Sets the line progression for DXTn compressed pixel image.
- o
SetImagePixelsModification()
- Informs of an image modification.
- o
SetTransparency(unsigned char)
- Modifies a RGBA picture by setting every pixel which has the same color than the upper left one to a new alpha value.
- o
SetXPixelSize(float)
- Sets the size in mm of one pixel in X direction.
- o
SetYPixelSize(float)
- Sets the size in mm of one pixel in Y direction.
- o
Sharpen(int)
- Sharpens the image applying a highpass filter.
- o
Unlock()
- Allows modifications on the image.
- o
UpdateAllList()
- Rebuilds the I/O image formats list.
- o
WriteToFile(CATString&,CATString&)
- Writes an image to a file.
- o
operator=(CATPixelImage&)
- Assignment operator.
Constructor and Destructor
o CATPixelImage
-
Default constructor.
o CATPixelImage
| public CATPixelImage( | const | iPixelImage) |
-
Copy constructor.
- Parameters:
-
- iPixelImage
- An existing CATPixelImage.
o CATPixelImage
| public CATPixelImage( | | iXSize, |
| | iYSize, |
| | iFormat) |
-
Constructs a blank image.
Use
to modify it.
The warning indicated on the previous constructor does not apply here.
- Parameters:
-
- iXSize
- The width of the image in pixels.
- iYSize
- The height of the image in pixels.
- iFormat
- The format of the data.
o CATPixelImage
| public CATPixelImage( | | iXSize, |
| | iYSize, |
| | iFormat, |
| | iPixels, |
| | iToDelete | = PixDeallocateNO) |
-
Constructs an image from a pixel array, pixel data is not duplicated.
Be careful with this constructor because you have to make sure
to not deallocate pixels memory before any CATPixelImage referencing
this data has disappeared. This is true for this image, but also any
image copied from this image.
Use PixDeallocateYESdelete if data to delete has been allocated with new.
Use PixDeallocateYESfree if data to delete has been allocated with malloc.
CAREFUL :
Change the iToDelete value to PixDeallocateYESdelete or PixDeallocateYESfree
do delete pixels when you delete the CATPixelImage.
- Parameters:
-
- iXSize
- The width of the image in pixels.
- iYSize
- The height of the image in pixels.
- iFormat
- The format of the data stored in the pixel array.
- ifPixels
- The pixel data in float.
- iToDelete
- Whether the given pixel array has to be deleted when the CATPixelImage is destroyed, and how (free() or delete[]).
The default value for this parameter is PixelDeallocateNO, which implies the pixel data is not deleted when the image is destroyed.
It is the user to delete the pixel data.
o CATPixelImage
| public CATPixelImage( | | iXSize, |
| | iYSize, |
| | iFormat, |
| | iPixels, |
| | iToDelete | = PixDeallocateNO) |
-
Constructs an image from a pixel array, pixel data is not duplicated.
Be careful with this constructor because you have to make sure
to not deallocate pixels memory before any CATPixelImage referencing
this data has disappeared. This is true for this image, but also any
image copied from this image.
Use PixDeallocateYESdelete if data to delete has been allocated with new.
Use PixDeallocateYESfree if data to delete has been allocated with malloc.
CAREFUL :
Change the iToDelete value to PixDeallocateYESdelete or PixDeallocateYESfree
do delete pixels when you delete the CATPixelImage.
- Parameters:
-
- iXSize
- The width of the image in pixels.
- iYSize
- The height of the image in pixels.
- iFormat
- The format of the data stored in the pixel array.
- iPixels
- The pixel data.
- iToDelete
- Whether the given pixel array has to be deleted when the CATPixelImage is destroyed, and how (free() or delete[]).
The default value for this parameter is PixelDeallocateNO, which implies the pixel data is not deleted when the image is destroyed.
It is the user to delete the pixel data.
o ~CATPixelImage
| public virtual ~CATPixelImage( | ) |
-
Methods
o ChangeFormat
| public virtual ChangeFormat( | | iFormat) |
-
Changes the image format.
Valid conversions are: RGB to RGBA and RGBA to RGB.
- Parameters:
-
- iFormat
- The new format.
- Returns:
-
Legal values
- 0
- Success.
o ChangeFormatBilevel
| public virtual ChangeFormatBilevel( | | mode | = DITHER_FloydSteinberg) |
-
Changes the image format to BILEVEL using DITHER_MODE algorithm.
- Parameters:
-
- iMode
- The dither algorithm (FloydSteinberg or AverageTheshold).
- Returns:
-
Legal values
- 0
- Success.
o ChangeTransparencyToColor
| public ChangeTransparencyToColor( | | iR, |
| | iG, |
| | iB) |
-
Replaces every pixel whose alpha component is smaller than 128 by a new color.
- Parameters:
-
- iR
- The new Red component.
- iG
- The new Green component.
- iB
- The new Blue component.
- Returns:
-
Legal values
- 0
- Success.
- 1
- Failure.
- 2
- Image is ReadOnly.
- See also:
-
o CreateFromFile
| public static CreateFromFile( | const | iPathName, |
| | iRState | = NotReadOnly, |
| | iPageNumber | = 0) |
-
Creates an image from a file.
- Parameters:
-
- iPathName
- The file to create the image from.
Recognized formats are : TIFF, BMP, JPEG, PNG, RGB, PICTURE.
- iRState
- The ReadOnly state of the new image.
- Returns:
-
- A new CATPixelImage.
o CreateFromFile
| public static CreateFromFile( | const | iFileFormat, |
| const | iPathName, |
| | iRState | = NotReadOnly, |
| | iPageNumber | = 0) |
-
Creates an image from a file given an explicit file format.
- Parameters:
-
- iFileFormat
- The format of the file to create the image from ; valid values are :
Legal values
- "TIFF"
- "RGB"
- "JPEG"
- "BMP"
- "PNG"
- "PICTURE"
- iPathName
- The file to create the image from.
- iRState
- The ReadOnly state of the new image.
- Returns:
-
- A new CATPixelImage.
o CreateRotatedImage
| public virtual CreateRotatedImage( | | iAngleInDegrees) |
-
Creates a rotated image from an existing image.
- Parameters:
-
- iAngleInDegrees
- Legal values are 90, 180, 270.
- Returns:
-
- A new CATPixelImage.
o CreateSubImage
| public virtual CreateSubImage( | | iXMin, |
| | iYMin, |
| | iXMax, |
| | iYMax) |
-
Creates a new CATPixelImage from a region of the image.
- Parameters:
-
- iXMin
- The X left coordinate of the region.
- iXMax
- The X right coordinate of the region.
- iYMin
- The Y lower coordinate of the region.
- iYMax
- The Y upper coordinate of the region.
- Returns:
-
- A new CATPixelImage.
o CreateZoomedImage
| public virtual CreateZoomedImage( | | iZoomFactor, |
| | iZoomQuality | = 1) |
-
Creates a zoomed image from an existing image.
The size in mm of the image is also zoomed (that is the size in mm of each pixel is not changed).
- Parameters:
-
- iZoomFactor
- The zoom factor.
- iZoomQuality
-
Legal values
- 1
- Pixel replication only (fast, poor quality).
- 2
- if iZoomFactor < 1 : linear interpolation, replication if > 1.
- 3
- Linear interpolation in all cases (slow, good quality).
- Returns:
-
- A new CATPixelImage.
o CreateZoomedImage
| public virtual CreateZoomedImage( | | iXSize, |
| | iYSize, |
| | iZoomQuality | = 1) |
-
Creates a zoomed image from an existing image.
The size in mm of the image is also zoomed (that is the size in mm of each pixel is not changed).
- Parameters:
-
- iXSize
- The width of the new image in pixels.
- iYSize
- The height of the new image in pixels.
- iZoomQuality
-
Legal values
- 1
- Pixel replication only (fast, poor quality).
- 2
- if iZoomFactor < 1 : linear interpolation, replication if > 1.
- 3
- Linear interpolation in all cases (slow, good quality).
- Returns:
-
- A new CATPixelImage.
o Dither
-
Grey levels to Black and White conversion using Floyd-Steinberg algorithm.
Pixel format must be L and remains L.
- Returns:
-
Legal values
- 0
- Success.
- 1
- Invalid image.
- 2
- Image is ReadOnly.
- See also:
-
o DitherAverageThreshold
| public virtual DitherAverageThreshold( | ) |
-
Grey levels to Black and White conversion using average threshold algorithm.
Pixel format must be L and remains L.
- Returns:
-
Legal values
- 0
- Success.
- 1
- Invalid image.
- 2
- Image is ReadOnly.
- See also:
-
o Duplicate
| public virtual Duplicate( | ) |
-
Duplicates an image.
This allows to modify a ReadOnly image.
- Returns:
-
- A CATPixelImage pointer
- The resulting image is not ReadOnly.
- See also:
-
o Duplicate
| public virtual Duplicate( | | iFormat) |
-
Duplicates an image and changes the format of the resulting image.
This allows to modify a ReadOnly image.
- Parameters:
-
- iFormat
- The new format.
- Returns:
-
- A CATPixelImage pointer
- The resulting image is not ReadOnly.
- See also:
-
o GetBgColor
| public virtual GetBgColor( | | oColorArray, |
| | iNbBgColor) |
-
Returns an array of the most frequent colors.
The image must be in RGB format.
- Parameters:
-
- oColorArray
- The array of found colors. The array must be allocated before you call this method : oColorArray = new unsigned char[iNbBgColor*3].
- iNbBgColor
- The number of colors to look for. Must be <= 4.
- Returns:
-
Legal values
- 0
- Success.
- -1
- Invalid format.
- -2
- Invalid image.
- -3
- Invalid iNbBgColor parameter.
- See also:
-
o GetBitsPerPixel
| public virtual GetBitsPerPixel( | ) |
-
Returns the number of bits per pixel.
- Returns:
-
Legal values
- 8
- L format.
- 16
- LA format.
- 24
- RGB format.
- 32
- RGBA format.
- 0
- RGB_S3TC_DXT1 format.
- 0
- RGBA_S3TC_DXT1 format.
- 0
- RGBA_S3TC_DXT3 format.
- 0
- RGBA_S3TC_DXT5 format.
- 96
- RGB_f format.
- 128
- RGBA_f format.
- 0
- Invalid format.
- See also:
-
o GetColorAtPixel
| public virtual GetColorAtPixel( | | iX, |
| | iY, |
| | oRL, |
| | oG, |
| | oB, |
| | oA) |
-
Retrieves the color of a pixel.
If format is L, only oRL is evaluated (oRL and oA for LA format)
- Parameters:
-
- iX
- The X coordinate of the pixel.
- iY
- The Y coordinate of the pixel.
- oRL
- The Red or Luminance value of the pixel.
- oG
- The Green value of the pixel.
- oB
- The Blue value of the pixel.
- oA
- The Alpha value of the pixel.
- Returns:
-
- The format of the picture.
o GetDXTnLineProgression
| public virtual GetDXTnLineProgression( | ) |
-
Gets the line progression for DXTn compressed pixel image.
Be careful, if the line progression is normalised and if the image height is not a multiple of 4,
top lines will be removed to get the right image height.
Otherwise, the bottom lines will be removed.
- Parameters:
-
- oLineProgression
- The line progression of pixel image with DXTn CATPixelImageFormat.
o GetFileCommentList
| public static GetFileCommentList( | | ) |
-
Get a list of the supported file formats comments.
- Parameters:
-
-
-
- A CATListValCATStrings giving the file formats comments.
o GetFileExtensionList
| public static GetFileExtensionList( | | ) |
-
Get the list of the supported file formats extensions.
- Parameters:
-
-
-
- A CATListValCATStrings giving the file formats extensions.
o GetFileFormatList
| public static GetFileFormatList( | | ) |
-
Get the list of the supported file formats.
- Parameters:
-
-
-
- A CATListValCATStrings giving the supported file formats.
o GetFileFormatProperties
| public virtual GetFileFormatProperties( | const | iFileFormat, |
| const | iReadOrWrite, |
| | oExtension, |
| | oCommand, |
| | oOptions, |
| | oComment) |
-
Retrieves the properties of a given file format.
- Parameters:
-
- iFileFormat
- The requested file format (see
,
).
- iReadOrWrite
- The Read or Write properties of the file format.
- oExtensions
- The extension string associated with this file format.
- oCommand
- The command string associated with this file format.
- oOptions
- The options string associated with this file format.
- oComment
- The comment string associated with this file format.
o GetFileOptionsList
| public static GetFileOptionsList( | | ) |
-
Get a list of the supported file formats options.
- Parameters:
-
-
-
- A CATListValCATStrings giving the file formats options.
o GetFileRWList
| public static GetFileRWList( | | ) |
-
Get a list of the supported file formats Read and Write properties.
- Parameters:
-
-
-
- A CATListValCATStrings giving the file formats Read and Write properties.
o GetFormat
| public virtual GetFormat( | ) |
-
Returns the image format.
- Returns:
-
Legal values
- L
- L format.
- LA
- LA format.
- RGB
- RGB format.
- RGBA
- RGBA format.
- RGB_S3TC_DXT1
- RGB_S3TC_DXT1 format.
- RGBA_S3TC_DXT1
- RGBA_S3TC_DXT1 format.
- RGBA_S3TC_DXT3
- RGBA_S3TC_DXT3 format.
- RGBA_S3TC_DXT5
- RGBA_S3TC_DXT5 format.
- RGB_f
- RGB_f format.
- RGBA_f
- RGBA_f format.
- BADFORMAT
- Invalid format.
o GetFormatStr
| public virtual GetFormatStr( | ) |
-
Returns the image format as a string.
- Returns:
-
Legal values
- See GetFormat().
o GetHBITMAP
-
Creates a HBITMAP from a CATPixelImage (MS-Windows only).
The image must be in RGB format.
o GetLastError
| public static GetLastError( | ) |
-
Returns the latest error.
- Returns:
-
- Returns the last available error message.
o GetNumberOfPages
| public static GetNumberOfPages( | const | iPathName) |
-
Returns the number of pages for a multipage file.
o GetPixelsToModify
| public virtual GetPixelsToModify( | ) |
-
Returns the pixel data for modification.
- Returns:
-
- A pointer to the pixel data
o GetPixelsToRead
| public virtual GetPixelsToRead( | ) |
-
Returns the pixel data for consultation.
- Returns:
-
- A const pointer to the pixel data
o GetSecondaryPixelsToRead
| public virtual GetSecondaryPixelsToRead( | | iFormat, |
| | iProgression) |
-
Returns the secondary image pixel data for consultation.
- Parameters:
-
- iFormat
- The secondary image format.
- iProgression
- The secondary image line progression.
- Returns:
-
- A const pointer to the secondary image pixel data
o GetSize
| public virtual GetSize( | | oXSize, |
| | oYSize) |
-
Retrieves the image size in pixels.
- Parameters:
-
- oXSize
- Image width in pixels.
- oYSize
- Image height in pixels.
o GetXPixelSize
| public virtual GetXPixelSize( | ) |
-
Returns the size in mm of one pixel in X direction.
o GetYPixelSize
| public virtual GetYPixelSize( | ) |
-
Returns the size in mm of one pixel in Y direction.
o GetbytesPerPixel
| public virtual GetbytesPerPixel( | ) |
-
Returns the number of bytes per pixel.
- Returns:
-
Legal values
- 1
- L format.
- 2
- LA format.
- 3
- RGB format.
- 4
- RGBA format.
- 0
- RGB_S3TC_DXT1 format.
- 0
- RGBA_S3TC_DXT1 format.
- 0
- RGBA_S3TC_DXT3 format.
- 0
- RGBA_S3TC_DXT5 format.
- 12
- RGB_f format.
- 16
- RGBA_f format.
- 0
- Invalid format.
- See also:
-
o InsertPixelImage
| public virtual InsertPixelImage( | | iX, |
| | iY, |
| const | iPixelImage, |
| | iTransparency | = 0) |
-
Inserts a CATPixelImage inside the image.
Images must be of same type. The input image is clipped if it is larger than the original image.
- Parameters:
-
- iX
- The X coordinate of the insertion point.
- iY
- The Y coordinate of the insertion point.
- iPixelImage
- The CATPixelImage to insert.
- iTransparency
- If not null, the color of the first pixel of iPixelImage is taken as transparent
- Returns:
-
Legal values
- 0
- Success.
- 1
- iPixelImage is not a valid image.
- 2
- iPixelImage cannot be copied on itself.
- 10
- Image is ReadOnly or formats are different.
- See also:
-
o InvertLineProgression
| public virtual InvertLineProgression( | ) |
-
Inverts the line progression (flips the image).
- Returns:
-
Legal values
- 0
- Success.
o InvertTransparency
| public virtual InvertTransparency( | ) |
-
Replaces the A (alpha) component by 255-A.
- Returns:
-
Legal values
- 0
- Success.
- 1
- Failure.
o IsReadOnly
| public virtual IsReadOnly( | ) |
-
Returns TRUE if the image is locked as read only.
Returns FALSE if modifications are allowed.
o IsValidBitmapFile
| public static IsValidBitmapFile( | const | iPathName) |
-
Says whether the given file is a valid bitmap file or not.
o LockAsReadOnly
| public virtual LockAsReadOnly( | ) |
-
Prevents modifications on the image.
- See also:
-
o Modify
| public virtual Modify( | | iXSize, |
| | iYSize, |
| | iFormat, |
| | iPixels, |
| | iToDelete | = PixDeallocateNO) |
-
Redefines an image.
In some cases the assignment operator may be used in place of this method.
The pixel data is not duplicated ; because of this, pixel data should not be
deallocated before any CATPixelImage referencing this data has disappeared.
This is also true for any image copied from this image.
- Parameters:
-
- iXSize
- The width of the image in pixels.
- iYSize
- The height of the image pixels.
- iFormat
- The format of the data stored in the pixel array.
- iPixels
- The pixel data.
- iToDelete
- Whether the given pixel array has to be deleted when the CATPixelImage is destroyed, and how (free() or delete[]).
The default value for this parameter is PixelDeallocateNO, which implies the pixel data is not deleted when the image is destroyed.
It is the user to delete the pixel data.
- Returns:
-
Legal values
- 0
- Success.
o ModifyBgColor
| public virtual ModifyBgColor( | | iNbBgColor, |
| | iR, |
| | iG, |
| | iB) |
-
Looks for the most frequent colors and replaces them.
The image must be in RGB format.
- Parameters:
-
- iNbBgColor
- The number of colors to look for. Must be <= 4.
- iR
- The new Red component.
- iG
- The new Green component.
- iB
- The new Blue component.
- Returns:
-
Legal values
- 0
- Success.
- 1
- Image is ReadOnly.
- 2
- Invalid format.
- 3
- Invalid iNbBgColor parameter.
- See also:
- ,
o ModifyColor
| public virtual ModifyColor( | | iR1, |
| | iG1, |
| | iB1, |
| | iR2, |
| | iG2, |
| | iB2) |
-
Changes a specific color in the whole image.
- Parameters:
-
- iR1
- The old Red value.
- iG1
- The old Green value.
- iB1
- The old Blue value.
- iR2
- The new Red value.
- iG2
- The new Green value.
- iB2
- The new Blue value.
- Returns:
-
Legal values
- 0
- Success.
- 1
- Image is ReadOnly.
- 2
- Bad format.
- See also:
-
o SetDXTnLineProgression
| public virtual SetDXTnLineProgression( | | iLineProgression) |
-
Sets the line progression for DXTn compressed pixel image.
Be careful, if the line progression is normalised and if the image height is not a multiple of 4,
top lines will be removed to get the right image height.
Otherwise, the bottom lines will be removed.
- Parameters:
-
- iLineProgression
- The line progression of pixel image with DXTn CATPixelImageFormat.
o SetImagePixelsModification
| public virtual SetImagePixelsModification( | ) |
-
Informs of an image modification.
Role: This method is not defined on a CATPixelImage.
For a
, a flag is set to indicate that a pixel in the data zone is modified so that the image is regenerated at the next draw.
This method is used in all the methods of CATPixelImage wich modify
the pixel data.
o SetTransparency
| public SetTransparency( | | iAlpha | = 0) |
-
Modifies a RGBA picture by setting every pixel which has the same color than the upper left one to a new alpha value.
- Parameters:
-
- iAlpha
- The new alpha value. iAlpha = 0 means transparent, iAlpha = 255 means opaque.
- Returns:
-
Legal values
- 0
- Success.
- 1
- Failure.
- 2
- Image is ReadOnly.
- See also:
-
o SetXPixelSize
| public virtual SetXPixelSize( | | iXPixelSize) |
-
Sets the size in mm of one pixel in X direction.
- Parameters:
-
- iXPixelSize
- The new X pixel size.
o SetYPixelSize
| public virtual SetYPixelSize( | | iYPixelSize) |
-
Sets the size in mm of one pixel in Y direction.
- Parameters:
-
- iYPixelSize
- The new Y pixel size.
o Sharpen
| public virtual Sharpen( | | iAmount) |
-
Sharpens the image applying a highpass filter.
- Parameters:
-
- iAmount
- The sharpening amount.
0 < iAmount <= 200 gives good results.
iAmount = 50 is a good value
- Returns:
-
Legal values
- 0
- Success.
- 1
- Invalid image.
- 2
- Image is ReadOnly.
- See also:
-
o Unlock
-
Allows modifications on the image.
- See also:
-
o UpdateAllList
| public virtual UpdateAllList( | ) |
-
Rebuilds the I/O image formats list.
o WriteToFile
| public virtual WriteToFile( | const | iFileFormat, |
| const | iPathName) |
-
Writes an image to a file.
- Parameters:
-
- iFileFormat
- The output file format.
Legal values
- "TIFF"
- True color uncompressed TIFF file.
- "TIFFTCPB"
- True color PackBits compressed TIFF file.
- "TIFFINDEX"
- Indexed (256 colors) uncompressed TIFF file.
- "TIFFPB"
- Indexed (256 colors) PackBits compressed TIFF file.
- "TIFFGREY"
- Grey scale PackBits compressed TIFF file.
- "TIFFBWPB"
- Bilevel (black and white) PackBits compressed TIFF file.
- "RGB"
- RGB file (SGI format).
- "HPRTL"
- HP/RTL - 300 dpi.
- "BMP"
- Windows Bitmap.
- "JPEG_FAIR"
- JPEG, fair quality.
- "JPEG"
- JPEG, medium quality.
- "JPEG_HIGH"
- JPEG, high quality.
- "PNG"
- Portable Network Graphics.
- iPathName
- The file to save the image in.
- Returns:
-
Legal values
- 0
- Success.
o operator=
| public operator=( | const | iPixelImage) |
-
Assignment operator.
- Parameters:
-
- iPixelImage
- An existing CATPixelImage.
This object is included in the file: CATPixelImage.h
If needed, your Imakefile.mk should include the module: CATMMediaPixelImage
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.