HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
light.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_IMAGING_HD_ST_LIGHT_H
25 #define PXR_IMAGING_HD_ST_LIGHT_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/light.h"
31 
33 
34 #include "pxr/base/vt/value.h"
35 
37 
38 /// \class HdStLight
39 ///
40 /// A light model for use in Storm.
41 /// Note: This class simply stores the light parameters and relies on an
42 /// external task (HdxSimpleLightTask) to upload them to the GPU.
43 ///
44 class HdStLight final : public HdLight {
45 public:
46  HDST_API
47  HdStLight(SdfPath const & id, TfToken const &lightType);
48  HDST_API
49  ~HdStLight() override;
50 
51  /// Synchronizes state from the delegate to this object.
52  HDST_API
53  void Sync(HdSceneDelegate *sceneDelegate,
54  HdRenderParam *renderParam,
55  HdDirtyBits *dirtyBits) override;
56 
57  /// Finalizes object resources. This function might not delete resources,
58  /// but it should deal with resource ownership so that the sprim is
59  /// deletable.
60  HDST_API
61  void Finalize(HdRenderParam *renderParam) override;
62 
63  /// Accessor for tasks to get the parameters cached in this object.
64  HDST_API
65  VtValue Get(TfToken const &token) const;
66 
67  /// Returns the minimal set of dirty bits to place in the
68  /// change tracker for use in the first sync of this prim.
69  /// Typically this would be all dirty bits.
70  HDST_API
71  HdDirtyBits GetInitialDirtyBitsMask() const override;
72 
73 private:
74  // Converts area lights (sphere lights and distant lights) into
75  // glfSimpleLights and inserts them in the dictionary so
76  // SimpleLightTask can use them later on as if they were regular lights.
77  GlfSimpleLight _ApproximateAreaLight(SdfPath const &id,
78  HdSceneDelegate *sceneDelegate);
79 
80  // Collects data such as the environment map texture path for a
81  // dome light. The lighting shader is responsible for pre-calculating
82  // the different textures needed for IBL.
83  GlfSimpleLight _PrepareDomeLight(SdfPath const &id,
84  HdSceneDelegate *sceneDelegate);
85 
86 private:
87  // Stores the internal light type of this light.
88  TfToken _lightType;
89 
90  // Cached states.
92 };
93 
94 
96 
97 #endif // PXR_IMAGING_HD_ST_LIGHT_H
HDST_API HdStLight(SdfPath const &id, TfToken const &lightType)
HDST_API void Finalize(HdRenderParam *renderParam) override
uint32_t HdDirtyBits
Definition: types.h:127
Definition: token.h:87
HDST_API void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
Synchronizes state from the delegate to this object.
HDST_API HdDirtyBits GetInitialDirtyBitsMask() const override
HDST_API ~HdStLight() override
Definition: path.h:288
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HDST_API VtValue Get(TfToken const &token) const
Accessor for tasks to get the parameters cached in this object.
Definition: value.h:168
Definition: light.h:82