All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
presentTask.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_PRESENT_TASK_H
25 #define HDX_PRESENT_TASK_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/task.h"
29 #include "pxr/imaging/hdx/api.h"
30 #include "pxr/imaging/hdx/compositor.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
39 class HdxPresentTask : public HdTask
40 {
41 public:
42  HDX_API
43  HdxPresentTask(HdSceneDelegate* delegate, SdfPath const& id);
44 
45  HDX_API
46  virtual ~HdxPresentTask();
47 
49  HDX_API
50  virtual void Sync(HdSceneDelegate* delegate,
51  HdTaskContext* ctx,
52  HdDirtyBits* dirtyBits) override;
53 
55  HDX_API
56  virtual void Prepare(HdTaskContext* ctx,
57  HdRenderIndex* renderIndex) override;
58 
60  HDX_API
61  virtual void Execute(HdTaskContext* ctx) override;
62 
63 private:
64  SdfPath _aovBufferPath;
65  SdfPath _depthBufferPath;
66 
67  HdRenderBuffer *_aovBuffer;
68  HdRenderBuffer *_depthBuffer;
69 
70  HdxCompositor _compositor;
71 
72  HdxPresentTask() = delete;
73  HdxPresentTask(const HdxPresentTask &) = delete;
74  HdxPresentTask &operator =(const HdxPresentTask &) = delete;
75 };
76 
77 
83 {
85  : aovBufferPath()
86  , depthBufferPath()
87  {}
88 
89  SdfPath aovBufferPath;
90  SdfPath depthBufferPath;
91 };
92 
93 // VtValue requirements
94 HDX_API
95 std::ostream& operator<<(std::ostream& out, const HdxPresentTaskParams& pv);
96 HDX_API
97 bool operator==(const HdxPresentTaskParams& lhs,
98  const HdxPresentTaskParams& rhs);
99 HDX_API
100 bool operator!=(const HdxPresentTaskParams& lhs,
101  const HdxPresentTaskParams& rhs);
102 
103 
104 PXR_NAMESPACE_CLOSE_SCOPE
105 
106 #endif
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:119
virtual HDX_API void Execute(HdTaskContext *ctx) override
Execute the colorize task.
AR_API bool operator!=(const ArAssetInfo &lhs, const ArAssetInfo &rhs)
AR_API bool operator==(const ArAssetInfo &lhs, const ArAssetInfo &rhs)
A task for taking output AOV data of a HdSt render buffer and rendering it to the current GL buffer...
Definition: presentTask.h:39
This class is a utility for rendering deep raytracer or aov output (color/depth) to the GL framebuffe...
Definition: compositor.h:47
Adapter class providing data exchange with the client scene graph.
virtual HDX_API void Prepare(HdTaskContext *ctx, HdRenderIndex *renderIndex) override
Prepare the colorize task.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
PresentTask parameters.
Definition: presentTask.h:82
GF_API std::ostream & operator<<(std::ostream &, const GfBBox3d &)
Output a GfBBox3d using the format [(range) matrix zeroArea].
A render buffer is a handle to a data resource that can be rendered into, such as a 2d image for a dr...
Definition: renderBuffer.h:48
virtual HDX_API void Sync(HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
Sync the render pass resources.