textureIdentifier.h
1 //
2 // Copyright 2020 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_TEXTURE_IDENTIFIER_H
25 #define PXR_IMAGING_HD_ST_TEXTURE_IDENTIFIER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 
30 #include "pxr/base/tf/token.h"
31 
32 #include <memory>
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
37 
48 {
49 public:
50  using ID = size_t;
51 
52  HDST_API
54 
57  HDST_API
58  explicit HdStTextureIdentifier(const TfToken &filePath);
59 
63  HDST_API
65  const TfToken &filePath,
66  std::unique_ptr<const HdStSubtextureIdentifier> &&subtextureId);
67 
68  HDST_API
70 
71  HDST_API
72  HdStTextureIdentifier &operator=(HdStTextureIdentifier &&textureId);
73 
74  HDST_API
75  HdStTextureIdentifier &operator=(const HdStTextureIdentifier &textureId);
76 
77  HDST_API
79 
82  const TfToken &GetFilePath() const {
83  return _filePath;
84  }
85 
93  return _subtextureId.get();
94  }
95 
96  HDST_API
97  bool operator==(const HdStTextureIdentifier &other) const;
98  HDST_API
99  bool operator!=(const HdStTextureIdentifier &other) const;
100 
101 private:
102  TfToken _filePath;
103  std::unique_ptr<const HdStSubtextureIdentifier> _subtextureId;
104 };
105 
106 HDST_API
107 size_t hash_value(const HdStTextureIdentifier &);
108 
109 PXR_NAMESPACE_CLOSE_SCOPE
110 
111 #endif
Base class for additional information to identify a texture in a file that can contain several textur...
Class to identify a texture file or a texture within the texture file (e.g., a frame in a movie).
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
const HdStSubtextureIdentifier * GetSubtextureIdentifier() const
Get additional information identifying a texture in a file that can contain more than one texture (e....
const TfToken & GetFilePath() const
Get file path of texture file.
std::enable_if< std::is_same< Half, half >::value, size_t >::type hash_value(const Half &h)
Overload hash_value for half.
Definition: half.h:50
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...