MagickCore  6.9.12-50
Convert, Edit, Or Compose Bitmap Images
cache.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2021 ImageMagick Studio LLC, a non-profit organization
3  dedicated to making software imaging solutions freely available.
4 
5  You may not use this file except in compliance with the License. You may
6  obtain a copy of the License at
7 
8  https://imagemagick.org/script/license.php
9 
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15 
16  MagickCore cache methods.
17 */
18 #ifndef MAGICKCORE_CACHE_H
19 #define MAGICKCORE_CACHE_H
20 
21 #include "magick/blob.h"
22 
23 #if defined(__cplusplus) || defined(c_plusplus)
24 extern "C" {
25 #endif
26 
27 typedef enum
28 {
35 } CacheType;
36 
39 
40 extern MagickExport const char
41  *GetPixelCacheFilename(const Image *);
42 
43 extern MagickExport const IndexPacket
44  *GetVirtualIndexQueue(const Image *);
45 
46 extern MagickExport const PixelPacket
47  *GetVirtualPixels(const Image *,const ssize_t,const ssize_t,const size_t,
48  const size_t,ExceptionInfo *),
49  *GetVirtualPixelQueue(const Image *);
50 
51 extern MagickExport const void
53 
55  *GetAuthenticIndexQueue(const Image *);
56 
59  GetOneVirtualMagickPixel(const Image *,const ssize_t,const ssize_t,
61  GetOneVirtualPixel(const Image *,const ssize_t,const ssize_t,PixelPacket *,
62  ExceptionInfo *),
63  GetOneVirtualMethodPixel(const Image *,const VirtualPixelMethod,const ssize_t,
64  const ssize_t,PixelPacket *,ExceptionInfo *),
65  GetOneAuthenticPixel(Image *,const ssize_t,const ssize_t,PixelPacket *,
66  ExceptionInfo *),
67  PersistPixelCache(Image *,const char *,const MagickBooleanType,
70 
72  GetImageExtent(const Image *);
73 
75  *GetAuthenticPixels(Image *,const ssize_t,const ssize_t,const size_t,
76  const size_t,ExceptionInfo *),
77  *GetAuthenticPixelQueue(const Image *),
78  *QueueAuthenticPixels(Image *,const ssize_t,const ssize_t,const size_t,
79  const size_t,ExceptionInfo *);
80 
84 
85 extern MagickExport void
88 
89 #if defined(__cplusplus) || defined(c_plusplus)
90 }
91 #endif
92 
93 #endif
Definition: cache.h:33
MagickExport MagickBooleanType CacheComponentGenesis(void)
Definition: cache.c:521
MagickExport const PixelPacket * GetVirtualPixels(const Image *image, const ssize_t x, const ssize_t y, const size_t columns, const size_t rows, ExceptionInfo *exception)
Definition: cache.c:3454
MagickExport MagickBooleanType GetOneVirtualPixel(const Image *image, const ssize_t x, const ssize_t y, PixelPacket *pixel, ExceptionInfo *exception)
Definition: cache.c:2265
MagickExport VirtualPixelMethod SetPixelCacheVirtualMethod(const Image *image, const VirtualPixelMethod virtual_pixel_method)
Definition: cache.c:5357
Definition: exception.h:102
MagickExport const PixelPacket * GetVirtualPixelQueue(const Image *image)
Definition: cache.c:3386
Definition: cache.h:30
VirtualPixelMethod
Definition: cache-view.h:27
Definition: cache.h:34
Definition: pixel.h:131
Definition: cache.h:29
ssize_t MagickOffsetType
Definition: magick-type.h:135
Definition: image.h:152
MagickBooleanType
Definition: magick-type.h:198
MagickExport void CacheComponentTerminus(void)
Definition: cache.c:546
Definition: cache.h:32
Definition: pixel.h:104
MagickExport MagickBooleanType GetOneVirtualMagickPixel(const Image *image, const ssize_t x, const ssize_t y, MagickPixelPacket *pixel, ExceptionInfo *exception)
Definition: cache.c:2135
size_t MagickSizeType
Definition: magick-type.h:136
MagickExport IndexPacket * GetAuthenticIndexQueue(const Image *image)
Definition: cache.c:1335
MagickExport VirtualPixelMethod GetPixelCacheVirtualMethod(const Image *image)
Definition: cache.c:2702
MagickExport MagickBooleanType GetOneVirtualMethodPixel(const Image *image, const VirtualPixelMethod virtual_pixel_method, const ssize_t x, const ssize_t y, PixelPacket *pixel, ExceptionInfo *exception)
Definition: cache.c:2202
MagickExport PixelPacket * GetAuthenticPixels(Image *image, const ssize_t x, const ssize_t y, const size_t columns, const size_t rows, ExceptionInfo *exception)
Definition: cache.c:1624
MagickExport const IndexPacket * GetVirtualIndexQueue(const Image *image)
Definition: cache.c:2820
MagickExport MagickBooleanType PersistPixelCache(Image *image, const char *filename, const MagickBooleanType attach, MagickOffsetType *offset, ExceptionInfo *exception)
Definition: cache.c:4247
MagickExport MagickSizeType GetImageExtent(const Image *image)
Definition: cache.c:1724
MagickExport PixelPacket * GetAuthenticPixelQueue(const Image *image)
Definition: cache.c:1558
MagickExport MagickBooleanType SyncAuthenticPixels(Image *image, ExceptionInfo *exception)
Definition: cache.c:5636
MagickExport const void * AcquirePixelCachePixels(const Image *image, MagickSizeType *length, ExceptionInfo *exception)
Definition: cache.c:482
MagickExport MagickBooleanType GetOneAuthenticPixel(Image *image, const ssize_t x, const ssize_t y, PixelPacket *pixel, ExceptionInfo *exception)
Definition: cache.c:2021
CacheType
Definition: cache.h:27
MagickExport CacheType GetImagePixelCacheType(const Image *image)
Definition: cache.c:1978
MagickExport PixelPacket * QueueAuthenticPixels(Image *image, const ssize_t x, const ssize_t y, const size_t columns, const size_t rows, ExceptionInfo *exception)
Definition: cache.c:4528
MagickExport const char * GetPixelCacheFilename(const Image *image)
Definition: cache.c:2456
Definition: cache.h:31
#define MagickExport
Definition: method-attribute.h:80
MagickExport void * GetPixelCachePixels(Image *image, MagickSizeType *length, ExceptionInfo *exception)
Definition: cache.c:2579
Quantum IndexPacket
Definition: pixel.h:129