ImageMagick-7/MagickCore/cache-view.h

0001 /*
0002   Copyright @ 2000 ImageMagick Studio LLC, a non-profit organization
0003   dedicated to making software imaging solutions freely available.
0004
0005   You may not use this file except in compliance with the License.  You may
0006   obtain a copy of the License at
0007
0008     https://imagemagick.org/script/license.php
0009
0010   Unless required by applicable law or agreed to in writing, software
0011   distributed under the License is distributed on an "AS IS" BASIS,
0012   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0013   See the License for the specific language governing permissions and
0014   limitations under the License.
0015
0016   MagickCore cache view methods.
0017 */
0018 #ifndef MAGICKCORE_CACHE_VIEW_H
0019 #define MAGICKCORE_CACHE_VIEW_H
0020
0021 #include "MagickCore/pixel.h"
0022
0023 #if defined(__cplusplus) || defined(c_plusplus)
0024 extern "C" {
0025 #endif
0026
0027 typedef enum
0028 {
0029   UndefinedVirtualPixelMethod,
0030   BackgroundVirtualPixelMethod,
0031   DitherVirtualPixelMethod,
0032   EdgeVirtualPixelMethod,
0033   MirrorVirtualPixelMethod,
0034   RandomVirtualPixelMethod,
0035   TileVirtualPixelMethod,
0036   TransparentVirtualPixelMethod,
0037   MaskVirtualPixelMethod,
0038   BlackVirtualPixelMethod,
0039   GrayVirtualPixelMethod,
0040   WhiteVirtualPixelMethod,
0041   HorizontalTileVirtualPixelMethod,
0042   VerticalTileVirtualPixelMethod,
0043   HorizontalTileEdgeVirtualPixelMethod,
0044   VerticalTileEdgeVirtualPixelMethod,
0045   CheckerTileVirtualPixelMethod
0046 } VirtualPixelMethod;
0047
0048 typedef struct _CacheView
0049   CacheView;
0050
0051 extern MagickExport CacheView
0052   *AcquireAuthenticCacheView(const Image *,ExceptionInfo *),
0053   *AcquireVirtualCacheView(const Image *,ExceptionInfo *),
0054   *CloneCacheView(const CacheView *),
0055   *DestroyCacheView(CacheView *);
0056
0057 extern MagickExport ClassType
0058   GetCacheViewStorageClass(const CacheView *) magick_attribute((__pure__));
0059
0060 extern MagickExport ColorspaceType
0061   GetCacheViewColorspace(const CacheView *) magick_attribute((__pure__));
0062
0063 extern MagickExport const Image
0064   *GetCacheViewImage(const CacheView *) magick_attribute((__pure__));
0065
0066 extern MagickExport const Quantum
0067   *GetCacheViewVirtualPixels(const CacheView *,const ssize_t,const ssize_t,
0068     const size_t,const size_t,ExceptionInfo *) magick_hot_spot,
0069   *GetCacheViewVirtualPixelQueue(const CacheView *) magick_hot_spot;
0070
0071 extern MagickExport const void
0072   *GetCacheViewVirtualMetacontent(const CacheView *)
0073     magick_attribute((__pure__));
0074
0075 extern MagickExport MagickBooleanType
0076   GetOneCacheViewAuthenticPixel(const CacheView *,const ssize_t,const ssize_t,
0077     Quantum *,ExceptionInfo *),
0078   GetOneCacheViewVirtualMethodPixel(const CacheView *,const VirtualPixelMethod,
0079     const ssize_t,const ssize_t,Quantum *,ExceptionInfo *),
0080   GetOneCacheViewVirtualPixel(const CacheView *,const ssize_t,const ssize_t,
0081     Quantum *,ExceptionInfo *),
0082   GetOneCacheViewVirtualPixelInfo(const CacheView *,const ssize_t,const ssize_t,
0083     PixelInfo *,ExceptionInfo *),
0084   SetCacheViewStorageClass(CacheView *,const ClassType,ExceptionInfo *),
0085   SetCacheViewVirtualPixelMethod(CacheView *magick_restrict,
0086     const VirtualPixelMethod),
0087   SyncCacheViewAuthenticPixels(CacheView *magick_restrict,ExceptionInfo *)
0088     magick_hot_spot;
0089
0090 extern MagickExport MagickSizeType
0091   GetCacheViewExtent(const CacheView *) magick_attribute((__pure__));
0092
0093 extern MagickExport Quantum
0094   *GetCacheViewAuthenticPixelQueue(CacheView *) magick_hot_spot,
0095   *GetCacheViewAuthenticPixels(CacheView *,const ssize_t,const ssize_t,
0096     const size_t,const size_t,ExceptionInfo *) magick_hot_spot,
0097   *QueueCacheViewAuthenticPixels(CacheView *,const ssize_t,const ssize_t,
0098     const size_t,const size_t,ExceptionInfo *) magick_hot_spot;
0099
0100 extern MagickExport void
0101   *GetCacheViewAuthenticMetacontent(CacheView *);
0102
0103 #if defined(__cplusplus) || defined(c_plusplus)
0104 }
0105 #endif
0106
0107 #endif