1
2 //
3 // This source file is part of appleseed.
4 // Visit https://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-2018 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 #pragma once
31
32 // appleseed.foundation headers.
33 #include "foundation/math/vector.h"
34
35 namespace renderer
36 {
37
38 //
39 // This class identifies the pixel currently being rendered throughout the
40 // Tile Renderer -> Pixel Renderer -> Sample Renderer -> Surface Shader -> Lighting Engine chain.
41 //
42
43 class PixelContext
44 {
45 public:
46 // Constructor.
47 PixelContext(
48 const foundation::Vector2i& pixel_coords,
49 const foundation::Vector2d& sample_position);
50
51 // Return pixel coordinates.
52 const foundation::Vector2i& get_pixel_coords() const;
53
54 // Return sample coordinates.
55 const foundation::Vector2d& get_sample_position() const;
56
57 private:
58 const foundation::Vector2i m_pixel_coords;
59 const foundation::Vector2d m_sample_position;
60 };
61
62
63 //
64 // PixelContext class implementation.
65 //
66
PixelContext(const foundation::Vector2i & pixel_coords,const foundation::Vector2d & sample_position)67 inline PixelContext::PixelContext(
68 const foundation::Vector2i& pixel_coords,
69 const foundation::Vector2d& sample_position)
70 : m_pixel_coords(pixel_coords)
71 , m_sample_position(sample_position)
72 {
73 }
74
get_pixel_coords()75 inline const foundation::Vector2i& PixelContext::get_pixel_coords() const
76 {
77 return m_pixel_coords;
78 }
79
get_sample_position()80 inline const foundation::Vector2d& PixelContext::get_sample_position() const
81 {
82 return m_sample_position;
83 }
84
85 } // namespace renderer
86