All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
light.h
1 //
2 // Copyright 2019 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 HDPRMAN_LIGHT_H
25 #define HDPRMAN_LIGHT_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/light.h"
29 #include "Riley.h"
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
33 class HdSceneDelegate;
34 struct HdPrman_Context;
35 
40 class HdPrmanLight final : public HdLight
41 {
42 public:
43  HdPrmanLight(SdfPath const& id, TfToken const& lightType);
44  virtual ~HdPrmanLight();
45 
47  virtual void Sync(HdSceneDelegate *sceneDelegate,
48  HdRenderParam *renderParam,
49  HdDirtyBits *dirtyBits) override;
50 
54  virtual HdDirtyBits GetInitialDirtyBitsMask() const override;
55 
57  bool IsValid() const;
58 
59  virtual void Finalize(HdRenderParam *renderParam) override;
60 
61 private:
62  void _ResetLight(HdPrman_Context *context);
63 
64  const TfToken _hdLightType;
65  riley::LightShaderId _shaderId;
66  riley::LightInstanceId _instanceId;
67 
68  TfToken _lightLink;
69 };
70 
71 
72 PXR_NAMESPACE_CLOSE_SCOPE
73 
74 #endif // HDPRMAN_LIGHT_H
virtual HdDirtyBits GetInitialDirtyBitsMask() const override
Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of thi...
The HdRenderParam is an opaque (to core Hydra) handle, to an object that is obtained from the render ...
bool IsValid() const
Return true if this material is valid.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
Adapter class providing data exchange with the client scene graph.
A representation for lights.
Definition: light.h:40
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
virtual void Finalize(HdRenderParam *renderParam) override
Finalizes object resources.
virtual void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
Synchronizes state from the delegate to this object.
A light model, used in conjunction with HdRenderPass.
Definition: light.h:86