Volumes: support selection and outlines in viewport
[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 #pragma once
20
21 /**
22  * \brief possible data types for sockets
23  * \ingroup Model
24  */
25 typedef enum DataType {
26   /** \brief Value data type */
27   COM_DT_VALUE = 1,
28   /** \brief Vector data type */
29   COM_DT_VECTOR = 2,
30   /** \brief Color data type */
31   COM_DT_COLOR = 4,
32 } DataType;
33
34 /**
35  * \brief Possible quality settings
36  * \see CompositorContext.quality
37  * \ingroup Execution
38  */
39 typedef enum CompositorQuality {
40   /** \brief High quality setting */
41   COM_QUALITY_HIGH = 0,
42   /** \brief Medium quality setting */
43   COM_QUALITY_MEDIUM = 1,
44   /** \brief Low quality setting */
45   COM_QUALITY_LOW = 2,
46 } CompositorQuality;
47
48 /**
49  * \brief Possible priority settings
50  * \ingroup Execution
51  */
52 typedef enum CompositorPriority {
53   /** \brief High quality setting */
54   COM_PRIORITY_HIGH = 2,
55   /** \brief Medium quality setting */
56   COM_PRIORITY_MEDIUM = 1,
57   /** \brief Low quality setting */
58   COM_PRIORITY_LOW = 0,
59 } CompositorPriority;
60
61 // configurable items
62
63 // chunk size determination
64 #define COM_PREVIEW_SIZE 140.0f
65 #define COM_OPENCL_ENABLED
66 //#define COM_DEBUG
67
68 // workscheduler threading models
69 /**
70  * COM_TM_QUEUE is a multi-threaded model, which uses the BLI_thread_queue pattern.
71  * This is the default option.
72  */
73 #define COM_TM_QUEUE 1
74
75 /**
76  * COM_TM_NOTHREAD is a single threading model, everything is executed in the caller thread.
77  * easy for debugging
78  */
79 #define COM_TM_NOTHREAD 0
80
81 /**
82  * COM_CURRENT_THREADING_MODEL can be one of the above, COM_TM_QUEUE is currently default.
83  */
84 #define COM_CURRENT_THREADING_MODEL COM_TM_QUEUE
85 // chunk order
86 /**
87  * \brief The order of chunks to be scheduled
88  * \ingroup Execution
89  */
90 typedef enum OrderOfChunks {
91   /** \brief order from a distance to centerX/centerY */
92   COM_TO_CENTER_OUT = 0,
93   /** \brief order randomly */
94   COM_TO_RANDOM = 1,
95   /** \brief no ordering */
96   COM_TO_TOP_DOWN = 2,
97   /** \brief experimental ordering with 9 hotspots */
98   COM_TO_RULE_OF_THIRDS = 3,
99 } OrderOfChunks;
100
101 #define COM_ORDER_OF_CHUNKS_DEFAULT COM_TO_CENTER_OUT
102
103 #define COM_RULE_OF_THIRDS_DIVIDER 100.0f
104
105 #define COM_NUM_CHANNELS_VALUE 1
106 #define COM_NUM_CHANNELS_VECTOR 3
107 #define COM_NUM_CHANNELS_COLOR 4
108
109 #define COM_BLUR_BOKEH_PIXELS 512