Loading...
Searching...
No Matches
lightFilter.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 EXT_RMANPKG_22_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_LIGHT_FILTER_H
25#define EXT_RMANPKG_22_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_LIGHT_FILTER_H
26
27#include "pxr/pxr.h"
28#include "pxr/imaging/hd/sprim.h"
29#include "Riley.h"
30
31#include <mutex>
32
33PXR_NAMESPACE_OPEN_SCOPE
34
35// For now, the procs in this file are boiler plate for when hdPrman needs to
36// have light filters become prime citizens. This will probably happen when
37// its time to implement shared light filters. For now, light filters are
38// handled inside the lights in light.cpp.
39//
40// Also, for now base the HdPrmanLightFilter class on HdSprim as there
41// currently is no HdLightFilter class.
42
43class HdSceneDelegate;
44class HdPrman_RenderParam;
45
50class HdPrmanLightFilter final : public HdSprim
51{
52public:
53 HdPrmanLightFilter(SdfPath const& id, TfToken const& lightFilterType);
54 ~HdPrmanLightFilter() override;
55
57 void Sync(HdSceneDelegate *sceneDelegate,
58 HdRenderParam *renderParam,
59 HdDirtyBits *dirtyBits) override;
60
63 HdSceneDelegate *sceneDelegate,
64 riley::Riley *riley);
65
69 HdDirtyBits GetInitialDirtyBitsMask() const override;
70
71 void Finalize(HdRenderParam *renderParam) override;
72
73 riley::CoordinateSystemId GetCoordSysId();
74
75private:
76 void _SyncToRileyWithLock(
77 HdSceneDelegate *sceneDelegate,
78 riley::Riley *riley);
79
80 riley::CoordinateSystemId _coordSysId;
81 mutable std::mutex _syncToRileyMutex;
82 bool _rileyIsInSync;
83};
84
85
86PXR_NAMESPACE_CLOSE_SCOPE
87
88#endif // EXT_RMANPKG_22_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_LIGHT_FILTER_H
A representation for light filters.
Definition: lightFilter.h:51
void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
Synchronizes state from the delegate to this object.
void SyncToRiley(HdSceneDelegate *sceneDelegate, riley::Riley *riley)
Make sure this material has been updated in Riley.
void Finalize(HdRenderParam *renderParam) override
Finalizes object resources.
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 ...
Adapter class providing data exchange with the client scene graph.
Sprim (state prim) is a base class of managing state for non-drawable scene entity (e....
Definition: sprim.h:52
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88