All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
shaderKey.h
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 HDST_SHADER_KEY_H
25 #define HDST_SHADER_KEY_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/enums.h"
31 #include "pxr/base/tf/token.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 
36 // This is a static utility class to interpret prim specific shaderKeys.
37 //
38 struct HdStShaderKey {
39  typedef size_t ID;
40 
41  // This hash is being used to distinguish GeometricShader instance,
42  // so that in order to break batches and interleave GL rasterization
43  // state changes appropriately.
44  // Note that the GLSL programs still can be shared across GeometricShader
45  // instances, when they are identical except the GL states, as long as
46  // Hd_GeometricShader::ComputeHash() provides consistent hash values.
47  //
48  // XXX: we may want to rename Hd_GeometricShader::ComputeHash to
49  // ComputeProgramHash or something to avoid this confusion.
50  //
51  template <typename KEY>
52  static ID ComputeHash(KEY const &key) {
53  return ComputeHash(key.GetGlslfxFile(),
54  key.GetVS(),
55  key.GetTCS(),
56  key.GetTES(),
57  key.GetGS(),
58  key.GetFS(),
59  static_cast<int16_t> (key.GetPrimitiveType()),
60  key.GetCullStyle(),
61  key.GetPolygonMode(),
62  key.IsCullingPass(),
63  key.GetLineWidth());
64  }
65 
66  HDST_API
67  static ID ComputeHash(TfToken const &glslfxFile,
68  TfToken const *VS,
69  TfToken const *TCS,
70  TfToken const *TES,
71  TfToken const *GS,
72  TfToken const *FS,
73  int16_t primType,
74  HdCullStyle cullStyle,
75  HdPolygonMode polygonMode,
76  bool isCullingPass,
77  float lineWidth);
78 
79  template <typename KEY>
80  static std::string GetGLSLFXString(KEY const &key) {
81  return GetGLSLFXString(key.GetGlslfxFile(),
82  key.GetVS(),
83  key.GetTCS(),
84  key.GetTES(),
85  key.GetGS(),
86  key.GetFS());
87  }
88 
89  HDST_API
90  static std::string GetGLSLFXString(TfToken const &glslfxFile,
91  TfToken const *VS,
92  TfToken const *TCS,
93  TfToken const *TES,
94  TfToken const *GS,
95  TfToken const *FS);
96 
97 };
98 
99 
100 PXR_NAMESPACE_CLOSE_SCOPE
101 
102 #endif // HDST_SHADER_KEY_H
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89