engine.h File Reference

Include dependency graph for engine.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	UsdImagingGLEngine
	The UsdImagingGLEngine is the main entry point API for rendering USD scenes. More...
struct	UsdImagingGLEngine::Parameters
	Parameters to construct UsdImagingGLEngine. More...

Typedefs
using	UsdStageWeakPtr = TfWeakPtr< class UsdStage >
using	_AppSceneIndicesSharedPtr = std::shared_ptr< struct _AppSceneIndices >

Functions
	TF_DECLARE_WEAK_AND_REF_PTRS (GlfSimpleLightingContext)
	TF_DECLARE_REF_PTRS (UsdImagingStageSceneIndex)
	TF_DECLARE_REF_PTRS (UsdImagingRootOverridesSceneIndex)
	TF_DECLARE_REF_PTRS (UsdImagingSelectionSceneIndex)
	TF_DECLARE_REF_PTRS (HdsiLegacyDisplayStyleOverrideSceneIndex)
	TF_DECLARE_REF_PTRS (HdsiPrimTypePruningSceneIndex)
	TF_DECLARE_REF_PTRS (HdsiSceneGlobalsSceneIndex)
	TF_DECLARE_REF_PTRS (HdSceneIndexBase)

---

Class Documentation

UsdImagingGLEngine::Parameters

struct UsdImagingGLEngine::Parameters

Parameters to construct UsdImagingGLEngine.

Definition at line 99 of file engine.h.

Class Members
bool	allowAsynchronousSceneProcessing = false	allowAsynchronousSceneProcessing indicates to constructed hydra scene indices that asynchronous processing is allowow. Applications should perodically call PollForAsynchronousUpdates on the engine.
bool	displayUnloadedPrimsWithBounds = false	displayUnloadedPrimsWithBounds draws bounding boxes for unloaded prims if they have extents/extentsHint authored.
HdDriver	driver	An HdDriver, containing the Hgi of your choice, can be optionally passed in during construction. This can be helpful if your application creates multiple UsdImagingGLEngine's that wish to use the same HdDriver / Hgi.
SdfPathVector	excludedPaths
bool	gpuEnabled = true	The gpuEnabled argument determines if this instance will allow Hydra to use the GPU to produce images.
SdfPathVector	invisedPaths
TfToken	rendererPluginId	The rendererPluginId argument indicates the renderer plugin that Hydra should use. If the empty token is passed in, a default renderer plugin will be chosen depending on the value of gpuEnabled.
SdfPath	rootPath = SdfPath::AbsoluteRootPath()
SdfPath	sceneDelegateID = SdfPath::AbsoluteRootPath()

Typedef Documentation

_AppSceneIndicesSharedPtr

using _AppSceneIndicesSharedPtr = std::shared_ptr<struct _AppSceneIndices>

Definition at line 88 of file engine.h.

UsdStageWeakPtr

using UsdStageWeakPtr = TfWeakPtr<class UsdStage>

Definition at line 84 of file engine.h.