task.h
1 //
2 // Copyright 2018 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_TASK_H
25 #define PXR_IMAGING_HDX_TASK_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdx/api.h"
29 #include "pxr/imaging/hd/task.h"
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
33 class Hgi;
34 
35 
44 class HdxTask : public HdTask
45 {
46 public:
47  HDX_API
48  HdxTask(SdfPath const& id);
49 
50  HDX_API
51  ~HdxTask() override;
52 
62  HDX_API
63  virtual bool IsConverged() const;
64 
69  void Sync(
70  HdSceneDelegate* delegate,
71  HdTaskContext* ctx,
72  HdDirtyBits* dirtyBits) override final;
73 
74 protected:
75  // This is called during the hydra Sync Phase via HdxTask::Sync.
76  // Please see HdTask::Sync for Sync Phase documentation.
77  virtual void _Sync(
78  HdSceneDelegate* delegate,
79  HdTaskContext* ctx,
80  HdDirtyBits* dirtyBits) = 0;
81 
82  // Swaps the color target and colorIntermediate target.
83  // This is used when a task wishes to read from the color and also write
84  // to it. We use two color targets and ping-pong between them.
85  void _ToggleRenderTarget(HdTaskContext* ctx);
86 
87  // Return pointer to Hydra Graphics Interface.
88  HDX_API
89  Hgi* _GetHgi() const;
90 
91  Hgi* _hgi;
92 };
93 
94 PXR_NAMESPACE_CLOSE_SCOPE
95 
96 #endif
97 
virtual HDX_API bool IsConverged() const
This function returns true when a (progressive) task considers its execution results converged.
Adapter class providing data exchange with the client scene graph.
void Sync(HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override final
We override HdTask::Sync, but make it 'final' to make sure derived classes can't override it and inst...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Base class for (some) tasks in Hdx that provides common progressive rendering and Hgi functionality.
Definition: task.h:44
Hydra Graphics Interface.
Definition: hgi.h:110