HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
textureIdentifier.h
Go to the documentation of this file.
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 
35 
37 
38 ///
39 /// \class HdStTextureIdentifier
40 ///
41 /// Class to identify a texture file or a texture within the texture file
42 /// (e.g., a frame in a movie).
43 ///
44 /// The class has value semantics and uses HdStSubtextureIdentifier in a
45 /// polymorphic way.
46 ///
48 {
49 public:
50  using ID = size_t;
51 
52  HDST_API
54 
55  /// C'tor for files that can contain only one texture.
56  ///
57  HDST_API
58  explicit HdStTextureIdentifier(const TfToken &filePath);
59 
60  /// C'tor for files that can contain more than one texture (e.g.,
61  /// frames in a movie, grids in a VDB file).
62  ///
63  HDST_API
65  const TfToken &filePath,
66  std::unique_ptr<const HdStSubtextureIdentifier> &&subtextureId);
67 
68  HDST_API
70 
71  HDST_API
73 
74  HDST_API
76 
77  HDST_API
79 
80  /// Get file path of texture file.
81  ///
82  const TfToken &GetFilePath() const {
83  return _filePath;
84  }
85 
86  /// Get additional information identifying a texture in a file that
87  /// can contain more than one texture (e.g., a frame in a movie or
88  /// a grid in a VDB file).
89  ///
90  /// nullptr for files (e.g., png) that can contain only one texture.
91  ///
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 
110 
111 #endif
HDST_API bool operator!=(const HdStTextureIdentifier &other) const
HDST_API HdStTextureIdentifier()
Definition: token.h:87
const TfToken & GetFilePath() const
HDST_API HdStTextureIdentifier & operator=(HdStTextureIdentifier &&textureId)
HDST_API ~HdStTextureIdentifier()
HDST_API size_t hash_value(const HdStTextureIdentifier &)
HDST_API bool operator==(const HdStTextureIdentifier &other) const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
const HdStSubtextureIdentifier * GetSubtextureIdentifier() const
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91