Image Storage
Detailed Description
- See im.h
Modules | |
File Format SDK | |
imImage Storage | |
File Formats | |
Data Structures | |
class | imImageFile |
C++ Wrapper for the Image File Structure. More... | |
Enumerations | |
enum | imErrorCodes { IM_ERR_NONE, IM_ERR_OPEN, IM_ERR_ACCESS, IM_ERR_FORMAT, IM_ERR_DATA, IM_ERR_COMPRESS, IM_ERR_MEM, IM_ERR_COUNTER } |
Functions | |
imFile * | imFileOpen (const char *file_name, int *error) |
imFile * | imFileNew (const char *file_name, const char *format, int *error) |
void | imFileClose (imFile *ifile) |
void * | imFileHandle (imFile *ifile) |
void | imFileGetInfo (imFile *ifile, char *format, char *compression, int *image_count) |
void | imFileSetInfo (imFile *ifile, const char *compression) |
void | imFileSetAttribute (imFile *ifile, const char *attrib, int data_type, int count, const void *data) |
const void * | imFileGetAttribute (imFile *ifile, const char *attrib, int *data_type, int *count) |
void | imFileGetAttributeList (imFile *ifile, char **attrib, int *attrib_count) |
void | imFileGetPalette (imFile *ifile, long *palette, int *palette_count) |
void | imFileSetPalette (imFile *ifile, long *palette, int palette_count) |
int | imFileReadImageInfo (imFile *ifile, int index, int *width, int *height, int *file_color_mode, int *file_data_type) |
int | imFileWriteImageInfo (imFile *ifile, int width, int height, int user_color_mode, int user_data_type) |
int | imFileReadImageData (imFile *ifile, void *data, int convert2bitmap, int color_mode_flags) |
int | imFileWriteImageData (imFile *ifile, void *data) |
Enumeration Type Documentation
|
File Access Error Codes
00061 { 00062 IM_ERR_NONE, /**< No error. */ 00063 IM_ERR_OPEN, /**< Error while opening the file (read or write). */ 00064 IM_ERR_ACCESS, /**< Error while accessing the file (read or write). */ 00065 IM_ERR_FORMAT, /**< Invalid or unrecognized file format. */ 00066 IM_ERR_DATA, /**< Invalid or unsupported data. */ 00067 IM_ERR_COMPRESS, /**< Invalid or unsupported compression. */ 00068 IM_ERR_MEM, /**< Insuficient memory */ 00069 IM_ERR_COUNTER /**< Interrupted by the counter */ 00070 };
|
Function Documentation
|
Opens the file for reading. It must exists. Also reads file header. |
|
Creates a new file for writing. If the file exists will be replaced. |
|
Closes the file |
|
Returns the internal handle. It is file format dependent. |
|
Returns file information. image_count is the number of images in a stack or the number of frames in a video/animation or the depth of a volume data. |
|
Changes the write compression method. |
|
Changes an extended attribute. |
|
Returns an extended attribute. |
|
Returns a list of the attribute names. |
|
Returns the pallete if any. |
|
Changes the pallete. |
|
Reads the image header if any and returns image information. |
|
Writes the image header. Writes the file header at the first time it is called. Writes also the extended image attributes. |
|
Reads the image data with or without conversion. |
|
Writes the image data. |