All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
material.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_MATERIAL_H
25 #define HDPRMAN_MATERIAL_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/material.h"
29 #include "hdPrman/matfiltFilterChain.h"
30 #include "Riley.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
34 class HdSceneDelegate;
35 struct HdPrman_Context;
36 
41 class HdPrmanMaterial final : public HdMaterial
42 {
43 public:
44  HdPrmanMaterial(SdfPath const& id);
45  virtual ~HdPrmanMaterial();
46 
48  virtual void Sync(HdSceneDelegate *sceneDelegate,
49  HdRenderParam *renderParam,
50  HdDirtyBits *dirtyBits) override;
51 
55  virtual HdDirtyBits GetInitialDirtyBitsMask() const override;
56 
58  virtual void Reload() override;
59 
60  riley::MaterialId GetMaterialId() const { return _materialId; }
61  riley::DisplacementId GetDisplacementId() const { return _displacementId; }
62 
64  bool IsValid() const;
65 
66  virtual void Finalize(HdRenderParam *renderParam) override;
67 
69  static TfTokenVector const& GetShaderSourceTypes();
70 
72  static MatfiltFilterChain GetFilterChain();
73 
75  static void SetFilterChain(MatfiltFilterChain const& chain);
76 
77 private:
78  void _ResetMaterial(HdPrman_Context *context);
79 
80  riley::MaterialId _materialId;
81  riley::DisplacementId _displacementId;
82 };
83 
84 
85 PXR_NAMESPACE_CLOSE_SCOPE
86 
87 #endif // HDPRMAN_MATERIAL_H
virtual void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
Synchronizes state from the delegate to this object.
static MatfiltFilterChain GetFilterChain()
Get material filtering chain.
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.
virtual void Reload() override
Causes the shader to be reloaded.
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...
static void SetFilterChain(MatfiltFilterChain const &chain)
Set material filtering chain.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
A representation for materials (including displacement) in prman.
Definition: material.h:41
virtual void Finalize(HdRenderParam *renderParam) override
Finalizes object resources.
Hydra Schema for a material object.
Definition: material.h:37
bool IsValid() const
Return true if this material is valid.
static TfTokenVector const & GetShaderSourceTypes()
Return the static list of tokens supported.