All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
renderTask.h
1 //
2 // Copyright 2016 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_RENDER_TASK_H
25 #define PXR_IMAGING_HDX_RENDER_TASK_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdx/api.h"
29 #include "pxr/imaging/hdx/version.h"
30 #include "pxr/imaging/hdx/progressiveTask.h"
31 #include "pxr/imaging/hdx/renderSetupTask.h" // for short-term compatibility.
32 #include "pxr/imaging/hdSt/renderPassState.h"
33 
34 #include <boost/shared_ptr.hpp>
35 
36 #include <memory>
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
40 
41 class HdSceneDelegate;
42 
43 using HdRenderPassStateSharedPtr = std::shared_ptr<class HdRenderPassState>;
44 using HdRenderPassSharedPtr = std::shared_ptr<class HdRenderPass>;
45 typedef boost::shared_ptr<class HdxRenderSetupTask> HdxRenderSetupTaskSharedPtr;
46 
67 {
68 public:
69  HDX_API
70  HdxRenderTask(HdSceneDelegate* delegate, SdfPath const& id);
71 
72  HDX_API
73  virtual ~HdxRenderTask();
74 
76  virtual bool IsConverged() const override;
77 
79  HDX_API
80  virtual void Sync(HdSceneDelegate* delegate,
81  HdTaskContext* ctx,
82  HdDirtyBits* dirtyBits) override;
83 
85  HDX_API
86  virtual void Prepare(HdTaskContext* ctx,
87  HdRenderIndex* renderIndex) override;
88 
90  HDX_API
91  virtual void Execute(HdTaskContext* ctx) override;
92 
94  HDX_API
95  virtual const TfTokenVector &GetRenderTags() const override;
96 
97 protected:
98  HDX_API
99  HdRenderPassStateSharedPtr _GetRenderPassState(HdTaskContext *ctx) const;
100 
101  // Returns the number of draw items used for rendering. This will only
102  // return the correct result after HdxRenderTask::Prepare() has been called.
103  HDX_API
104  size_t _GetDrawItemCount() const;
105 
106 private:
107  HdRenderPassSharedPtr _pass;
108  TfTokenVector _renderTags;
109 
110  // Optional internal render setup task, for params unpacking.
111  HdxRenderSetupTaskSharedPtr _setupTask;
112 
113  // Setup additional state that HdStRenderPassState requires.
114  // XXX: This should be moved to hdSt!
115  void _SetHdStRenderPassState(HdTaskContext *ctx,
116  HdStRenderPassState *renderPassState);
117 
118  HdxRenderTask() = delete;
119  HdxRenderTask(const HdxRenderTask &) = delete;
120  HdxRenderTask &operator =(const HdxRenderTask &) = delete;
121 };
122 
123 
124 PXR_NAMESPACE_CLOSE_SCOPE
125 
126 #endif //PXR_IMAGING_HDX_RENDER_TASK_H
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:121
A task for rendering geometry to pixels.
Definition: renderTask.h:66
virtual bool IsConverged() const override
Hooks for progressive rendering (delegated to renderpasses).
This is an interface class that declares that derived tasks implement some form of progressive render...
A set of rendering parameters used among render passes.
virtual HDX_API void Prepare(HdTaskContext *ctx, HdRenderIndex *renderIndex) override
Prepare the tasks resources.
virtual HDX_API const TfTokenVector & GetRenderTags() const override
Collect Render Tags used by the task.
Adapter class providing data exchange with the client scene graph.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:431
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
virtual HDX_API void Sync(HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
Sync the render pass resources.
virtual HDX_API void Execute(HdTaskContext *ctx) override
Execute render pass task.