1 | |
2 | // |
3 | // This source file is part of appleseed. |
4 | // Visit http://appleseedhq.net/ for additional information and resources. |
5 | // |
6 | // This software is released under the MIT license. |
7 | // |
8 | // Copyright (c) 2010-2013 Francois Beaune, Jupiter Jazz Limited |
9 | // Copyright (c) 2014-2017 Francois Beaune, The appleseedhq Organization |
10 | // |
11 | // Permission is hereby granted, free of charge, to any person obtaining a copy |
12 | // of this software and associated documentation files (the "Software"), to deal |
13 | // in the Software without restriction, including without limitation the rights |
14 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
15 | // copies of the Software, and to permit persons to whom the Software is |
16 | // furnished to do so, subject to the following conditions: |
17 | // |
18 | // The above copyright notice and this permission notice shall be included in |
19 | // all copies or substantial portions of the Software. |
20 | // |
21 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
22 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
23 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
24 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
25 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
26 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
27 | // THE SOFTWARE. |
28 | // |
29 | |
30 | #ifndef APPLESEED_RENDERER_KERNEL_RENDERING_ITILECALLBACK_H |
31 | #define APPLESEED_RENDERER_KERNEL_RENDERING_ITILECALLBACK_H |
32 | |
33 | // appleseed.foundation headers. |
34 | #include "foundation/core/concepts/iunknown.h" |
35 | |
36 | // appleseed.main headers. |
37 | #include "main/dllsymbol.h" |
38 | |
39 | // Standard headers. |
40 | #include <cstddef> |
41 | |
42 | // Forward declarations. |
43 | namespace renderer { class Frame; } |
44 | |
45 | namespace renderer |
46 | { |
47 | |
48 | // |
49 | // Tile callback interface. |
50 | // |
51 | // A tile callback allows user code to be executed before and after |
52 | // a tile is rendered. A typical usage is to display tiles as they |
53 | // are rendered. |
54 | // |
55 | |
56 | class APPLESEED_DLLSYMBOL ITileCallback |
57 | : public foundation::IUnknown |
58 | { |
59 | public: |
60 | // This method is called before a region of the frame is rendered. |
61 | // All renderers call this method. |
62 | virtual void pre_render( |
63 | const size_t x, |
64 | const size_t y, |
65 | const size_t width, |
66 | const size_t height) = 0; |
67 | |
68 | // This method is called after a tile is rendered. |
69 | // Only tile-based renderers call this method. |
70 | virtual void post_render_tile( |
71 | const Frame* frame, |
72 | const size_t tile_x, |
73 | const size_t tile_y) = 0; |
74 | |
75 | // This method is called after a whole frame is rendered. |
76 | // Only whole-frame (progressive) renderers call this method. |
77 | virtual void post_render( |
78 | const Frame* frame) = 0; |
79 | }; |
80 | |
81 | |
82 | // |
83 | // Interface of a ITileCallback factory that can cross DLL boundaries. |
84 | // |
85 | |
86 | class APPLESEED_DLLSYMBOL ITileCallbackFactory |
87 | : public foundation::IUnknown |
88 | { |
89 | public: |
90 | // Return a new tile callback instance. |
91 | virtual ITileCallback* create() = 0; |
92 | }; |
93 | |
94 | } // namespace renderer |
95 | |
96 | #endif // !APPLESEED_RENDERER_KERNEL_RENDERING_ITILECALLBACK_H |
97 | |