;cache_view - ImageMagick Cache Views Methods9W




"NAME

3

cache_view - ImageMagick Cache Views Methods



2page index




&SYNOPSIS

?

void CloseCacheView( ViewInfo *view );

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

R

IndexPacket * GetCacheViewIndexes( const ViewInfo *view );

Q

PixelPacket * GetCacheViewPixels( const ViewInfo *view );

A

ViewInfo * OpenCacheView( Image *image );

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

F

unsigned int SyncCacheView( ViewInfo *view );



2page index


$

FUNCTION *DESCRIPTIONS



4

CloseCacheView

p

Method CloseCacheView closes the specified view returned by a previous call to OpenCacheView

2

The format of the CloseCacheView method is:

f
void CloseCacheView ( ViewInfo *view );

AA description of each parameter follows:


>

view:

,The address of a structure of type ViewInfo.



0

GetCacheView

r

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

0

The format of the GetCacheView method is:

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

AA description of each parameter follows:


B

pixels:

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

!

view:

,The address of a structure of type ViewInfo.

\

x,y,columns,rows:

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



>

GetCacheViewIndexes

b

Method GetCacheViewIndexes returns the colormap indexes associated with the specified view.

7

The format of the GetCacheViewIndexes method is:

y
IndexPacket *GetCacheViewIndexes ( const ViewInfo *view );

AA description of each parameter follows:


D

indexes:

[Method GetCacheViewIndexes returns the colormap indexes associated with the specified view.

!

view:

,The address of a structure of type ViewInfo.



<

GetCacheViewPixels

a

Method GetCacheViewPixels returns the pixels associated with the specified specified view.

6

The format of the GetCacheViewPixels method is:

PixelPacket *GetCacheViewPixels ( const ViewInfo *view );

AA description of each parameter follows:


#

pixels:

PMethod GetCacheViewPixels returns the pixels associated with the specified view.

!

view:

,The address of a structure of type ViewInfo.



2

OpenCacheView

>

Method OpenCacheView opens a view into the pixel cache.

1

The format of the OpenCacheView method is:

ViewInfo *OpenCacheView ( Image *image );

AA description of each parameter follows:


@

image:

)The address of a structure of type Image.



0

SetCacheView

r

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

0

The format of the SetCacheView method is:

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

AA description of each parameter follows:


#

pixels:

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

!

view:

,The address of a structure of type ViewInfo.

-

x,y,columns,rows:

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



2

SyncCacheView

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

1

The format of the SyncCacheView method is:

m
unsigned int SyncCacheView ( ViewInfo *view );

AA description of each parameter follows:


B

status:

tMethod SyncCacheView returns True if the view pixels are transferred to the in-memory or disk cache otherwise False.

!

view:

,The address of a structure of type ViewInfo.
9

page index