HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Attributes | List of all members
UsdImagingGLEngine::Parameters Struct Reference

Parameters to construct UsdImagingGLEngine. More...

#include <engine.h>

Public Attributes

SdfPath rootPath = SdfPath::AbsoluteRootPath()
 
SdfPathVector excludedPaths
 
SdfPathVector invisedPaths
 
SdfPath sceneDelegateID = SdfPath::AbsoluteRootPath()
 
HdDriver driver
 
TfToken rendererPluginId
 
bool gpuEnabled = true
 
bool displayUnloadedPrimsWithBounds = false
 
bool allowAsynchronousSceneProcessing = false
 

Detailed Description

Parameters to construct UsdImagingGLEngine.

Definition at line 99 of file engine.h.

Member Data Documentation

bool UsdImagingGLEngine::Parameters::allowAsynchronousSceneProcessing = false

allowAsynchronousSceneProcessing indicates to constructed hydra scene indices that asynchronous processing is allowow. Applications should perodically call PollForAsynchronousUpdates on the engine.

Definition at line 122 of file engine.h.

bool UsdImagingGLEngine::Parameters::displayUnloadedPrimsWithBounds = false

displayUnloadedPrimsWithBounds draws bounding boxes for unloaded prims if they have extents/extentsHint authored.

Definition at line 118 of file engine.h.

HdDriver UsdImagingGLEngine::Parameters::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.

Definition at line 108 of file engine.h.

SdfPathVector UsdImagingGLEngine::Parameters::excludedPaths

Definition at line 102 of file engine.h.

bool UsdImagingGLEngine::Parameters::gpuEnabled = true

The gpuEnabled argument determines if this instance will allow Hydra to use the GPU to produce images.

Definition at line 115 of file engine.h.

SdfPathVector UsdImagingGLEngine::Parameters::invisedPaths

Definition at line 103 of file engine.h.

TfToken UsdImagingGLEngine::Parameters::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.

Definition at line 112 of file engine.h.

SdfPath UsdImagingGLEngine::Parameters::rootPath = SdfPath::AbsoluteRootPath()

Definition at line 101 of file engine.h.

SdfPath UsdImagingGLEngine::Parameters::sceneDelegateID = SdfPath::AbsoluteRootPath()

Definition at line 104 of file engine.h.

The documentation for this struct was generated from the following file: