HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
renderBuffer.h
Go to the documentation of this file.
1 //
2 // Copyright 2019 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_RENDER_BUFFER_H
25 #define PXR_IMAGING_HD_ST_RENDER_BUFFER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/gf/vec3i.h"
29 #include "pxr/imaging/hdSt/api.h"
32 #include "pxr/imaging/hgi/hgi.h"
33 #include "pxr/imaging/hgi/enums.h"
35 
37 
41  std::shared_ptr<class HdStDynamicUvTextureObject>;
42 
44 {
45 public:
46  HDST_API
47  HdStRenderBuffer(HdStResourceRegistry *resourceRegistry, SdfPath const& id);
48 
49  HDST_API
50  ~HdStRenderBuffer() override;
51 
52  HDST_API
53  void Sync(HdSceneDelegate *sceneDelegate,
54  HdRenderParam *renderParam,
55  HdDirtyBits *dirtyBits) override;
56 
57  HDST_API
58  bool Allocate(GfVec3i const& dimensions,
60  bool multiSampled) override;
61 
62  HDST_API
63  unsigned int GetWidth() const override;
64 
65  HDST_API
66  unsigned int GetHeight() const override;
67 
68  HDST_API
69  unsigned int GetDepth() const override;
70 
71  HDST_API
72  HdFormat GetFormat() const override {return _format;}
73 
74  HDST_API
75  bool IsMultiSampled() const override;
76 
77  HDST_API
78  uint32_t GetMSAASampleCount() const;
79 
80  /// Map the buffer for reading. The control flow should be Map(),
81  /// before any I/O, followed by memory access, followed by Unmap() when
82  /// done.
83  /// \return The address of the buffer.
84  HDST_API
85  void* Map() override;
86 
87  /// Unmap the buffer.
88  HDST_API
89  void Unmap() override;
90 
91  /// Return whether any clients have this buffer mapped currently.
92  /// \return True if the buffer is currently mapped by someone.
93  HDST_API
94  bool IsMapped() const override {
95  return _mappers.load() != 0;
96  }
97 
98  /// Is the buffer converged?
99  /// \return True if the buffer is converged (not currently being
100  /// rendered to).
101  HDST_API
102  bool IsConverged() const override {
103  return true;
104  }
105 
106  /// Resolve the sample buffer into final values.
107  HDST_API
108  void Resolve() override;
109 
110  /// Returns the texture handle.
111  HDST_API
112  VtValue GetResource(bool multiSampled) const override;
113 
114  /// The identifier that can be passed to, e.g.,
115  /// HdStResourceRegistry::AllocateTextureHandle so that a
116  /// shader can bind this buffer as texture.
117  HDST_API
119  bool multiSampled);
120 
121 protected:
122  void _Deallocate() override;
123 
124 private:
125  // HdRenderBuffer::Allocate should take a scene delegate or
126  // resource registry so that we do not need to save it here.
127  HdStResourceRegistry * _resourceRegistry;
128 
129  // Format saved here (somewhat redundantely) since the
130  // Hgi texture descriptor holds an HgiFormat instead of HdFormat.
131  HdFormat _format;
132 
133  uint32_t _msaaSampleCount;
134 
135  // The GPU texture resource
137 
138  // The GPU multi-sample texture resource (optional)
139  HdStDynamicUvTextureObjectSharedPtr _textureMSAAObject;
140 
141  // The number of callers mapping this buffer.
142  std::atomic<int> _mappers;
143  // Texels are temp captured into this buffer between map and unmap.
145 };
146 
148 
149 #endif
HDST_API void * Map() override
HdFormat
Definition: types.h:423
uint32_t HdDirtyBits
Definition: types.h:158
HDST_API bool IsConverged() const override
Definition: renderBuffer.h:102
HDST_API HdStTextureIdentifier GetTextureIdentifier(bool multiSampled)
void _Deallocate() override
Deallocate the buffer, freeing any owned resources.
HDST_API bool IsMapped() const override
Definition: renderBuffer.h:94
HDST_API VtValue GetResource(bool multiSampled) const override
Returns the texture handle.
Definition: vec3i.h:61
HDST_API bool Allocate(GfVec3i const &dimensions, HdFormat format, bool multiSampled) override
HDST_API void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
Get allocation information from the scene delegate.
HDST_API HdFormat GetFormat() const override
Get the buffer's per-pixel format.
Definition: renderBuffer.h:72
Definition: path.h:290
HDST_API unsigned int GetWidth() const override
Get the buffer's width.
HDST_API unsigned int GetDepth() const override
Get the buffer's depth.
HDST_API HdStRenderBuffer(HdStResourceRegistry *resourceRegistry, SdfPath const &id)
HDST_API ~HdStRenderBuffer() override
std::shared_ptr< class HdStDynamicUvTextureObject > HdStDynamicUvTextureObjectSharedPtr
Definition: renderBuffer.h:41
GLint GLint GLsizei GLint GLenum format
Definition: glcorearb.h:108
HDST_API bool IsMultiSampled() const override
Get whether the buffer is multisampled.
HDST_API uint32_t GetMSAASampleCount() const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HDST_API void Resolve() override
Resolve the sample buffer into final values.
HDST_API unsigned int GetHeight() const override
Get the buffer's height.
Definition: value.h:166
HDST_API void Unmap() override
Unmap the buffer.