All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dynamicUvTextureObject.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_DYNAMIC_UV_TEXTURE_OBJECT_H
25 #define PXR_IMAGING_HD_ST_DYNAMIC_UV_TEXTURE_OBJECT_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 
30 #include "pxr/imaging/hdSt/textureObject.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
35 
54 {
55 public:
56  HDST_API
58  const HdStTextureIdentifier &textureId,
59  HdSt_TextureObjectRegistry *textureObjectRegistry);
60 
61  HDST_API
62  ~HdStDynamicUvTextureObject() override;
63 
67  void CreateTexture(const HgiTextureDesc &desc) {
68  _CreateTexture(desc);
69  }
70 
74  {
75  _GenerateMipmaps();
76  }
77 
79  void DestroyTexture() {
80  _DestroyTexture();
81  }
82 
88  void SetWrapParameters(const std::pair<HdWrap, HdWrap> &wrapParameters) {
89  _SetWrapParameters(wrapParameters);
90  }
91 
99  void SetCpuData(std::unique_ptr<HdStTextureCpuData> &&cpuData) {
100  _SetCpuData(std::move(cpuData));
101  }
102 
108  return _GetCpuData();
109  }
110 
114  HDST_API
115  bool IsValid() const override;
116 
117 protected:
118  HDST_API
119  void _Load() override;
120 
121  HDST_API
122  void _Commit() override;
123 
124 private:
125  HdStDynamicUvTextureImplementation * _GetImpl() const;
126 };
127 
128 PXR_NAMESPACE_CLOSE_SCOPE
129 
130 #endif
void GenerateMipmaps()
Make GPU generate mipmaps.
void DestroyTexture()
Release GPU resource.
HDST_API void _Load() override
Load texture to CPU (thread-safe)
A uv texture that is managed but not populated by the Storm texture system.
Describes the properties needed to create a GPU texture.
Definition: texture.h:107
void SetWrapParameters(const std::pair< HdWrap, HdWrap > &wrapParameters)
Set wrap mode hints used when a texture node&#39;s wrap mode is use metadata.
Represents CPU data that can be stored in a HdStUvTextureObject, mostly, likely during the load phase...
Class to identify a texture file or a texture within the texture file (e.g., a frame in a movie)...
HdStTextureCpuData * GetCpuData() const
Get the CPU data stored for this texture.
HDST_API bool IsValid() const override
Always returns true - so that samplers for this texture are created.
Allows external clients to specify how a UV texture is loaded from, e.g., a file and how it is commit...
void SetCpuData(std::unique_ptr< HdStTextureCpuData > &&cpuData)
Save CPU data for this texture (transfering ownership).
void CreateTexture(const HgiTextureDesc &desc)
Allocate GPU resource using the texture descriptor.
HDST_API void _Commit() override
Commit texture to GPU (not thread-safe)
A base class for uv textures.