FBImage Class Reference
Detailed Description
Image class.
Utility class used to load and get manipulate image data from disk or memory.
Inheritance diagram for FBImage:
Public Member Functions |
|
| __init__ (str pFileName, object pObject=None) | |
| Constructor. |
|
| FBDelete () | |
| Virtual FBDelete function. |
|
| Cleanup () | |
| Cleanup image data, making it black.
|
|
| bool | Init (FBImageFormat pFormat, int pWidth, int pHeight) |
| Init. |
|
| str | GetDataBuffer () |
| Access image data buffer, allow
modifications. |
|
| bool | ConvertFormat (FBImageFormat pNewFormat) |
| Convert the image data format to another
format. |
|
| bool | ConvertSize (int pWidth, int pHeight) |
| Convert the image size. |
|
| VerticalFlip () | |
| Flip the image vertically. |
|
| bool | WriteToTif (str pFileName, str pComments, bool pCompressed) |
| Write image data to a TIF file on disk.
|
|
| bool | IsCompressedTif (str pFileName) |
| Query TIF file about its compressed status.
|
|
Public Attributes |
|
| FBPropertyBase | Width |
| Read Write Property: Width of the
image in pixels. |
|
| FBPropertyBase | Height |
| Read Write Property: Height of the
image in pixels. |
|
| FBPropertyBase | Depth |
| Read Write Property: Color depth of
the image. |
|
| FBPropertyImageFormat | Format |
| Read Write Property: Image data
format. |
|
| FBPropertyImageType | Type |
| Read Only Property: Image type,
refering to either frame or field. |
|
| FBPropertyImageInterleaveType | InterleaveType |
| Read Only Property: Image interleave
type. |
|
| FBPropertyImageInterpolationType | InterpolationType |
| Read Only Property: Image
interpolation type. |
|
Member Function Documentation
Constructor.
- Parameters:
-
pFileName Path to the image file. If pObject is not NULL, pFileName will be ignored. pObject For internal use only.
| FBDelete | ( | ) |
| Cleanup | ( | ) |
Cleanup image data, making it black.
| bool Init | ( | FBImageFormat | pFormat, |
| int | pWidth, | ||
| int | pHeight | ||
| ) |
Init.
- Parameters:
-
pFormat Image format used to initialize data buffer. pWidth Image width in pixels. pHeight Image height in pixels.
| str GetDataBuffer | ( | ) |
Access image data buffer, allow modifications.
- Returns:
- Pointer to the image data, values ranging from 0 to 255.
| bool ConvertFormat | ( | FBImageFormat | pNewFormat | ) |
Convert the image data format to another format.
- Parameters:
-
pNewFormat The new format to convert the image to.
- Returns:
- Return true if the convert was successful.
Convert the image size.
- Parameters:
-
pWidth New width of the image. pHeight New height of the image.
- Returns:
- Return true if the convert was successful.
| VerticalFlip | ( | ) |
Flip the image vertically.
Write image data to a TIF file on disk.
- Parameters:
-
pFileName Full TIF file path name of the file to write. pComments Comments appended to the TIF file. pCompressed If true, the image data in the file will be compressed.
- Returns:
- Return true if the image was successfully written on disk.
Query TIF file about its compressed status.
- Parameters:
-
pFileName Full TIF file path name of the file to query.
- Returns:
- Return true if the TIF file image data is compressed.
Member Data Documentation
| FBPropertyBase Width |
Read Write Property: Width of the image in pixels.
| FBPropertyBase Height |
Read Write Property: Height of the image in pixels.
| FBPropertyBase Depth |
Read Write Property: Color depth of the image.
| FBPropertyImageFormat Format |
Read Write Property: Image data format.
| FBPropertyImageType Type |
Read Only Property: Image type, refering to either frame or field.
| FBPropertyImageInterleaveType InterleaveType |
Read Only Property: Image interleave type.
Only meaningful if image type is field.
| FBPropertyImageInterpolationType InterpolationType |
Read Only Property: Image interpolation type.
