HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
engine.h
Go to the documentation of this file.
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_HD_ENGINE_H
25 #define PXR_IMAGING_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 <memory>
34 
36 
37 class HdRenderIndex;
38 class HdRenderDelegate;
39 class HdResourceRegistry;
40 
41 using HdRenderPassSharedPtr = std::shared_ptr<class HdRenderPass>;
42 using HdRenderPassStateSharedPtr = std::shared_ptr<class HdRenderPassState>;
43 
44 /// \class HdEngine
45 ///
46 /// The application-facing entry point top-level entry point for accessing Hydra.
47 /// Typically the application would only create one of these.
48 class HdEngine {
49 public:
50  HD_API
51  HdEngine();
52  HD_API
53  virtual ~HdEngine();
54 
55  /// \name Task Context
56  ///
57  /// External interface to set data/state in the task context passed to
58  /// each task in the render graph
59  ///
60  /// @{
61 
62  /// Adds or updates the value associated with the token.
63  /// Only one is supported for each token.
64  HD_API
65  void SetTaskContextData(const TfToken &id, const VtValue &data);
66 
67  /// If found, will return the value from the task context data associated
68  /// with the token. Returns false if the data could not be found.
69  HD_API
70  bool GetTaskContextData(const TfToken &id, VtValue *data) const;
71 
72  /// Removes the specified token.
73  HD_API
74  void RemoveTaskContextData(const TfToken &id);
75 
76  /// @}
77 
78  /// Execute tasks.
79  HD_API
81  HdTaskSharedPtrVector *tasks);
82 
83  HD_API
84  void ReloadAllShaders(HdRenderIndex& index);
85 
86 
87 private:
88  /// Context containing token-value pairs, that is passed to each
89  /// task in the render graph. The task-context can be pre-populated
90  /// and managed externally, so the state is persistent between runs of the
91  /// render graph.
92  HdTaskContext _taskContext;
93 };
94 
95 
97 
98 #endif //PXR_IMAGING_HD_ENGINE_H
std::shared_ptr< class HdRenderPassState > HdRenderPassStateSharedPtr
Definition: engine.h:42
std::shared_ptr< class HdRenderPass > HdRenderPassSharedPtr
Definition: engine.h:41
GLuint index
Definition: glew.h:1814
#define HD_API
Definition: api.h:40
std::vector< HdTaskSharedPtr > HdTaskSharedPtrVector
Definition: renderIndex.h:70
HD_API bool GetTaskContextData(const TfToken &id, VtValue *data) const
HD_API void RemoveTaskContextData(const TfToken &id)
Removes the specified token.
Definition: token.h:87
GLint GLenum GLsizei GLint GLsizei const void * data
Definition: glew.h:1379
HD_API void Execute(HdRenderIndex *index, HdTaskSharedPtrVector *tasks)
Execute tasks.
HD_API void ReloadAllShaders(HdRenderIndex &index)
std::unordered_map< TfToken, VtValue, TfToken::HashFunctor > HdTaskContext
Definition: renderIndex.h:73
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
virtual HD_API ~HdEngine()
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HD_API void SetTaskContextData(const TfToken &id, const VtValue &data)
HD_API HdEngine()
Definition: value.h:174