All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
oitBufferAccessor.h
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 HDX_OIT_BUFFER_ACCESSOR_H
25 #define HDX_OIT_BUFFER_ACCESSOR_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdx/api.h"
29 #include "pxr/imaging/hdx/version.h"
30 
31 #include "pxr/imaging/hd/task.h"
32 
33 #include <boost/shared_ptr.hpp>
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 typedef boost::shared_ptr<class HdBufferArrayRange>
38  HdBufferArrayRangeSharedPtr;
39 typedef boost::shared_ptr<class HdStRenderPassShader>
40  HdStRenderPassShaderSharedPtr;
41 
44 public:
45  static bool IsOitEnabled();
46 
47  HDX_API
48  HdxOitBufferAccessor(HdTaskContext *ctx);
49 
51  HDX_API
52  void RequestOitBuffers();
53 
55  HDX_API
57 
61  HDX_API
62  bool AddOitBufferBindings(const HdStRenderPassShaderSharedPtr &);
63 
64 private:
65  HdBufferArrayRangeSharedPtr const &_GetBar(const TfToken &);
66 
67  HdTaskContext * const _ctx;
68 };
69 
70 PXR_NAMESPACE_CLOSE_SCOPE
71 
72 #endif
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
Class for OIT render tasks to access the OIT buffers.
HDX_API void InitializeOitBuffersIfNecessary()
Called during Excecute before writing to OIT buffers.
HDX_API bool AddOitBufferBindings(const HdStRenderPassShaderSharedPtr &)
Called during Execute to add necessary OIT buffer shader bindings.
HDX_API void RequestOitBuffers()
Called during Prepare to indicate that OIT buffers are needed.