MagickCore  6.9.12-67
Convert, Edit, Or Compose Bitmap Images
 All Data Structures
opencl.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 OpenCL public methods.
17 */
18 #ifndef MAGICKCORE_OPENCL_H
19 #define MAGICKCORE_OPENCL_H
20 
21 
22 #if defined(__cplusplus) || defined(c_plusplus)
23 extern "C" {
24 #endif
25 
26 /* OpenCL program modules */
27 typedef enum {
28  MAGICK_OPENCL_ACCELERATE = 0,
29  MAGICK_OPENCL_NUM_PROGRAMS /* !!! This has to be the last entry !!! */
30 } MagickOpenCLProgram;
31 
32 typedef enum {
33  MAGICK_OPENCL_OFF = 0
34  , MAGICK_OPENCL_DEVICE_SELECT_AUTO = 1
35  , MAGICK_OPENCL_DEVICE_SELECT_USER = 2
36  , MAGICK_OPENCL_DEVICE_SELECT_AUTO_CLEAR_CACHE = 3
37 } ImageMagickOpenCLMode;
38 
39 /* Parameter type accepted by SetMagickOpenCLEnvParm and GetMagickOpenCLEnvParm */
40 typedef enum {
41  MAGICK_OPENCL_ENV_PARAM_DEVICE /* cl_device_id (from OpenCL) */
42  , MAGICK_OPENCL_ENV_PARAM_OPENCL_DISABLED /* MagickBooleanType */
43  , MAGICK_OPENCL_ENV_PARAM_OPENCL_INITIALIZED /* MagickBooleanType */
44  , MAGICK_OPENCL_ENV_PARAM_PROGRAM_CACHE_DISABLED /* MagickBooleanType */
45  /* if true, disable the kernel binary cache */
46  , MAGICK_OPENCL_ENV_PARAM_REGENERATE_PROFILE /* MagickBooleanType */
47  /* if true, rerun microbenchmark in auto device selection */
48  , MAGICK_OPENCL_ENV_PARAM_PLATFORM_VENDOR /* char* */
49  , MAGICK_OPENCL_ENV_PARAM_DEVICE_NAME /* char* */
50 } MagickOpenCLEnvParam;
51 
52 typedef struct _MagickCLEnv* MagickCLEnv;
53 
54 extern MagickExport MagickBooleanType
55  GetMagickOpenCLEnvParam(MagickCLEnv,MagickOpenCLEnvParam,size_t,void*,
56  ExceptionInfo*),
57  InitImageMagickOpenCL(ImageMagickOpenCLMode,void*,void*,ExceptionInfo*),
58  InitOpenCLEnv(MagickCLEnv,ExceptionInfo*),
59  SetMagickOpenCLEnvParam(MagickCLEnv,MagickOpenCLEnvParam,size_t,void*,
60  ExceptionInfo*);
61 
62 extern MagickExport MagickCLEnv
63  GetDefaultOpenCLEnv();
64 
65 #if defined(__cplusplus) || defined(c_plusplus)
66 }
67 #endif
68 
69 #endif