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