MagickCore  6.9.11
Convert, Edit, Or Compose Bitmap Images
cache-view.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2020 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 
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,
73 
75  *GetCacheViewException(const CacheView *) magick_attribute((__pure__));
76 
79 
82  const ssize_t,PixelPacket *magick_restrict,ExceptionInfo *),
84  const VirtualPixelMethod,const ssize_t,const ssize_t,PixelPacket *,
85  ExceptionInfo *),
87  const ssize_t,PixelPacket *magick_restrict,ExceptionInfo *),
90  const VirtualPixelMethod),
93 
96 
97 extern MagickExport size_t
99 
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
QueueAuthenticPixelCacheNexus
MagickExport PixelPacket * QueueAuthenticPixelCacheNexus(Image *, const ssize_t, const ssize_t, const size_t, const size_t, const MagickBooleanType, NexusInfo *, ExceptionInfo *) magick_hot_spot
Definition: cache.c:4357
CloneCacheView
MagickExport CacheView * CloneCacheView(const CacheView *)
MagickExport
#define MagickExport
Definition: method-attribute.h:80
_Image::debug
MagickBooleanType debug
Definition: image.h:290
_Image::filename
char filename[MaxTextExtent]
Definition: image.h:278
_Image::background_color
PixelPacket background_color
Definition: image.h:181
GetVirtualPixelsNexus
MagickExport const PixelPacket * GetVirtualPixelsNexus(const Cache, NexusInfo *)
Definition: cache.c:3526
GetPixelCacheStorageClass
MagickExport ClassType GetPixelCacheStorageClass(const Cache)
Definition: cache.c:2607
RelinquishAlignedMemory
MagickExport void * RelinquishAlignedMemory(void *memory)
Definition: memory.c:1081
magick.h
GetOneCacheViewVirtualMethodPixel
MagickExport MagickBooleanType GetOneCacheViewVirtualMethodPixel(const CacheView *, const VirtualPixelMethod, const ssize_t, const ssize_t, PixelPacket *, ExceptionInfo *)
magick_unreferenced
#define magick_unreferenced(x)
Definition: method-attribute.h:106
GetMagickModule
#define GetMagickModule()
Definition: log.h:29
VirtualPixelMethod
VirtualPixelMethod
Definition: cache-view.h:28
DestroyCacheView
MagickExport CacheView * DestroyCacheView(CacheView *cache_view)
Definition: cache-view.c:256
HorizontalTileVirtualPixelMethod
@ HorizontalTileVirtualPixelMethod
Definition: cache-view.h:42
GetCacheViewVirtualIndexQueue
MagickExport const IndexPacket * GetCacheViewVirtualIndexQueue(const CacheView *) magick_attribute((__pure__))
Definition: cache-view.c:638
_NexusInfo::indexes
IndexPacket * indexes
Definition: cache-private.h:123
MagickCoreSignature
#define MagickCoreSignature
Definition: method-attribute.h:86
GetCacheViewVirtualIndexQueue
MagickExport const IndexPacket * GetCacheViewVirtualIndexQueue(const CacheView *cache_view)
Definition: cache-view.c:638
GetCacheViewStorageClass
MagickExport ClassType GetCacheViewStorageClass(const CacheView *cache_view)
Definition: cache-view.c:434
_NexusInfo
Definition: cache-private.h:105
WhiteVirtualPixelMethod
@ WhiteVirtualPixelMethod
Definition: cache-view.h:41
QueueCacheViewAuthenticPixels
MagickExport PixelPacket * QueueCacheViewAuthenticPixels(CacheView *, const ssize_t, const ssize_t, const size_t, const size_t, ExceptionInfo *) magick_hot_spot
Definition: cache-view.c:883
GetCacheViewAuthenticPixels
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
memory-private.h
magick_restrict
#define magick_restrict
Definition: MagickCore.h:41
GetCacheViewException
MagickExport ExceptionInfo * GetCacheViewException(const CacheView *cache_view)
Definition: cache-view.c:361
GetCacheViewChannels
MagickExport size_t GetCacheViewChannels(const CacheView *)
Definition: cache-view.c:295
SyncAuthenticPixelCacheNexus
MagickExport MagickBooleanType SyncAuthenticPixelCacheNexus(Image *, NexusInfo *magick_restrict, ExceptionInfo *) magick_hot_spot
ReferenceImage
MagickExport Image * ReferenceImage(Image *image)
Definition: image.c:2152
_CacheView::number_threads
size_t number_threads
Definition: cache-view.c:74
GetPixelCacheChannels
MagickExport size_t GetPixelCacheChannels(const Cache)
Definition: cache.c:2366
MagickSizeType
size_t MagickSizeType
Definition: magick-type.h:136
DestroyCacheView
MagickExport CacheView * DestroyCacheView(CacheView *)
Definition: cache-view.c:256
IndexPacket
Quantum IndexPacket
Definition: pixel.h:129
resource_.h
GetImageVirtualPixelMethod
MagickExport VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
Definition: image.c:1608
CheckerTileVirtualPixelMethod
@ CheckerTileVirtualPixelMethod
Definition: cache-view.h:46
pixel.h
SetCacheViewStorageClass
MagickExport MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view, const ClassType storage_class)
Definition: cache-view.c:923
_CacheView
Definition: cache-view.c:66
GetOneCacheViewAuthenticPixel
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
GetCacheViewVirtualPixels
MagickExport const PixelPacket * GetCacheViewVirtualPixels(const CacheView *, const ssize_t, const ssize_t, const size_t, const size_t, ExceptionInfo *) magick_hot_spot
AcquirePixelCacheNexus
MagickExport NexusInfo ** AcquirePixelCacheNexus(const size_t)
DestroyPixelCacheNexus
MagickExport NexusInfo ** DestroyPixelCacheNexus(NexusInfo **, const size_t)
Definition: cache.c:1235
string_.h
_CacheView::nexus_info
NexusInfo ** nexus_info
Definition: cache-view.c:77
EdgeVirtualPixelMethod
@ EdgeVirtualPixelMethod
Definition: cache-view.h:33
GetCacheViewExtent
MagickExport MagickSizeType GetCacheViewExtent(const CacheView *)
Definition: cache-view.c:395
MagickTrue
@ MagickTrue
Definition: magick-type.h:201
QueueCacheViewAuthenticPixels
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
VerticalTileVirtualPixelMethod
@ VerticalTileVirtualPixelMethod
Definition: cache-view.h:43
SyncCacheViewAuthenticPixels
MagickExport MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *magick_restrict cache_view, ExceptionInfo *exception)
Definition: cache-view.c:1000
GetCacheViewExtent
MagickExport MagickSizeType GetCacheViewExtent(const CacheView *cache_view)
Definition: cache-view.c:395
thread-private.h
HorizontalTileEdgeVirtualPixelMethod
@ HorizontalTileEdgeVirtualPixelMethod
Definition: cache-view.h:44
TraceEvent
@ TraceEvent
Definition: log.h:38
SetCacheViewVirtualPixelMethod
MagickExport MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *magick_restrict cache_view, const VirtualPixelMethod virtual_pixel_method)
Definition: cache-view.c:960
cache-private.h
GetPixelCacheColorspace
MagickExport ColorspaceType GetPixelCacheColorspace(const Cache)
Definition: cache.c:2402
GrayVirtualPixelMethod
@ GrayVirtualPixelMethod
Definition: cache-view.h:40
_Image
Definition: image.h:153
AcquireCacheView
MagickExport CacheView * AcquireCacheView(const Image *image)
Definition: cache-view.c:148
GetAuthenticPixelCacheNexus
MagickExport PixelPacket * GetAuthenticPixelCacheNexus(Image *, const ssize_t, const ssize_t, const size_t, const size_t, NexusInfo *, ExceptionInfo *) magick_hot_spot
CacheFatalError
@ CacheFatalError
Definition: exception.h:87
GetCacheViewAuthenticIndexQueue
MagickExport IndexPacket * GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
Definition: cache-view.c:564
AcquireAuthenticCacheView
MagickExport CacheView * AcquireAuthenticCacheView(const Image *image, ExceptionInfo *exception)
Definition: cache-view.c:111
GetOneCacheViewVirtualPixel
MagickExport MagickBooleanType GetOneCacheViewVirtualPixel(const CacheView *magick_restrict, const ssize_t, const ssize_t, PixelPacket *magick_restrict, ExceptionInfo *)
_CacheView::signature
size_t signature
Definition: cache-view.c:83
MirrorVirtualPixelMethod
@ MirrorVirtualPixelMethod
Definition: cache-view.h:34
ColorspaceType
ColorspaceType
Definition: colorspace.h:26
_CacheView::debug
MagickBooleanType debug
Definition: cache-view.c:80
MagickAssumeAligned
#define MagickAssumeAligned(address)
Definition: memory-private.h:43
GetCacheViewAuthenticIndexQueue
MagickExport IndexPacket * GetCacheViewAuthenticIndexQueue(CacheView *) magick_attribute((__pure__))
Definition: cache-view.c:564
GetCacheViewAuthenticPixels
MagickExport PixelPacket * GetCacheViewAuthenticPixels(CacheView *, const ssize_t, const ssize_t, const size_t, const size_t, ExceptionInfo *) magick_hot_spot
_Image::exception
ExceptionInfo exception
Definition: image.h:287
SyncCacheViewAuthenticPixels
MagickExport MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *magick_restrict, ExceptionInfo *) magick_hot_spot
GetOpenMPMaximumThreads
static size_t GetOpenMPMaximumThreads(void)
Definition: thread-private.h:111
_CacheView::virtual_pixel_method
VirtualPixelMethod virtual_pixel_method
Definition: cache-view.c:71
_Image::cache
void * cache
Definition: image.h:268
MagickFalse
@ MagickFalse
Definition: magick-type.h:200
IsEventLogging
MagickExport MagickBooleanType IsEventLogging(void)
Definition: log.c:725
GetVirtualPixelCacheNexus
MagickExport const PixelPacket * GetVirtualPixelCacheNexus(const Image *, const VirtualPixelMethod, const ssize_t, const ssize_t, const size_t, const size_t, NexusInfo *, ExceptionInfo *) magick_hot_spot
GetCacheViewStorageClass
MagickExport ClassType GetCacheViewStorageClass(const CacheView *) magick_attribute((__pure__))
Definition: cache-view.c:434
GetCacheViewChannels
MagickExport size_t GetCacheViewChannels(const CacheView *cache_view)
Definition: cache-view.c:295
AcquireAlignedMemory
MagickExport void * AcquireAlignedMemory(const size_t count, const size_t quantum)
Definition: memory.c:337
GetOneCacheViewAuthenticPixel
MagickExport MagickBooleanType GetOneCacheViewAuthenticPixel(const CacheView *magick_restrict, const ssize_t, const ssize_t, PixelPacket *magick_restrict, ExceptionInfo *)
DitherVirtualPixelMethod
@ DitherVirtualPixelMethod
Definition: cache-view.h:32
GetCacheViewAuthenticPixelQueue
MagickExport PixelPacket * GetCacheViewAuthenticPixelQueue(CacheView *) magick_hot_spot
SetCacheViewStorageClass
MagickExport MagickBooleanType SetCacheViewStorageClass(CacheView *, const ClassType)
cache-view.h
cache.h
GetCacheViewException
MagickExport ExceptionInfo * GetCacheViewException(const CacheView *) magick_attribute((__pure__))
Definition: cache-view.c:361
magick_attribute
MagickExport MagickBooleanType magick_attribute((deprecated))
_CacheView::image
Image * image
Definition: cache-view.c:68
_Image::signature
size_t signature
Definition: image.h:307
UndefinedVirtualPixelMethod
@ UndefinedVirtualPixelMethod
Definition: cache-view.h:29
MagickBooleanType
MagickBooleanType
Definition: magick-type.h:199
GetCacheViewColorspace
MagickExport ColorspaceType GetCacheViewColorspace(const CacheView *) magick_attribute((__pure__))
Definition: cache-view.c:328
_ExceptionInfo
Definition: exception.h:103
Cache
void * Cache
Definition: cache-private.h:34
BlackVirtualPixelMethod
@ BlackVirtualPixelMethod
Definition: cache-view.h:39
studio.h
CloneCacheView
MagickExport CacheView * CloneCacheView(const CacheView *cache_view)
Definition: cache-view.c:209
AcquireAuthenticCacheView
MagickExport CacheView * AcquireAuthenticCacheView(const Image *, ExceptionInfo *)
SetCacheViewVirtualPixelMethod
MagickExport MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *magick_restrict, const VirtualPixelMethod)
AcquireVirtualCacheView
MagickExport CacheView * AcquireVirtualCacheView(const Image *image, ExceptionInfo *exception)
Definition: cache-view.c:153
GetCacheViewColorspace
MagickExport ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
Definition: cache-view.c:328
DestroyImage
MagickExport Image * DestroyImage(Image *image)
Definition: image.c:1166
TransparentVirtualPixelMethod
@ TransparentVirtualPixelMethod
Definition: cache-view.h:37
_NexusInfo::pixels
PixelPacket * pixels
Definition: cache-private.h:117
TileVirtualPixelMethod
@ TileVirtualPixelMethod
Definition: cache-view.h:36
ThreadResource
@ ThreadResource
Definition: resource_.h:33
AcquireVirtualCacheView
MagickExport CacheView * AcquireVirtualCacheView(const Image *, ExceptionInfo *)
memory_.h
GetPixelCacheNexusExtent
MagickExport MagickSizeType GetPixelCacheNexusExtent(const Cache, NexusInfo *)
Definition: cache.c:2517
GetOneCacheViewVirtualPixel
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
GetVirtualIndexesFromNexus
MagickExport const IndexPacket * GetVirtualIndexesFromNexus(const Cache, NexusInfo *)
Definition: cache.c:2764
exception-private.h
ConstantVirtualPixelMethod
@ ConstantVirtualPixelMethod
Definition: cache-view.h:31
ThrowFatalException
#define ThrowFatalException(severity, tag)
Definition: exception-private.h:42
exception.h
GetCacheViewVirtualPixelQueue
MagickExport const PixelPacket * GetCacheViewVirtualPixelQueue(const CacheView *cache_view)
Definition: cache-view.c:677
SetImageStorageClass
MagickExport MagickBooleanType SetImageStorageClass(Image *image, const ClassType storage_class)
Definition: image.c:2587
LogMagickEvent
MagickExport MagickBooleanType LogMagickEvent(const LogEventType type, const char *module, const char *function, const size_t line, const char *format,...)
Definition: log.c:1420
magick_hot_spot
#define magick_hot_spot
Definition: method-attribute.h:122
GetOneCacheViewVirtualMethodPixel
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
RandomVirtualPixelMethod
@ RandomVirtualPixelMethod
Definition: cache-view.h:35
GetCacheViewVirtualPixels
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
MaskVirtualPixelMethod
@ MaskVirtualPixelMethod
Definition: cache-view.h:38
BackgroundVirtualPixelMethod
@ BackgroundVirtualPixelMethod
Definition: cache-view.h:30
ResourceLimitFatalError
@ ResourceLimitFatalError
Definition: exception.h:78
ClassType
ClassType
Definition: magick-type.h:192
GetCacheViewAuthenticPixelQueue
MagickExport PixelPacket * GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
Definition: cache-view.c:601
AcquireCacheView
MagickExport CacheView * AcquireCacheView(const Image *)
GetMagickResourceLimit
MagickExport MagickSizeType GetMagickResourceLimit(const ResourceType type)
Definition: resource.c:842
_PixelPacket
Definition: pixel.h:132
VerticalTileEdgeVirtualPixelMethod
@ VerticalTileEdgeVirtualPixelMethod
Definition: cache-view.h:45
GetCacheViewVirtualPixelQueue
MagickExport const PixelPacket * GetCacheViewVirtualPixelQueue(const CacheView *) magick_hot_spot
Definition: cache-view.c:677
GetOpenMPThreadId
static int GetOpenMPThreadId(void)
Definition: thread-private.h:120