MagickCore  6.9.12-43
Convert, Edit, Or Compose Bitmap Images
cache-view.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 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 {
31  ConstantVirtualPixelMethod, /* deprecated */
48 
49 typedef struct _CacheView
50  CacheView;
51 
54  *AcquireCacheView(const Image *),
56  *CloneCacheView(const CacheView *),
58 
61 
64 
65 extern MagickExport const IndexPacket
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 
75  *GetCacheViewException(const CacheView *) magick_attribute((__pure__));
76 
78  *GetCacheViewAuthenticIndexQueue(CacheView *) magick_attribute((__pure__));
79 
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 
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
#define magick_restrict
Definition: MagickCore.h:41
MagickExport CacheView * DestroyCacheView(CacheView *cache_view)
Definition: cache-view.c:256
Definition: cache-view.h:44
MagickExport MagickSizeType GetCacheViewExtent(const CacheView *cache_view)
Definition: cache-view.c:395
Definition: cache-view.h:41
Definition: exception.h:102
Definition: cache-view.h:33
VirtualPixelMethod
Definition: cache-view.h:27
Definition: cache-view.h:31
Definition: cache-view.h:46
Definition: cache-view.c:65
MagickExport ClassType GetCacheViewStorageClass(const CacheView *cache_view)
Definition: cache-view.c:434
Definition: pixel.h:131
MagickExport MagickBooleanType GetOneCacheViewVirtualMethodPixel(const CacheView *cache_view, const VirtualPixelMethod virtual_pixel_method, const ssize_t x, const ssize_t y, PixelPacket *pixel, ExceptionInfo *exception)
Definition: cache-view.c:829
MagickExport MagickBooleanType GetOneCacheViewVirtualPixel(const CacheView *magick_restrict cache_view, const ssize_t x, const ssize_t y, PixelPacket *magick_restrict pixel, ExceptionInfo *exception)
Definition: cache-view.c:770
Definition: image.h:152
Definition: cache-view.h:34
MagickExport const IndexPacket * GetCacheViewVirtualIndexQueue(const CacheView *cache_view)
Definition: cache-view.c:638
MagickBooleanType
Definition: magick-type.h:198
ClassType
Definition: magick-type.h:191
Definition: cache-view.h:29
#define magick_hot_spot
Definition: method-attribute.h:122
MagickExport CacheView * AcquireCacheView(const Image *image)
Definition: cache-view.c:148
size_t MagickSizeType
Definition: magick-type.h:136
MagickExport ExceptionInfo * GetCacheViewException(const CacheView *cache_view)
Definition: cache-view.c:361
MagickExport const PixelPacket * GetCacheViewVirtualPixels(const CacheView *cache_view, const ssize_t x, const ssize_t y, const size_t columns, const size_t rows, ExceptionInfo *exception)
Definition: cache-view.c:723
MagickExport const PixelPacket * GetCacheViewVirtualPixelQueue(const CacheView *cache_view)
Definition: cache-view.c:677
Definition: cache-view.h:43
MagickExport MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view, const ClassType storage_class)
Definition: cache-view.c:923
MagickExport CacheView * CloneCacheView(const CacheView *cache_view)
Definition: cache-view.c:209
Definition: cache-view.h:36
Definition: cache-view.h:40
MagickExport CacheView * AcquireVirtualCacheView(const Image *image, ExceptionInfo *exception)
Definition: cache-view.c:153
MagickExport MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *magick_restrict cache_view, const VirtualPixelMethod virtual_pixel_method)
Definition: cache-view.c:960
MagickExport PixelPacket * GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
Definition: cache-view.c:601
Definition: cache-view.h:45
MagickExport IndexPacket * GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
Definition: cache-view.c:564
MagickExport PixelPacket * GetCacheViewAuthenticPixels(CacheView *cache_view, const ssize_t x, const ssize_t y, const size_t columns, const size_t rows, ExceptionInfo *exception)
Definition: cache-view.c:473
Definition: cache-view.h:32
ColorspaceType
Definition: colorspace.h:25
MagickExport MagickBooleanType GetOneCacheViewAuthenticPixel(const CacheView *magick_restrict cache_view, const ssize_t x, const ssize_t y, PixelPacket *magick_restrict pixel, ExceptionInfo *exception)
Definition: cache-view.c:518
Definition: cache-view.h:37
MagickExport PixelPacket * QueueCacheViewAuthenticPixels(CacheView *cache_view, const ssize_t x, const ssize_t y, const size_t columns, const size_t rows, ExceptionInfo *exception)
Definition: cache-view.c:883
#define magick_attribute(x)
Definition: deprecate.h:41
Definition: cache-view.h:38
#define MagickExport
Definition: method-attribute.h:80
MagickExport MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *magick_restrict cache_view, ExceptionInfo *exception)
Definition: cache-view.c:1000
MagickExport CacheView * AcquireAuthenticCacheView(const Image *image, ExceptionInfo *exception)
Definition: cache-view.c:111
Quantum IndexPacket
Definition: pixel.h:129
MagickExport size_t GetCacheViewChannels(const CacheView *cache_view)
Definition: cache-view.c:295
Definition: cache-view.h:42
MagickExport ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
Definition: cache-view.c:328
Definition: cache-view.h:35
Definition: cache-view.h:30
Definition: cache-view.h:39