All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
engine.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 HD_ENGINE_H
25 #define HD_ENGINE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/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 class HdRenderIndex;
38 class HdRenderDelegate;
39 class HdResourceRegistry;
40 
41 typedef boost::shared_ptr<class HdRenderPass> HdRenderPassSharedPtr;
42 typedef boost::shared_ptr<class HdRenderPassState> HdRenderPassStateSharedPtr;
43 
48 class HdEngine {
49 public:
50  HD_API
51  HdEngine();
52  HD_API
53  virtual ~HdEngine();
54 
61 
64  HD_API
65  void SetTaskContextData(const TfToken &id, VtValue &data);
66 
68  HD_API
69  void RemoveTaskContextData(const TfToken &id);
70 
72 
74  HD_API
75  void Execute(HdRenderIndex *index,
76  HdTaskSharedPtrVector *tasks);
77 
78  HD_API
79  void ReloadAllShaders(HdRenderIndex& index);
80 
81 
82 private:
87  HdTaskContext _taskContext;
88 };
89 
90 
91 PXR_NAMESPACE_CLOSE_SCOPE
92 
93 #endif //HD_ENGINE_H
HD_API void Execute(HdRenderIndex *index, HdTaskSharedPtrVector *tasks)
Execute tasks.
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:119
HD_API void RemoveTaskContextData(const TfToken &id)
Removes the specified token.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
The application-facing entry point top-level entry point for accessing Hydra.
Definition: engine.h:48
A central registry of all GPU resources.
HD_API void SetTaskContextData(const TfToken &id, VtValue &data)
Adds or updates the value associated with the token.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182