Skip to page contents

[ AcquireCacheViewIndexes | AcquireCacheViewPixels | AcquireCacheViewPixels | CloneCacheView | CloseCacheView | GetCacheViewColorspace | GetCacheViewException | GetCacheViewIndexes | GetCacheViewPixels | GetCacheViewStorageClass | GetOneCacheViewPixel | OpenCacheView | SetCacheView | SetCacheViewStorageClass | SetCacheViewVirtualPixelMethod | SyncCacheView ]

AcquireCacheViewIndexes() returns the indexes associated with the specified view.

The format of the AcquireCacheViewIndexes method is:

  const IndexPacket *AcquireCacheViewIndexes(const ViewInfo *view_info)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

AcquireCacheViewPixels() 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 AcquireCacheViewPixels method is:

  const PixelPacket *AcquireCacheViewPixels(const ViewInfo *view_info,
    const long x,const long y,const unsigned long columns,
    const unsigned long rows,ExceptionInfo *exception)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

x,y,columns,rows

These values define the perimeter of a region of pixels.

exception

Return any errors or warnings in this structure.

AcquireCacheViewPixels() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneCacheViewPixel() instead.

The format of the AcquireOneCacheViewPixel method is:

  PixelPacket AcquireOneCacheViewPixel(const ViewInfo *view_info,
    const long x,const long y,ExceptionInfo *exception)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

x,y

These values define the offset of the pixel.

exception

Return any errors or warnings in this structure.

CloneCacheView() makes an exact copy of the specified cache view.

The format of the CloneCacheView method is:

  ViewInfo *CloneCacheView(const ViewInfo *view_info)

A description of each parameter follows:

view_info

The cache view.

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

The format of the CloseCacheView method is:

  ViewInfo *CloseCacheView(ViewInfo *view_info)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

GetCacheViewColorspace() returns the image colorspace associated with the specified view.

The format of the GetCacheViewColorspace method is:

  ColorspaceType GetCacheViewColorspace(const ViewInfo *view_info)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

GetCacheViewException() returns the image exception associated with the specified view.

The format of the GetCacheViewException method is:

  ExceptionInfo GetCacheViewException(const ViewInfo *view_info)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

GetCacheViewIndexes() returns the indexes associated with the specified view.

The format of the GetCacheViewIndexes method is:

  IndexPacket *GetCacheViewIndexes(const ViewInfo *view_info)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

GetCacheViewPixels() 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 GetCacheViewPixels method is:

  PixelPacket *GetCacheViewPixels(ViewInfo *view_info,const long x,
    const long y,const unsigned long columns,const unsigned long rows)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

x,y,columns,rows

These values define the perimeter of a region of pixels.

GetCacheViewStorageClass() returns the image storage class associated with the specified view.

The format of the GetCacheViewStorageClass method is:

  ClassType GetCacheViewStorageClass(const ViewInfo *view_info)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

GetOneCacheViewPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.

The format of the GetOneCacheViewPixel method is:

  PixelPacket GetOneCacheViewPixel(const ViewInfo *view_info,
    const long x,const long y)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

x,y

These values define the offset of the pixel.

OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.

The format of the OpenCacheView method is:

  ViewInfo *OpenCacheView(const Image *image)

A description of each parameter follows:

image

The image.

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_info,const long x,const long y,
    const unsigned long columns,const unsigned long rows)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

x,y,columns,rows

These values define the perimeter of a region of pixels.

SetCacheViewStorageClass() sets the image storage class associated with the specified view.

The format of the SetCacheViewStorageClass method is:

  MagickBooleanType SetCacheViewStorageClass(ViewInfo *view_info,
    const ClassType storage_class)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

storage_class

The image storage class: PseudoClass or DirectClass.

SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.

The format of the SetCacheViewVirtualPixelMethod method is:

  MagickBooleanType SetCacheViewVirtualPixelMethod(ViewInfo *view_info,
    const VirtualPixelMethod virtual_pixel_method)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.

virtual_pixel_method

The virtual pixel method.

SyncCacheView() saves the view_info pixels to the in-memory or disk cache. The method returns MagickTrue if the pixel region is synced, otherwise MagickFalse.

The format of the SyncCacheView method is:

  MagickBooleanType SyncCacheView(ViewInfo *view_info)

A description of each parameter follows:

view_info

The address of a structure of type ViewInfo.