Skip to page contents

[ About ImageMagick ]
[ Command-line Tools Processing Options Usage Program Interfaces MagickWand MagickCore PerlMagick Magick++ Architecture ]
[ Install from Source Unix Windows Binary Releases Unix Mac OS X Windows Resources ]
[ Download ]
[ Site Map Links ]
[ Sponsors:

Wischmop
Software Download
Posters

]

[ AcquireCacheView | AcquireCacheViewIndexes | AcquireCacheViewPixels | AcquireCacheViewThreadSet | AcquireCacheViewPixels | AcquireCacheViewPixels | CloneCacheView | DestroyCacheView | DestroyCacheViewThreadSet | GetCacheViewColorspace | GetCacheViewException | GetCacheViewIndexes | GetCacheViewPixels | GetCacheViewStorageClass | GetOneCacheViewPixel | SetCacheViewPixels | SetCacheViewStorageClass | SetCacheViewVirtualPixelMethod | SyncCacheView ]

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

The format of the AcquireCacheView method is:

  ViewInfo *AcquireCacheView(const Image *image)

A description of each parameter follows:

image

the image.

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

The format of the AcquireCacheViewIndexes method is:

  const IndexPacket *AcquireCacheViewIndexes(const ViewInfo *cache_view)

A description of each parameter follows:

cache_view

the cache view.

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 *cache_view,
    const long x,const long y,const unsigned long columns,
    const unsigned long rows,ExceptionInfo *exception)

A description of each parameter follows:

cache_view

the cache view.

x,y,columns,rows

These values define the perimeter of a region of pixels.

exception

Return any errors or warnings in this structure.

AcquireCacheViewThreadSet() acquires a set of views, one for each possible thread.

The format of the AcquireCacheViewThreadSet method is:

  ViewInfo **AcquireCacheViewThreadSet(const Image *image)

A description of each parameter follows:

image

the image.

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 *cache_view,
    const long x,const long y,ExceptionInfo *exception)

A description of each parameter follows:

cache_view

the cache view.

x,y

These values define the offset of the pixel.

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 AcquireOneCacheViewVirtualPixel(const ViewInfo *cache_view,
    const VirtualPixelMethod virtual_pixel_method,const long x,
    const long y,ExceptionInfo *exception)

A description of each parameter follows:

cache_view

the cache view.

virtual_pixel_method

the virtual pixel method.

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 *cache_view)

A description of each parameter follows:

cache_view

the cache view.

DestroyCacheView() destroy the specified view returned by a previous call to AcquireCacheView().

The format of the DestroyCacheView method is:

  ViewInfo *DestroyCacheView(ViewInfo *cache_view)

A description of each parameter follows:

cache_view

the cache view.

DestroyCacheViewThreadSet() destroys a set of cache views previously acquired from the AcquireCacheViewThreadSet() method.

The format of the DestoryCacheViewSet method is:

  ViewInfo **DestroyCacheViewThreadSet(ViewInfo **cache_view)

A description of each parameter follows:

cache_view

the cache views.

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

The format of the GetCacheViewColorspace method is:

  ColorspaceType GetCacheViewColorspace(const ViewInfo *cache_view)

A description of each parameter follows:

cache_view

the cache view.

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

The format of the GetCacheViewException method is:

  ExceptionInfo GetCacheViewException(const ViewInfo *cache_view)

A description of each parameter follows:

cache_view

the cache view.

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

The format of the GetCacheViewIndexes method is:

  IndexPacket *GetCacheViewIndexes(const ViewInfo *cache_view)

A description of each parameter follows:

cache_view

the cache view.

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

A description of each parameter follows:

cache_view

the cache view.

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 *cache_view)

A description of each parameter follows:

cache_view

the cache view.

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 *cache_view,
    const long x,const long y)

A description of each parameter follows:

cache_view

the cache view.

x,y

These values define the offset of the pixel.

SetCacheViewPixels() 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 *SetCacheViewPixels(ViewInfo *cache_view,const long x,
    const long y,const unsigned long columns,const unsigned long rows)

A description of each parameter follows:

cache_view

the cache view.

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 *cache_view,
    const ClassType storage_class)

A description of each parameter follows:

cache_view

the cache view.

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 *cache_view,
    const VirtualPixelMethod virtual_pixel_method)

A description of each parameter follows:

cache_view

the cache view.

virtual_pixel_method

the virtual pixel method.

SyncCacheView() saves the cache_view 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 *cache_view)

A description of each parameter follows:

cache_view

the cache view.