IMG_FormatPassThru Class Reference
#include <IMG_FormatPassThru.h>
Public Member Functions | |
| IMG_FormatPassThru (const IMG_File *parent_file) | |
| virtual | ~IMG_FormatPassThru () |
| virtual const char * | getFormatName () const |
| virtual const char * | getFormatLabel () const |
| virtual const char * | getFormatDescription () const |
| virtual const char * | getDefaultExtension () const |
| virtual const char * | getFormatLocation () const |
| Describes how the format was loaded (i.e. DSO or internal formats). | |
| virtual int | checkExtension (const char *filename) const |
| virtual int | checkMagic (unsigned int magic) const |
| virtual int | checkMagicSeekable (UT_IStream &is) const |
| virtual bool | isPassThrough () const |
| virtual int | checkDevice (const char *filename) const |
| virtual IMG_DataType | getSupportedTypes () const |
| Returns a bitfield of data types supported by this format. | |
| virtual IMG_ColorModel | getSupportedColorModels () const |
| virtual void | getMaxResolution (unsigned &x, unsigned &y) const |
| virtual int | isReadRandomAccess () const |
| virtual int | isWriteRandomAccess () const |
| virtual int | isTopFirst () const |
| virtual int | isLeftFirst () const |
| virtual bool | isDataWindowSupported () const |
| does this format support a data window or sub-area. | |
| virtual bool | isDataWindowStreakSupported () const |
| virtual bool | isDeepRasterSupported () const |
| virtual bool | isDataInterleaved () const |
| virtual bool | canPlaneTypesDiffer () const |
| virtual const IMG_FileOptionList * | getOptions () const |
Protected Member Functions | |
| virtual IMG_File * | createFile () const |
| virtual int | isFormatOk (const IMG_Stat &) const |
| const IMG_Format * | getParent () const |
Protected Attributes | |
| const IMG_File * | myParent |
Detailed Description
Definition at line 52 of file IMG_FormatPassThru.h.
Constructor & Destructor Documentation
| IMG_FormatPassThru::IMG_FormatPassThru | ( | const IMG_File * | parent_file | ) | [inline] |
Definition at line 58 of file IMG_FormatPassThru.h.
| virtual IMG_FormatPassThru::~IMG_FormatPassThru | ( | ) | [inline, virtual] |
Definition at line 63 of file IMG_FormatPassThru.h.
Member Function Documentation
| virtual bool IMG_FormatPassThru::canPlaneTypesDiffer | ( | ) | const [inline, virtual] |
if true, planes can have different data formats & components. Otherwise, all planes must have the same data type and number of components.
Reimplemented from IMG_Format.
Definition at line 117 of file IMG_FormatPassThru.h.
| virtual int IMG_FormatPassThru::checkDevice | ( | const char * | ) | const [inline, virtual] |
The device method gives a higher priority to device checks. By default, this method returns 0 (no match). This is used to allow things like a60:3.pic (which uses the abekas device).
Reimplemented from IMG_Format.
Definition at line 85 of file IMG_FormatPassThru.h.
| virtual int IMG_FormatPassThru::checkExtension | ( | const char * | filename | ) | const [inline, virtual] |
Methods to determine if this is one of our recognized files. The extension is the first try. If there are multiple matches, then we resort to the magic number (when reading)
Implements IMG_Format.
Definition at line 76 of file IMG_FormatPassThru.h.
| virtual int IMG_FormatPassThru::checkMagic | ( | unsigned int | int | ) | const [inline, virtual] |
If possible, this magic numver checker will be called. This is used if the file is "seekable" (i.e. that we can rewind after checking)
Reimplemented from IMG_Format.
Definition at line 78 of file IMG_FormatPassThru.h.
| virtual int IMG_FormatPassThru::checkMagicSeekable | ( | UT_IStream & | is | ) | const [inline, virtual] |
If possible, this second magic number checker will be called. This is used if the file is "seekable" (i.e. that we can rewind after checking)
Reimplemented from IMG_Format.
Definition at line 80 of file IMG_FormatPassThru.h.
| virtual IMG_File* IMG_FormatPassThru::createFile | ( | ) | const [inline, protected, virtual] |
Specifies if this format can read an image file. One of isReadable() or isWritable() (or both) must return true.
Implements IMG_Format.
Definition at line 125 of file IMG_FormatPassThru.h.
| virtual const char* IMG_FormatPassThru::getDefaultExtension | ( | ) | const [inline, virtual] |
The default extension is used to determine whether the format should appear in the device/format menus. It should not contain the '.' (i.e. "tif" not ".tif")
Reimplemented from IMG_Format.
Definition at line 71 of file IMG_FormatPassThru.h.
| virtual const char* IMG_FormatPassThru::getFormatDescription | ( | ) | const [inline, virtual] |
This can be optionally overridden to return a short description of the format. By default, no description is given.
Reimplemented from IMG_Format.
Definition at line 69 of file IMG_FormatPassThru.h.
| virtual const char* IMG_FormatPassThru::getFormatLabel | ( | ) | const [inline, virtual] |
If getFormatLabel() is not overridden, the label will be the same as the name.
Reimplemented from IMG_Format.
Definition at line 67 of file IMG_FormatPassThru.h.
| virtual const char* IMG_FormatPassThru::getFormatLocation | ( | ) | const [inline, virtual] |
Describes how the format was loaded (i.e. DSO or internal formats).
Reimplemented from IMG_Format.
Definition at line 73 of file IMG_FormatPassThru.h.
| virtual const char* IMG_FormatPassThru::getFormatName | ( | ) | const [inline, virtual] |
All formats must have a unique name (like "JPEG").
Implements IMG_Format.
Definition at line 65 of file IMG_FormatPassThru.h.
| virtual void IMG_FormatPassThru::getMaxResolution | ( | unsigned & | x, | |
| unsigned & | y | |||
| ) | const [inline, virtual] |
Maximum allowable resolution for the file. If a user attempts to write an image larger than this, the image will be scaled to this resolution.
Implements IMG_Format.
Definition at line 92 of file IMG_FormatPassThru.h.
| virtual const IMG_FileOptionList* IMG_FormatPassThru::getOptions | ( | ) | const [inline, virtual] |
Returns a list of options that can be set on the format when reading or writing (like 'compression' or 'comment').
Reimplemented from IMG_Format.
Definition at line 120 of file IMG_FormatPassThru.h.
| const IMG_Format* IMG_FormatPassThru::getParent | ( | ) | const [inline, protected] |
Definition at line 130 of file IMG_FormatPassThru.h.
| virtual IMG_ColorModel IMG_FormatPassThru::getSupportedColorModels | ( | ) | const [inline, virtual] |
Returns a bitfield of supported color models. If IMG_CM_REVERSED is set, this format stores data in BGR/ABGR format.
Implements IMG_Format.
Definition at line 90 of file IMG_FormatPassThru.h.
| virtual IMG_DataType IMG_FormatPassThru::getSupportedTypes | ( | ) | const [inline, virtual] |
Returns a bitfield of data types supported by this format.
Implements IMG_Format.
Definition at line 88 of file IMG_FormatPassThru.h.
| virtual bool IMG_FormatPassThru::isDataInterleaved | ( | ) | const [inline, virtual] |
Specifies whether this format stores its data interleaved (RGBRGBRGB) or non-interleaved (RRRGGGBBB). If your format supports both, pick one.
Reimplemented from IMG_Format.
Definition at line 114 of file IMG_FormatPassThru.h.
| virtual bool IMG_FormatPassThru::isDataWindowStreakSupported | ( | ) | const [inline, virtual] |
does this format support saving whether the data outside the window is streaked from the window edges?
Reimplemented from IMG_Format.
Definition at line 108 of file IMG_FormatPassThru.h.
| virtual bool IMG_FormatPassThru::isDataWindowSupported | ( | ) | const [inline, virtual] |
does this format support a data window or sub-area.
Reimplemented from IMG_Format.
Definition at line 106 of file IMG_FormatPassThru.h.
| virtual bool IMG_FormatPassThru::isDeepRasterSupported | ( | ) | const [inline, virtual] |
does this format support deep rasters or multiple images? If not, only one plane of the color models that this format supports is allowed.
Reimplemented from IMG_Format.
Definition at line 111 of file IMG_FormatPassThru.h.
| virtual int IMG_FormatPassThru::isFormatOk | ( | const IMG_Stat & | stat | ) | const [inline, protected, virtual] |
Specifies if this format can read an image file. One of isReadable() or isWritable() (or both) must return true.
Reimplemented from IMG_Format.
Definition at line 127 of file IMG_FormatPassThru.h.
| virtual int IMG_FormatPassThru::isLeftFirst | ( | ) | const [inline, virtual] |
horizontal data orientation. Where (0,0) lies in the image (top-left by default).
Reimplemented from IMG_Format.
Definition at line 103 of file IMG_FormatPassThru.h.
| virtual bool IMG_FormatPassThru::isPassThrough | ( | ) | const [inline, virtual] |
Flags whether the format is a pass through format like Flip or Scale. Specific image formats (like JPEG) are never pass-through.
Reimplemented from IMG_Format.
Definition at line 83 of file IMG_FormatPassThru.h.
| virtual int IMG_FormatPassThru::isReadRandomAccess | ( | ) | const [inline, virtual] |
Some formats can be read and written in random order. Others require strict sequential order. If these methods return false, you should read and write scanlines in ascending order. When writing, they will be cached until they can be written sequentially.
Reimplemented from IMG_Format.
Definition at line 97 of file IMG_FormatPassThru.h.
| virtual int IMG_FormatPassThru::isTopFirst | ( | ) | const [inline, virtual] |
vertical data orientation. Where (0,0) lies in the image (top-left by default).
Reimplemented from IMG_Format.
Definition at line 101 of file IMG_FormatPassThru.h.
| virtual int IMG_FormatPassThru::isWriteRandomAccess | ( | ) | const [inline, virtual] |
If 0 is returned, the scanlines must be written in sequential order or they will be cached until all scanlines can be written sequentially.
Reimplemented from IMG_Format.
Definition at line 99 of file IMG_FormatPassThru.h.
Member Data Documentation
const IMG_File* IMG_FormatPassThru::myParent [protected] |
Definition at line 133 of file IMG_FormatPassThru.h.
The documentation for this class was generated from the following file:
