m+I;cache_view - ImageMagick Cache Views Methods>j Pair








NAME

3

cache_view - ImageMagick Cache Views Methods






(

SYNOPSIS

Â

const PixelPacket * AcquireCacheView( const ViewInfo *view, const long x, const long y, const unsigned long columns, const unsigned long rows, ExceptionInfo *exception );

?

void CloseCacheView( ViewInfo *view );

˜

PixelPacket * GetCacheView( ViewInfo *view, const long x, const long y, const unsigned long columns, const unsigned long rows );

R

IndexPacket * GetCacheViewIndexes( const ViewInfo *view );

Q

PixelPacket * GetCacheViewPixels( const ViewInfo *view );

A

ViewInfo * OpenCacheView( Image *image );

˜

PixelPacket * SetCacheView( ViewInfo *view, const long x, const long y, const unsigned long columns, const unsigned long rows );

F

unsigned int SyncCacheView( ViewInfo *view );






B

FUNCTION DESCRIPTIONS





8

AcquireCacheView

Ú

Method AcquireCacheView gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.

4

The format of the AcquireCacheView method is:

a
const PixelPacket *AcquireCacheView ( const ViewInfo *view, const long x, const long y, const unsigned long columns, const unsigned long rows, ExceptionInfo *exception );

A description of each parameter follows:


C
o pixels:


fMethod GetCacheView returns a null pointer if an error occurs, otherwise a pointer to the view pixels.


?
o view:


,The address of a structure of type ViewInfo.


]
o x,y,columns,rows:


8These values define the perimeter of a region of pixels.


I
o exception:


0Return any errors or warnings in this structure.





4

CloseCacheView

©
CloseCacheView() closes the specified view returned by a previous call to OpenCacheView ( ) .

The format of the CloseCacheView method is:

void CloseCacheView ( ViewInfo *view );

A description of each parameter follows:


"
o view:


,The address of a structure of type ViewInfo.





0

GetCacheView


GetCacheView() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.

The format of the GetCacheView method is:


PixelPacket *GetCacheView ( ViewInfo *view, const long x, const long y, const unsigned long columns, const unsigned long rows );

A description of each parameter follows:


$
o pixels:


fMethod GetCacheView returns a null pointer if an error occurs, otherwise a pointer to the view pixels.


"
o view:


,The address of a structure of type ViewInfo.


.
o x,y,columns,rows:


8These values define the perimeter of a region of pixels.





>

GetCacheViewIndexes

Y

Method GetCacheViewIndexes returns the indexes associated with the specified view.

7

The format of the GetCacheViewIndexes method is:

¥
IndexPacket *GetCacheViewIndexes ( const ViewInfo *view );

A description of each parameter follows:


E
o indexes:


RMethod GetCacheViewIndexes returns the indexes associated with the specified view.


"
o view:


,The address of a structure of type ViewInfo.





<

GetCacheViewPixels

¥
GetCacheViewPixels() returns the pixels associated with the specified specified view.

The format of the GetCacheViewPixels method is:

É
PixelPacket *GetCacheViewPixels ( const ViewInfo *view );

A description of each parameter follows:


"
o view:


,The address of a structure of type ViewInfo.





2

OpenCacheView

}
OpenCacheView() opens a view into the pixel cache.

The format of the OpenCacheView method is:

³
ViewInfo *OpenCacheView ( Image *image );

A description of each parameter follows:


A
o image:


The image.





0

SetCacheView


SetCacheView() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.

The format of the SetCacheView method is:


PixelPacket *SetCacheView ( ViewInfo *view, const long x, const long y, const unsigned long columns, const unsigned long rows );

A description of each parameter follows:


"
o view:


,The address of a structure of type ViewInfo.


.
o x,y,columns,rows:


8These values define the perimeter of a region of pixels.





2

SyncCacheView

Ø
SyncCacheView() saves the view pixels to the in-memory or disk cache. The method returns True if the pixel region is synced, otherwise False.

The format of the SyncCacheView method is:

unsigned int SyncCacheView ( ViewInfo *view );

A description of each parameter follows:


"
o view:


,The address of a structure of type ViewInfo.