MagickCore  6.9.12-67
Convert, Edit, Or Compose Bitmap Images
 All Data Structures
cache.h
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 {
29  UndefinedCache,
30  MemoryCache,
31  MapCache,
32  DiskCache,
33  PingCache,
34  DistributedCache
35 } CacheType;
36 
37 extern MagickExport CacheType
38  GetImagePixelCacheType(const Image *);
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
52  *AcquirePixelCachePixels(const Image *,MagickSizeType *,ExceptionInfo *);
53 
54 extern MagickExport IndexPacket
55  *GetAuthenticIndexQueue(const Image *);
56 
57 extern MagickExport MagickBooleanType
58  CacheComponentGenesis(void),
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,
68  MagickOffsetType *,ExceptionInfo *),
69  SyncAuthenticPixels(Image *,ExceptionInfo *);
70 
71 extern MagickExport MagickSizeType
72  GetImageExtent(const Image *);
73 
74 extern MagickExport PixelPacket
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 
81 extern MagickExport VirtualPixelMethod
82  GetPixelCacheVirtualMethod(const Image *),
83  SetPixelCacheVirtualMethod(const Image *,const VirtualPixelMethod);
84 
85 extern MagickExport void
86  CacheComponentTerminus(void),
87  *GetPixelCachePixels(Image *,MagickSizeType *,ExceptionInfo *);
88 
89 #if defined(__cplusplus) || defined(c_plusplus)
90 }
91 #endif
92 
93 #endif
Definition: image.h:152