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