All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
renderParam.h
1 //
2 // Copyright 2017 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 HDEMBREE_RENDER_PARAM_H
25 #define HDEMBREE_RENDER_PARAM_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/renderDelegate.h"
29 #include "pxr/imaging/hd/renderThread.h"
30 
31 #include <embree2/rtcore.h>
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
42 class HdEmbreeRenderParam final : public HdRenderParam {
43 public:
44  HdEmbreeRenderParam(RTCDevice device, RTCScene scene,
45  HdRenderThread *renderThread,
46  std::atomic<int> *sceneVersion)
47  : _scene(scene), _device(device)
48  , _renderThread(renderThread), _sceneVersion(sceneVersion)
49  {}
50  virtual ~HdEmbreeRenderParam() = default;
51 
53  RTCScene AcquireSceneForEdit() {
54  _renderThread->StopRender();
55  (*_sceneVersion)++;
56  return _scene;
57  }
59  RTCDevice GetEmbreeDevice() { return _device; }
60 
61 private:
63  RTCScene _scene;
65  RTCDevice _device;
67  HdRenderThread *_renderThread;
69  std::atomic<int> *_sceneVersion;
70 };
71 
72 PXR_NAMESPACE_CLOSE_SCOPE
73 
74 #endif // HDEMBREE_RENDER_PARAM_H
The render delegate can create an object of type HdRenderParam, to pass to each prim during Sync()...
Definition: renderParam.h:42
RTCDevice GetEmbreeDevice()
Accessor for the top-level embree device (library handle).
Definition: renderParam.h:59
The HdRenderParam is an opaque (to core Hydra) handle, to an object that is obtained from the render ...
RTCScene AcquireSceneForEdit()
Accessor for the top-level embree scene.
Definition: renderParam.h:53
HD_API void StopRender()
Ask the render thread to stop rendering, and block until the render thread is idle.
HdRenderThread is a utility that specific render delegates can choose to use depending on their needs...
Definition: renderThread.h:146