documentation.help

IM: File Format SDK

From IM - An Imaging Tool

previous page next page

File Format SDK
[Image Storage]

Detailed Description

All the file formats are based on theses structures. Use them to create new file formats.
The LineBuffer functions will help transfer image from format buffer to application buffer and vice-versa.
See im_file.h


Data Structures

struct  _imFile
 Image File Format Base (SDK Use Only). More...
class  imFormat
 Image File Format Driver (SDK Use Only). More...

Typedefs

typedef imFormat *(* imFormatFunc )()

Functions

int imFileLineBufferCount (imFile *ifile)
void imFileLineBufferInc (imFile *ifile, int *row, int *plane)
void imFileLineBufferRead (imFile *ifile, void *data, int line, int plane)
void imFileLineBufferWrite (imFile *ifile, const void *data, int line, int plane)
int imFileLineSizeAligned (int width, int bpp, int align)
void imFormatRegister (imFormatFunc format_init)

Typedef Documentation

typedef imFormat*(* imFormatFunc)()
 

Format function initialization definition.

Function Documentation

int imFileLineBufferCount (  imFile *  ifile  ) 
 

Number of lines to be accessed.

void imFileLineBufferInc (  imFile *  ifile,
int *  row,
int *  plane
) 
 

Increments the row and plane counters.

void imFileLineBufferRead (  imFile *  ifile,
void *  data,
int  line,
int  plane
) 
 

Converts from FILE color mode to USER color mode.

void imFileLineBufferWrite (  imFile *  ifile,
const void *  data,
int  line,
int  plane
) 
 

Converts from USER color mode to FILE color mode.

int imFileLineSizeAligned (  int  width,
int  bpp,
int  align
) 
 

Utility to calculate the line size in byte with a specified alignment.
"align" can be 1, 2 or 4.

void imFormatRegister (  imFormatFunc  format_init  ) 
 

Register a format driver.


previous page start next page