Fix for [#31418] Code review: OpenCL initialization
[blender.git] / source / blender / compositor / COM_defines.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor: 
19  *              Jeroen Bakker 
20  *              Monique Dewanchand
21  */
22
23 #ifndef _COM_defines_h_
24 #define _COM_defines_h_
25
26 /**
27   * @brief possible data types for SocketConnection
28   * @ingroup Model
29   */
30 typedef enum DataType {
31         /** @brief Unknown data type (or not yet known) */
32         COM_DT_UNKNOWN = 0,
33         /** @brief Value data type */
34         COM_DT_VALUE   = 1,
35         /** @brief Vector data type */
36         COM_DT_VECTOR  = 2,
37         /** @brief Color data type */
38         COM_DT_COLOR   = 4
39 } DataType;
40
41 /**
42   * @brief Possible quality settings
43   * @see CompositorContext.quality
44   * @ingroup Execution
45   */
46 typedef enum CompositorQuality {
47         /** @brief High quality setting */
48         COM_QUALITY_HIGH   = 0 ,
49         /** @brief Medium quality setting */
50         COM_QUALITY_MEDIUM = 1,
51         /** @brief Low quality setting */
52         COM_QUALITY_LOW    = 2
53 } CompositorQuality;
54
55 // configurable items
56
57 // chunk size determination
58 #define COM_PREVIEW_SIZE 140.0f
59 #define COM_OPENCL_ENABLED
60 #define COM_PREVIEW_ENABLED
61 // workscheduler threading models
62 /**
63   * COM_TM_QUEUE is a multithreaded model, which uses the BLI_thread_queue pattern. This is the default option.
64   */
65 #define COM_TM_QUEUE 1
66
67 /**
68   * COM_TM_NOTHREAD is a single threading model, everything is executed in the caller thread. easy for debugging
69   */
70 #define COM_TM_NOTHREAD 0
71
72 /**
73   * COM_CURRENT_THREADING_MODEL can be one of the above, COM_TM_QUEUE is currently default.
74   */
75 #define COM_CURRENT_THREADING_MODEL COM_TM_QUEUE
76 // chunk order
77 /**
78   * @brief The order of chunks to be scheduled
79   * @ingroup Execution
80   */
81 typedef enum OrderOfChunks {
82         /** @brief order from a distance to centerX/centerY */
83         COM_TO_CENTER_OUT = 0,
84         /** @brief order randomly */
85         COM_TO_RANDOM = 1,
86         /** @brief no ordering */
87         COM_TO_TOP_DOWN = 2,
88         /** @brief experimental ordering with 9 hotspots */
89         COM_TO_RULE_OF_THIRDS = 3
90 } OrderOfChunks;
91
92 #define COM_RULE_OF_THIRDS_DIVIDER 100.0f
93
94 #define COM_NUMBER_OF_CHANNELS 4
95
96 #define COM_DEFAULT_RESOLUTION_WIDTH 640
97 #define COM_DEFAULT_RESOLUTION_HEIGHT 480
98
99 #endif