HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
oitVolumeRenderTask.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_VOLUME_RENDER_TASK_H
25 #define PXR_IMAGING_HDX_OIT_VOLUME_RENDER_TASK_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdx/api.h"
31 
33 
35 
36 /// \class HdxOitVolumeRenderTask
37 ///
38 /// A task for rendering transparent geometry into OIT buffers.
39 /// Its companion task, OITResolveTask, will blend the buffers to screen.
40 ///
42 {
43 public:
44  HDX_API
45  HdxOitVolumeRenderTask(HdSceneDelegate* delegate, SdfPath const& id);
46 
47  HDX_API
48  ~HdxOitVolumeRenderTask() override;
49 
50  /// Prepare the tasks resources
51  HDX_API
52  void Prepare(HdTaskContext* ctx,
53  HdRenderIndex* renderIndex) override;
54 
55  /// Execute render pass task
56  HDX_API
57  void Execute(HdTaskContext* ctx) override;
58 
59 protected:
60  /// Sync the render pass resources
61  HDX_API
62  void _Sync(HdSceneDelegate* delegate,
63  HdTaskContext* ctx,
64  HdDirtyBits* dirtyBits) override;
65 
66 private:
67  HdxOitVolumeRenderTask() = delete;
68  HdxOitVolumeRenderTask(const HdxOitVolumeRenderTask &) = delete;
69  HdxOitVolumeRenderTask &operator =(const HdxOitVolumeRenderTask &) = delete;
70 
71  HdStRenderPassShaderSharedPtr _oitVolumeRenderPassShader;
72  const bool _isOitEnabled;
73 };
74 
75 
77 
78 #endif //PXR_IMAGING_HDX_OIT_VOLUME_RENDER_TASK_H
HDX_API void Execute(HdTaskContext *ctx) override
Execute render pass task.
uint32_t HdDirtyBits
Definition: types.h:158
#define HDX_API
Definition: api.h:40
HDX_API ~HdxOitVolumeRenderTask() override
Definition: path.h:290
HDX_API void Prepare(HdTaskContext *ctx, HdRenderIndex *renderIndex) override
Prepare the tasks resources.
std::unordered_map< TfToken, VtValue, TfToken::HashFunctor > HdTaskContext
Definition: renderIndex.h:77
std::shared_ptr< class HdStRenderPassShader > HdStRenderPassShaderSharedPtr
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HDX_API void _Sync(HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
Sync the render pass resources.