add BLI_strcpy_rlen, replace strcat, which was used in misleading way.
[blender.git] / intern / cycles / render / tile.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
19 #ifndef __TILE_H__
20 #define __TILE_H__
21
22 #include <limits.h>
23
24 #include "buffers.h"
25 #include "util_list.h"
26
27 CCL_NAMESPACE_BEGIN
28
29 /* Tile */
30
31 class Tile {
32 public:
33         int index;
34         int x, y, w, h;
35         int device;
36         bool rendering;
37
38         Tile()
39         {}
40
41         Tile(int index_, int x_, int y_, int w_, int h_, int device_)
42         : index(index_), x(x_), y(y_), w(w_), h(h_), device(device_), rendering(false) {}
43 };
44
45 /* Tile Manager */
46
47 class TileManager {
48 public:
49         BufferParams params;
50
51         struct State {
52                 BufferParams buffer;
53                 int sample;
54                 int num_samples;
55                 int resolution_divider;
56                 int num_tiles;
57                 int num_rendered_tiles;
58                 list<Tile> tiles;
59         } state;
60
61         int num_samples;
62
63         TileManager(bool progressive, int num_samples, int2 tile_size, int start_resolution,
64                     bool preserve_tile_device, bool background, int tile_order, int num_devices = 1);
65         ~TileManager();
66
67         void reset(BufferParams& params, int num_samples);
68         void set_samples(int num_samples);
69         bool next();
70         bool next_tile(Tile& tile, int device = 0);
71         bool done();
72
73         void set_tile_order(int tile_order_) { tile_order = tile_order_; }
74 protected:
75         /* Note: this should match enum_tile_order in properties.py */
76         enum {
77                 CENTER = 0,
78                 RIGHT_TO_LEFT = 1,
79                 LEFT_TO_RIGHT = 2,
80                 TOP_TO_BOTTOM = 3,
81                 BOTTOM_TO_TOP = 4
82         } TileOrder;
83         
84         void set_tiles();
85
86         bool progressive;
87         int2 tile_size;
88         int tile_order;
89         int start_resolution;
90         int num_devices;
91
92         /* in some cases it is important that the same tile will be returned for the same
93          * device it was originally generated for (i.e. viewport rendering when buffer is
94          * allocating once for tile and then always used by it)
95          *
96          * in other cases any tile could be handled by any device (i.e. final rendering
97          * without progressive refine)
98          */
99         bool preserve_tile_device;
100
101         /* for background render tiles should exactly match render parts generated from
102          * blender side, which means image first gets split into tiles and then tiles are
103          * assigning to render devices
104          *
105          * however viewport rendering expects tiles to be allocated in a special way,
106          * meaning image is being sliced horizontally first and every device handles
107          * it's own slice
108          */
109         bool background;
110
111         /* splits image into tiles and assigns equal amount of tiles to every render device */
112         void gen_tiles_global();
113
114         /* slices image into as much pieces as how many devices are rendering this image */
115         void gen_tiles_sliced();
116
117         /* returns tiles for background render */
118         list<Tile>::iterator next_background_tile(int device, int tile_order);
119
120         /* returns first unhandled tile for viewport render */
121         list<Tile>::iterator next_viewport_tile(int device);
122 };
123
124 CCL_NAMESPACE_END
125
126 #endif /* __TILE_H__ */
127