HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
oitBufferAccessor.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_HDX_OIT_BUFFER_ACCESSOR_H
25 #define PXR_IMAGING_HDX_OIT_BUFFER_ACCESSOR_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdx/api.h"
30 
31 #include "pxr/imaging/hd/task.h"
32 
33 #include <memory>
34 
36 
37 class Hgi;
38 
40  std::shared_ptr<class HdBufferArrayRange>;
41 
43  std::shared_ptr<class HdStRenderPassShader>;
44 
45 /// Class for OIT render tasks to access the OIT buffers.
47 public:
48  static bool IsOitEnabled();
49 
50  HDX_API
52 
53  /// Called during Prepare to indicate that OIT buffers are needed.
54  HDX_API
55  void RequestOitBuffers();
56 
57  /// Called during Excecute before writing to OIT buffers.
58  HDX_API
60 
61  /// Called during Execute to add necessary OIT buffer shader bindings.
62  ///
63  /// Returns false if the OIT buffers were not allocated.
64  HDX_API
66 
67 private:
68  HdBufferArrayRangeSharedPtr const &_GetBar(const TfToken &);
69 
70  HdTaskContext * const _ctx;
71 };
72 
74 
75 #endif
HDX_API HdxOitBufferAccessor(HdTaskContext *ctx)
HDX_API bool AddOitBufferBindings(const HdStRenderPassShaderSharedPtr &)
#define HDX_API
Definition: api.h:40
HDX_API void InitializeOitBuffersIfNecessary(Hgi *hgi)
Called during Excecute before writing to OIT buffers.
Definition: token.h:87
Class for OIT render tasks to access the OIT buffers.
HDX_API void RequestOitBuffers()
Called during Prepare to indicate that OIT buffers are needed.
std::unordered_map< TfToken, VtValue, TfToken::HashFunctor > HdTaskContext
Definition: renderIndex.h:77
std::shared_ptr< class HdStRenderPassShader > HdStRenderPassShaderSharedPtr
Definition: hgi.h:108
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
static bool IsOitEnabled()
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::shared_ptr< HdBufferArrayRange > HdBufferArrayRangeSharedPtr
Definition: bufferArray.h:45