intern/cycles/render/film.h

   1 /*
   2  * Copyright 2011-2013 Blender Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   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
  17 #ifndef __FILM_H__
  18 #define __FILM_H__
  19
  20 #include "util/util_string.h"
  21 #include "util/util_vector.h"
  22
  23 #include "kernel/kernel_types.h"
  24
  25 #include "graph/node.h"
  26
  27 CCL_NAMESPACE_BEGIN
  28
  29 class Device;
  30 class DeviceScene;
  31 class Scene;
  32
  33 typedef enum FilterType {
  34         FILTER_BOX,
  35         FILTER_GAUSSIAN,
  36         FILTER_BLACKMAN_HARRIS,
  37
  38         FILTER_NUM_TYPES,
  39 } FilterType;
  40
  41 class Pass {
  42 public:
  43         PassType type;
  44         int components;
  45         bool filter;
  46         bool exposure;
  47         PassType divide_type;
  48         string name;
  49
  50         static void add(PassType type, vector<Pass>& passes, const char* name = NULL);
  51         static bool equals(const vector<Pass>& A, const vector<Pass>& B);
  52         static bool contains(const vector<Pass>& passes, PassType);
  53 };
  54
  55 class Film : public Node {
  56 public:
  57         NODE_DECLARE
  58
  59         float exposure;
  60         vector<Pass> passes;
  61         bool denoising_data_pass;
  62         bool denoising_clean_pass;
  63         int denoising_flags;
  64         float pass_alpha_threshold;
  65
  66         int pass_stride;
  67         int denoising_data_offset;
  68         int denoising_clean_offset;
  69
  70         FilterType filter_type;
  71         float filter_width;
  72         size_t filter_table_offset;
  73
  74         float mist_start;
  75         float mist_depth;
  76         float mist_falloff;
  77
  78         bool use_light_visibility;
  79         bool use_sample_clamp;
  80         CryptomatteType cryptomatte_passes;
  81         int cryptomatte_depth;
  82
  83         bool need_update;
  84
  85         Film();
  86         ~Film();
  87
  88         void device_update(Device *device, DeviceScene *dscene, Scene *scene);
  89         void device_free(Device *device, DeviceScene *dscene, Scene *scene);
  90
  91         bool modified(const Film& film);
  92         void tag_passes_update(Scene *scene, const vector<Pass>& passes_);
  93         void tag_update(Scene *scene);
  94 };
  95
  96 CCL_NAMESPACE_END
  97
  98 #endif /* __FILM_H__ */