MagickCore  6.9.12-67
Convert, Edit, Or Compose Bitmap Images
 All Data Structures
cache-view.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 view methods.
17 */
18 #ifndef MAGICKCORE_CACHE_VIEW_H
19 #define MAGICKCORE_CACHE_VIEW_H
20 
21 #include "magick/pixel.h"
22 
23 #if defined(__cplusplus) || defined(c_plusplus)
24 extern "C" {
25 #endif
26 
27 typedef enum
28 {
29  UndefinedVirtualPixelMethod,
30  BackgroundVirtualPixelMethod,
31  ConstantVirtualPixelMethod, /* deprecated */
32  DitherVirtualPixelMethod,
33  EdgeVirtualPixelMethod,
34  MirrorVirtualPixelMethod,
35  RandomVirtualPixelMethod,
36  TileVirtualPixelMethod,
37  TransparentVirtualPixelMethod,
38  MaskVirtualPixelMethod,
39  BlackVirtualPixelMethod,
40  GrayVirtualPixelMethod,
41  WhiteVirtualPixelMethod,
42  HorizontalTileVirtualPixelMethod,
43  VerticalTileVirtualPixelMethod,
44  HorizontalTileEdgeVirtualPixelMethod,
45  VerticalTileEdgeVirtualPixelMethod,
46  CheckerTileVirtualPixelMethod
47 } VirtualPixelMethod;
48 
49 typedef struct _CacheView
50  CacheView;
51 
52 extern MagickExport CacheView
53  *AcquireAuthenticCacheView(const Image *,ExceptionInfo *),
54  *AcquireCacheView(const Image *),
55  *AcquireVirtualCacheView(const Image *,ExceptionInfo *),
56  *CloneCacheView(const CacheView *),
57  *DestroyCacheView(CacheView *);
58 
59 extern MagickExport ClassType
60  GetCacheViewStorageClass(const CacheView *) magick_attribute((__pure__));
61 
62 extern MagickExport ColorspaceType
63  GetCacheViewColorspace(const CacheView *) magick_attribute((__pure__));
64 
65 extern MagickExport const IndexPacket
66  *GetCacheViewVirtualIndexQueue(const CacheView *)
67  magick_attribute((__pure__));
68 
69 extern MagickExport const PixelPacket
70  *GetCacheViewVirtualPixels(const CacheView *,const ssize_t,const ssize_t,
71  const size_t,const size_t,ExceptionInfo *) magick_hot_spot,
72  *GetCacheViewVirtualPixelQueue(const CacheView *) magick_hot_spot;
73 
74 extern MagickExport ExceptionInfo
75  *GetCacheViewException(const CacheView *) magick_attribute((__pure__));
76 
77 extern MagickExport IndexPacket
78  *GetCacheViewAuthenticIndexQueue(CacheView *) magick_attribute((__pure__));
79 
80 extern MagickExport MagickBooleanType
81  GetOneCacheViewAuthenticPixel(const CacheView *magick_restrict,const ssize_t,
82  const ssize_t,PixelPacket *magick_restrict,ExceptionInfo *),
83  GetOneCacheViewVirtualMethodPixel(const CacheView *,
84  const VirtualPixelMethod,const ssize_t,const ssize_t,PixelPacket *,
85  ExceptionInfo *),
86  GetOneCacheViewVirtualPixel(const CacheView *magick_restrict,const ssize_t,
87  const ssize_t,PixelPacket *magick_restrict,ExceptionInfo *),
88  SetCacheViewStorageClass(CacheView *,const ClassType),
89  SetCacheViewVirtualPixelMethod(CacheView *magick_restrict,
90  const VirtualPixelMethod),
91  SyncCacheViewAuthenticPixels(CacheView *magick_restrict,ExceptionInfo *)
92  magick_hot_spot;
93 
94 extern MagickExport MagickSizeType
95  GetCacheViewExtent(const CacheView *);
96 
97 extern MagickExport size_t
98  GetCacheViewChannels(const CacheView *);
99 
100 extern MagickExport PixelPacket
101  *GetCacheViewAuthenticPixelQueue(CacheView *) magick_hot_spot,
102  *GetCacheViewAuthenticPixels(CacheView *,const ssize_t,const ssize_t,
103  const size_t,const size_t,ExceptionInfo *) magick_hot_spot,
104  *QueueCacheViewAuthenticPixels(CacheView *,const ssize_t,const ssize_t,
105  const size_t,const size_t,ExceptionInfo *) magick_hot_spot;
106 
107 #if defined(__cplusplus) || defined(c_plusplus)
108 }
109 #endif
110 
111 #endif
Definition: image.h:152