HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
texture.h
Go to the documentation of this file.
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 PXR_IMAGING_HD_ST_TEXTURE_H
25 #define PXR_IMAGING_HD_ST_TEXTURE_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/texture.h"
32 #include "pxr/imaging/hd/types.h"
33 #include "pxr/imaging/hd/enums.h"
34 
35 #include "pxr/usd/sdf/path.h"
36 
38 
39 
40 class HdSceneDelegate;
41 class HdRenderIndex;
42 
44  std::shared_ptr<class HdStTextureResource>;
46  std::shared_ptr<class HdStTextureResourceHandle>;
47 
48 ///
49 /// Represents a Texture Buffer Prim.
50 /// Texture could be a uv texture or a ptex texture.
51 /// Multiple texture prims could represent the same texture buffer resource
52 /// and the scene delegate is used to get a global unique id for the texture.
53 /// The delegate is also used to obtain a HdTextureResource for the texture
54 /// represented by that id.
55 ///
56 class HdStTexture : public HdTexture {
57 public:
58  HDST_API
59  HdStTexture(SdfPath const & id);
60  HDST_API
61  virtual ~HdStTexture();
62 
63  /// Synchronizes state from the delegate to Hydra, for example, allocating
64  /// parameters into GPU memory.
65  HDST_API
66  virtual void Sync(HdSceneDelegate *sceneDelegate,
67  HdRenderParam *renderParam,
68  HdDirtyBits *dirtyBits) override;
69 
70  /// Returns the minimal set of dirty bits to place in the
71  /// change tracker for use in the first sync of this prim.
72  /// Typically this would be all dirty bits.
73  HDST_API
74  virtual HdDirtyBits GetInitialDirtyBitsMask() const override;
75 
76 protected:
78  HdSceneDelegate *sceneDelegate,
79  const SdfPath &sceneId,
80  HdTextureResource::ID texID) const;
81 
83  HdRenderIndex *renderIndex,
84  const SdfPath &textureHandleId,
85  const HdTextureResourceSharedPtr &textureResource);
86 
87 private:
88  // Make sure we have a reference to the texture resource, so its
89  // life time exists at least as long as this object.
90  HdStTextureResourceSharedPtr _textureResource;
91 
92  HdStTextureResourceHandleSharedPtr _textureResourceHandle;
93 };
94 
95 
97 
98 #endif //PXR_IMAGING_HD_ST_TEXTURE_H
99 
std::shared_ptr< class HdTextureResource > HdTextureResourceSharedPtr
uint32_t HdDirtyBits
Definition: types.h:127
virtual HDST_API HdDirtyBits GetInitialDirtyBitsMask() const override
virtual HDST_API ~HdStTexture()
std::shared_ptr< class HdStTextureResourceHandle > HdStTextureResourceHandleSharedPtr
Definition: material.h:44
std::shared_ptr< class HdStTextureResource > HdStTextureResourceSharedPtr
Definition: material.h:42
void _RegisterTextureResource(HdRenderIndex *renderIndex, const SdfPath &textureHandleId, const HdTextureResourceSharedPtr &textureResource)
Definition: path.h:288
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HDST_API HdStTexture(SdfPath const &id)
virtual HDST_API void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
HdStTextureResourceSharedPtr _GetTextureResource(HdSceneDelegate *sceneDelegate, const SdfPath &sceneId, HdTextureResource::ID texID) const