blob - Read or write formatted images in memory (BLOBs)
void AttachBlob( BlobInfo *blob_info, const void *blob, const size_t length );
unsigned int BlobIsSeekable( const Image *image );
unsigned int BlobToFile( const char *filename, const void *blob, const size_t length, ExceptionInfo *exception );
Image * BlobToImage( const ImageInfo *image_info, const void *blob, const size_t length, ExceptionInfo *exception );
BlobInfo * CloneBlobInfo( const BlobInfo *blob_info );
void DestroyBlob( Image *image );
void DestroyBlobInfo( BlobInfo *blob );
void DetachBlob( BlobInfo *blob_info );
void * FileToBlob( const char *filename, size_t *length, ExceptionInfo *exception );
unsigned int GetBlobClosable( const Image *image );
FILE * GetBlobFileHandle( const Image *image );
void GetBlobInfo( BlobInfo *blob_info );
int GetBlobStatus( const Image *image );
unsigned char * GetBlobStreamData( const Image *image );
const StreamHandler GetBlobStreamHandler( const Image *image );
StreamType GetBlobStreamType( const Image *image );
unsigned int GetBlobTemporary( const Image *image );
void * GetConfigureBlob( const char *filename, ExceptionInfo *exception );
void * ImageToBlob( const ImageInfo *image_info, Image *image, size_t *length, ExceptionInfo *exception );
unsigned int ImageToFile( Image *image, const char *filename, ExceptionInfo *exception );
Image * PingBlob( const ImageInfo *image_info, const void *blob, const size_t length, ExceptionInfo *exception );
BlobInfo ReferenceBlob( BlobInfo *blob_info );
void SetBlobClosable( Image *image, unsigned int closeable );
void SetBlobTemporary( Image *image, unsigned int isTemporary );
AttachBlob() attaches a blob to the BlobInfo structure.
The format of the AttachBlob method is:
void AttachBlob ( BlobInfo *blob_info, const void *blob, const size_t length );
A description of each parameter follows:
BlobIsSeekable() returns True if the blob supports seeks ( SeekBlob ( ) is functional ) .
The format of the BlobIsSeekable method is:
unsigned int BlobIsSeekable ( const Image *image );
A description of each parameter follows:
BlobToFile() writes a blob to a file. It returns False if an error occurs otherwise True.
The format of the BlobToFile method is:
unsigned int BlobToFile ( const char *filename, const void *blob, const size_t length, ExceptionInfo *exception );
A description of each parameter follows:
BlobToImage() implements direct to memory image formats. It returns the blob as an image.
The format of the BlobToImage method is:
Image *BlobToImage ( const ImageInfo *image_info, const void *blob, const size_t length, ExceptionInfo *exception );
A description of each parameter follows:
CloneBlobInfo() makes a duplicate of the given blob info structure, or if blob info is NULL, a new one.
The format of the CloneBlobInfo method is:
BlobInfo *CloneBlobInfo ( const BlobInfo *blob_info );
A description of each parameter follows:
DestroyBlob() deallocates memory associated with a blob.
The format of the DestroyBlob method is:
void DestroyBlob ( Image *image );
A description of each parameter follows:
DestroyBlobInfo() deallocates memory associated with an BlobInfo structure. Use of DestroyBlob is preferred over this function.
The format of the DestroyBlobInfo method is:
void DestroyBlobInfo ( BlobInfo *blob );
A description of each parameter follows:
DetachBlob() detaches a blob from the BlobInfo structure.
The format of the DetachBlob method is:
void DetachBlob ( BlobInfo *blob_info );
A description of each parameter follows:
FileToBlob() returns the contents of a file as a blob. It returns the file as a blob and its length. If an error occurs, NULL is returned.
The format of the FileToBlob method is:
void *FileToBlob ( const char *filename, size_t *length, ExceptionInfo *exception );
A description of each parameter follows:
FileToBlob()
returns the contents of a file as a blob. If an error occurs NULL is returned.
GetBlobClosable() returns True if the blob may be closed, or False if it is exempt from being closed.
The format of the GetBlobClosable method is:
unsigned int GetBlobClosable ( const Image *image );
A description of each parameter follows:
GetBlobFileHandle() returns the stdio file handle associated with the image blob. If there is no associated file handle, then a null pointer is returned.
The format of the GetBlobFileHandle method is:
FILE *GetBlobFileHandle ( const Image *image );
A description of each parameter follows:
GetBlobInfo() initializes the BlobInfo structure.
The format of the GetBlobInfo method is:
void GetBlobInfo ( BlobInfo *blob_info );
A description of each parameter follows:
GetBlobStatus() returns the blob error status.
The format of the GetBlobStatus method is:
int GetBlobStatus ( const Image *image );
A description of each parameter follows:
GetBlobStreamData() returns the stream data for the image. The data is only available if the data is stored on the heap, or is memory mapped. otherwise a NULL value is returned.
The format of the GetBlobStreamData method is:
unsigned char *GetBlobStreamData ( const Image *image );
A description of each parameter follows:
GetBlobStreamHandler() returns the stream handler associated with the image.
The format of the GetBlobStreamHandler method is:
const StreamHandler GetBlobStreamHandler ( const Image *image );
A description of each parameter follows:
GetBlobStreamType() returns the stream type for the image.
The format of the GetBlobStreamType method is:
StreamType GetBlobStreamType ( const Image *image );
A description of each parameter follows:
GetBlobTemporary() returns True if the file associated with the blob is a temporary file and should be removed when the associated image is destroyed.
The format of the GetBlobTemporary method is:
unsigned int GetBlobTemporary ( const Image *image );
A description of each parameter follows:
GetConfigureBlob() returns the specified configure file as a blob.
The format of the GetConfigureBlob method is:
void *GetConfigureBlob ( const char *filename, ExceptionInfo *exception );
A description of each parameter follows:
ImageToBlob() implements direct to memory image formats. It returns the image as a blob and its length. The magick member of the Image structure determines the format of the returned blob ( GIG, JPEG, PNG, etc. )
The format of the ImageToBlob method is:
void *ImageToBlob ( const ImageInfo *image_info, Image *image, size_t *length, ExceptionInfo *exception );
A description of each parameter follows:
ImageToFile() copies the input image from an open blob stream to a file. It returns False if an error occurs otherwise True. This function is used to handle coders which are unable to stream the data in using Blob I/O. Instead of streaming the data in, the data is streammed to a temporary file, and the coder accesses the temorary file directly.
The format of the ImageToFile method is:
unsigned int ImageToFile ( Image *image, const char *filename, ExceptionInfo *exception );
A description of each parameter follows:
PingBlob() returns all the attributes of an image or image sequence except for the pixels. It is much faster and consumes far less memory than BlobToImage ( ) . On failure, a NULL image is returned and exception describes the reason for the failure.
The format of the PingBlob method is:
Image *PingBlob ( const ImageInfo *image_info, const void *blob, const size_t length, ExceptionInfo *exception );
A description of each parameter follows:
ReferenceBlob() increments the reference count associated with the pixel blob returning a pointer to the blob.
The format of the ReferenceBlob method is:
BlobInfo ReferenceBlob ( BlobInfo *blob_info );
A description of each parameter follows:
SetBlobClosable() enables closing the blob if True is passed, and exempts the blob from being closed if False is passed. Blobs are closable by default ( default True ) .
The format of the SetBlobClosable method is:
void SetBlobClosable ( Image *image, unsigned int closeable );
A description of each parameter follows:
SetBlobTemporary() sets a boolean flag ( default False ) to specify if the file associated with the blob is a temporary file and should be removed when the associated image is destroyed.
The format of the SetBlobTemporary method is:
void SetBlobTemporary ( Image *image, unsigned int isTemporary );
A description of each parameter follows: