Loading...
Searching...
No Matches
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 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
35PXR_NAMESPACE_OPEN_SCOPE
36
37class HdRenderIndex;
38class HdRenderDelegate;
40
41using HdRenderPassSharedPtr = std::shared_ptr<class HdRenderPass>;
42using HdRenderPassStateSharedPtr = std::shared_ptr<class HdRenderPassState>;
43
48class HdEngine {
49public:
50 HD_API
51 HdEngine();
52 HD_API
53 virtual ~HdEngine();
54
61
64 HD_API
65 void SetTaskContextData(const TfToken &id, const VtValue &data);
66
69 HD_API
70 bool GetTaskContextData(const TfToken &id, VtValue *data) const;
71
73 HD_API
75
77 HD_API
79
81
83 HD_API
85 HdTaskSharedPtrVector *tasks);
86
87
88private:
93 HdTaskContext _taskContext;
94};
95
96
97PXR_NAMESPACE_CLOSE_SCOPE
98
99#endif //PXR_IMAGING_HD_ENGINE_H
The application-facing entry point top-level entry point for accessing Hydra.
Definition: engine.h:48
HD_API void Execute(HdRenderIndex *index, HdTaskSharedPtrVector *tasks)
Execute tasks.
HD_API void ClearTaskContextData()
Removes all keys.
HD_API bool GetTaskContextData(const TfToken &id, VtValue *data) const
If found, will return the value from the task context data associated with the token.
HD_API void SetTaskContextData(const TfToken &id, const VtValue &data)
Adds or updates the value associated with the token.
HD_API void RemoveTaskContextData(const TfToken &id)
Removes the specified token.
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:121
A central registry for resources.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:165