|
HDK
|
#include <engine.h>
Classes | |
| struct | Parameters |
| Parameters to construct UsdImagingGLEngine. More... | |
Static Public Member Functions | |
| static USDIMAGINGGL_API bool | IsColorCorrectionCapable () |
| Returns true if the platform is color correction capable. More... | |
Protected Types | |
| using | BBoxVector = std::vector< GfBBox3d > |
Static Protected Member Functions | |
| static USDIMAGINGGL_API bool | _UpdateHydraCollection (HdRprimCollection *collection, SdfPathVector const &roots, UsdImagingGLRenderParams const ¶ms) |
| static USDIMAGINGGL_API HdxRenderTaskParams | _MakeHydraUsdImagingGLRenderParams (UsdImagingGLRenderParams const ¶ms) |
| static USDIMAGINGGL_API void | _ComputeRenderTags (UsdImagingGLRenderParams const ¶ms, TfTokenVector *renderTags) |
| static USDIMAGINGGL_API TfToken | _GetDefaultRendererPluginId () |
Protected Attributes | |
| HgiUniquePtr | _hgi |
| HdDriver | _hgiDriver |
| VtValue | _userFramebuffer |
| bool | _displayUnloadedPrimsWithBounds |
| bool | _gpuEnabled |
| HdPluginRenderDelegateUniqueHandle | _renderDelegate |
| std::unique_ptr< HdRenderIndex > | _renderIndex |
| SdfPath const | _sceneDelegateId |
| std::unique_ptr < HdxTaskController > | _taskController |
| HdxSelectionTrackerSharedPtr | _selTracker |
| HdRprimCollection | _renderCollection |
| HdRprimCollection | _intersectCollection |
| GlfSimpleLightingContextRefPtr | _lightingContextForOpenGLState |
| GfVec4f | _selectionColor |
| bool | _domeLightCameraVisibility |
| SdfPath | _rootPath |
| SdfPathVector | _excludedPrimPaths |
| SdfPathVector | _invisedPrimPaths |
| bool | _isPopulated |
Friends | |
| class | UsdImagingGL_UnitTestGLDrawing |
| Open some protected methods for whitebox testing. More... | |
Renderer Plugin Management | |
| USDIMAGINGGL_API bool | GetGPUEnabled () const |
| Return if the GPU is enabled and can be used for any rendering tasks. More... | |
| USDIMAGINGGL_API TfToken | GetCurrentRendererId () const |
| Return the id of the currently used renderer plugin. More... | |
| USDIMAGINGGL_API bool | SetRendererPlugin (TfToken const &id) |
| static USDIMAGINGGL_API TfTokenVector | GetRendererPlugins () |
| Return the vector of available render-graph delegate plugins. More... | |
| static USDIMAGINGGL_API std::string | GetRendererDisplayName (TfToken const &id) |
| Return the user-friendly description of a renderer plugin. More... | |
Render Settings (Scene description driven) | |
| |
| USDIMAGINGGL_API void | SetActiveRenderSettingsPrimPath (SdfPath const &) |
| Set active render settings prim to use to drive rendering. More... | |
| static USDIMAGINGGL_API SdfPathVector | GetAvailableRenderSettingsPrimPaths (UsdPrim const &root) |
| Utility method to query available render settings prims. More... | |
The UsdImagingGLEngine is the main entry point API for rendering USD scenes.
|
protected |
| USDIMAGINGGL_API UsdImagingGLEngine::UsdImagingGLEngine | ( | const Parameters & | params | ) |
An HdDriver, containing the Hgi of your choice, can be optionally passed in during construction. This can be helpful if you application creates multiple UsdImagingGLEngine that wish to use the same HdDriver / Hgi. The rendererPluginId argument indicates the renderer plugin that Hyrda should use. If the empty token is passed in, a default renderer plugin will be chosen depending on the value of gpuEnabled. The gpuEnabled argument determines if this instance will allow Hydra to use the GPU to produce images.
| USDIMAGINGGL_API UsdImagingGLEngine::UsdImagingGLEngine | ( | const HdDriver & | driver = HdDriver(), |
| const TfToken & | rendererPluginId = TfToken(), |
||
| bool | gpuEnabled = true |
||
| ) |
An HdDriver, containing the Hgi of your choice, can be optionally passed in during construction. This can be helpful if you application creates multiple UsdImagingGLEngine that wish to use the same HdDriver / Hgi. The rendererPluginId argument indicates the renderer plugin that Hyrda should use. If the empty token is passed in, a default renderer plugin will be chosen depending on the value of gpuEnabled. The gpuEnabled argument determines if this instance will allow Hydra to use the GPU to produce images.
| USDIMAGINGGL_API UsdImagingGLEngine::UsdImagingGLEngine | ( | const SdfPath & | rootPath, |
| const SdfPathVector & | excludedPaths, | ||
| const SdfPathVector & | invisedPaths = SdfPathVector(), |
||
| const SdfPath & | sceneDelegateID = SdfPath::AbsoluteRootPath(), |
||
| const HdDriver & | driver = HdDriver(), |
||
| const TfToken & | rendererPluginId = TfToken(), |
||
| bool | gpuEnabled = true, |
||
| bool | displayUnloadedPrimsWithBounds = false |
||
| ) |
An HdDriver, containing the Hgi of your choice, can be optionally passed in during construction. This can be helpful if you application creates multiple UsdImagingGLEngine that wish to use the same HdDriver / Hgi. The rendererPluginId argument indicates the renderer plugin that Hyrda should use. If the empty token is passed in, a default renderer plugin will be chosen depending on the value of gpuEnabled. The gpuEnabled argument determines if this instance will allow Hydra to use the GPU to produce images.
|
delete |
An HdDriver, containing the Hgi of your choice, can be optionally passed in during construction. This can be helpful if you application creates multiple UsdImagingGLEngine that wish to use the same HdDriver / Hgi. The rendererPluginId argument indicates the renderer plugin that Hyrda should use. If the empty token is passed in, a default renderer plugin will be chosen depending on the value of gpuEnabled. The gpuEnabled argument determines if this instance will allow Hydra to use the GPU to produce images.
| USDIMAGINGGL_API UsdImagingGLEngine::~UsdImagingGLEngine | ( | ) |
An HdDriver, containing the Hgi of your choice, can be optionally passed in during construction. This can be helpful if you application creates multiple UsdImagingGLEngine that wish to use the same HdDriver / Hgi. The rendererPluginId argument indicates the renderer plugin that Hyrda should use. If the empty token is passed in, a default renderer plugin will be chosen depending on the value of gpuEnabled. The gpuEnabled argument determines if this instance will allow Hydra to use the GPU to produce images.
|
protected |
|
protected |
|
staticprotected |
|
protected |
|
staticprotected |
|
protected |
|
protected |
Returns the render index of the engine, if any. This is only used for whitebox testing.
|
protected |
Get a direct pointer to the scene delegate.
|
protected |
|
protected |
|
protected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
staticprotected |
| USDIMAGINGGL_API void UsdImagingGLEngine::AddSelected | ( | SdfPath const & | path, |
| int | instanceIndex | ||
| ) |
Add a path with instanceIndex to the list of prim paths that should be included in selection highlighting. UsdImagingDelegate::ALL_INSTANCES can be used for highlighting all instances if path is an instancer.
| USDIMAGINGGL_API void UsdImagingGLEngine::ClearSelected | ( | ) |
Clear the list of prim paths that should be included in selection highlighting.
| USDIMAGINGGL_API bool UsdImagingGLEngine::DecodeIntersection | ( | unsigned char const | primIdColor[4], |
| unsigned char const | instanceIdColor[4], | ||
| SdfPath * | outHitPrimPath = NULL, |
||
| SdfPath * | outHitInstancerPath = NULL, |
||
| int * | outHitInstanceIndex = NULL, |
||
| HdInstancerContext * | outInstancerContext = NULL |
||
| ) |
Decodes a pick result given hydra prim ID/instance ID (like you'd get from an ID render).
| USDIMAGINGGL_API HdRenderBuffer* UsdImagingGLEngine::GetAovRenderBuffer | ( | TfToken const & | name | ) | const |
Returns the AOV render buffer for the given token.
| USDIMAGINGGL_API HgiTextureHandle UsdImagingGLEngine::GetAovTexture | ( | TfToken const & | name | ) | const |
Returns an AOV texture handle for the given token.
|
static |
Utility method to query available render settings prims.
| USDIMAGINGGL_API TfToken UsdImagingGLEngine::GetCurrentRendererId | ( | ) | const |
Return the id of the currently used renderer plugin.
| USDIMAGINGGL_API bool UsdImagingGLEngine::GetGPUEnabled | ( | ) | const |
Return if the GPU is enabled and can be used for any rendering tasks.
| USDIMAGINGGL_API Hgi* UsdImagingGLEngine::GetHgi | ( | ) |
Returns the HGI interface.
| USDIMAGINGGL_API TfTokenVector UsdImagingGLEngine::GetRendererAovs | ( | ) | const |
Return the vector of available renderer AOV settings.
| USDIMAGINGGL_API HdCommandDescriptors UsdImagingGLEngine::GetRendererCommandDescriptors | ( | ) | const |
Return command deescriptors for commands supported by the active render delegate.
|
static |
Return the user-friendly description of a renderer plugin.
|
static |
Return the vector of available render-graph delegate plugins.
| USDIMAGINGGL_API VtValue UsdImagingGLEngine::GetRendererSetting | ( | TfToken const & | id | ) | const |
Gets a renderer setting's current value.
| USDIMAGINGGL_API UsdImagingGLRendererSettingsList UsdImagingGLEngine::GetRendererSettingsList | ( | ) | const |
Returns the list of renderer settings.
| USDIMAGINGGL_API VtDictionary UsdImagingGLEngine::GetRenderStats | ( | ) | const |
Returns render statistics.
The contents of the dictionary will depend on the current render delegate.
| USDIMAGINGGL_API bool UsdImagingGLEngine::InvokeRendererCommand | ( | const TfToken & | command, |
| const HdCommandArgs & | args = HdCommandArgs() |
||
| ) | const |
Invokes command on the active render delegate. If successful, returns true, returns false otherwise. Note that the command will not succeeed if it is not among those returned by GetRendererCommandDescriptors() for the same active render delegate.
|
static |
Returns true if the platform is color correction capable.
| USDIMAGINGGL_API bool UsdImagingGLEngine::IsConverged | ( | ) | const |
Returns true if the resulting image is fully converged. (otherwise, caller may need to call Render() again to refine the result)
| USDIMAGINGGL_API bool UsdImagingGLEngine::IsPauseRendererSupported | ( | ) | const |
Query the renderer as to whether it supports pausing and resuming.
| USDIMAGINGGL_API bool UsdImagingGLEngine::IsStopRendererSupported | ( | ) | const |
Query the renderer as to whether it supports stopping and restarting.
|
delete |
An HdDriver, containing the Hgi of your choice, can be optionally passed in during construction. This can be helpful if you application creates multiple UsdImagingGLEngine that wish to use the same HdDriver / Hgi. The rendererPluginId argument indicates the renderer plugin that Hyrda should use. If the empty token is passed in, a default renderer plugin will be chosen depending on the value of gpuEnabled. The gpuEnabled argument determines if this instance will allow Hydra to use the GPU to produce images.
| USDIMAGINGGL_API bool UsdImagingGLEngine::PauseRenderer | ( | ) |
Pause the renderer.
Returns true if successful.
| USDIMAGINGGL_API void UsdImagingGLEngine::PrepareBatch | ( | const UsdPrim & | root, |
| const UsdImagingGLRenderParams & | params | ||
| ) |
Support for batched drawing.
| USDIMAGINGGL_API void UsdImagingGLEngine::Render | ( | const UsdPrim & | root, |
| const UsdImagingGLRenderParams & | params | ||
| ) |
Entry point for kicking off a render.
| USDIMAGINGGL_API void UsdImagingGLEngine::RenderBatch | ( | const SdfPathVector & | paths, |
| const UsdImagingGLRenderParams & | params | ||
| ) |
Support for batched drawing.
| USDIMAGINGGL_API bool UsdImagingGLEngine::RestartRenderer | ( | ) |
Restart the renderer.
Returns true if successful.
| USDIMAGINGGL_API bool UsdImagingGLEngine::ResumeRenderer | ( | ) |
Resume the renderer.
Returns true if successful.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetActiveRenderSettingsPrimPath | ( | SdfPath const & | ) |
Set active render settings prim to use to drive rendering.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetCameraPath | ( | SdfPath const & | id | ) |
Scene camera API Set the scene camera path to use for rendering.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetCameraState | ( | const GfMatrix4d & | viewMatrix, |
| const GfMatrix4d & | projectionMatrix | ||
| ) |
Free camera API Set camera framing state directly (without pointing to a camera on the USD stage). The projection matrix is expected to be pre-adjusted for the window policy.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetColorCorrectionSettings | ( | TfToken const & | ccType, |
| TfToken const & | ocioDisplay = {}, |
||
| TfToken const & | ocioView = {}, |
||
| TfToken const & | ocioColorSpace = {}, |
||
| TfToken const & | ocioLook = {} |
||
| ) |
Set ccType to one of the HdxColorCorrectionTokens: {disabled, sRGB, openColorIO}
If 'openColorIO' is used, ocioDisplay, ocioView, ocioColorSpace and ocioLook are options the client may supply to configure OCIO. ocioColorSpace refers to the input (source) color space. The default value is substituted if an option isn't specified. You can find the values for these strings inside the profile/config .ocio file. For example:
displays: rec709g22: !<View> {name: studio, colorspace: linear, looks: studio_65_lg2}
| USDIMAGINGGL_API void UsdImagingGLEngine::SetEnablePresentation | ( | bool | enabled | ) |
Enable / disable presenting the render to bound framebuffer. An application may choose to manage the AOVs that are rendered into itself and skip the engine's presentation.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetFraming | ( | CameraUtilFraming const & | framing | ) |
Determines how the filmback of the camera is mapped into the pixels of the render buffer and what pixels of the render buffer will be rendered into.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetLightingState | ( | GlfSimpleLightingContextPtr const & | src | ) |
Copy lighting state from another lighting context.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetLightingState | ( | GlfSimpleLightVector const & | lights, |
| GlfSimpleMaterial const & | material, | ||
| GfVec4f const & | sceneAmbient | ||
| ) |
Set lighting state Derived classes should ensure that passing an empty lights vector disables lighting.
| lights | is the set of lights to use, or empty to disable lighting. |
| USDIMAGINGGL_API void UsdImagingGLEngine::SetOverrideWindowPolicy | ( | const std::pair< bool, CameraUtilConformWindowPolicy > & | policy | ) |
Specifies whether to force a window policy when conforming the frustum of the camera to match the display window of the camera framing.
If set to {false, ...}, the window policy of the specified camera will be used.
Note: std::pair<bool, ...> is used instead of std::optional<...> because the latter is only available in C++17 or later.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetPresentationOutput | ( | TfToken const & | api, |
| VtValue const & | framebuffer | ||
| ) |
The destination API (e.g., OpenGL, see hgiInterop for details) and framebuffer that the AOVs are presented into. The framebuffer is a VtValue that encoding a framebuffer in a destination API specific way. E.g., a uint32_t (aka GLuint) for framebuffer object for OpenGL.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetRenderBufferSize | ( | GfVec2i const & | size | ) |
Set the size of the render buffers baking the AOVs. GUI applications should set this to the size of the window.
| USDIMAGINGGL_API bool UsdImagingGLEngine::SetRendererAov | ( | TfToken const & | id | ) |
Set the current renderer AOV to id.
| USDIMAGINGGL_API bool UsdImagingGLEngine::SetRendererPlugin | ( | TfToken const & | id | ) |
Set the current render-graph delegate to id. the plugin will be loaded if it's not yet.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetRendererSetting | ( | TfToken const & | id, |
| VtValue const & | value | ||
| ) |
Sets a renderer setting's value.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetRenderViewport | ( | GfVec4d const & | viewport | ) |
Set the viewport to use for rendering as (x,y,w,h), where (x,y) represents the lower left corner of the viewport rectangle, and (w,h) is the width and height of the viewport in pixels.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetRootTransform | ( | GfMatrix4d const & | xf | ) |
Sets the root transform.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetRootVisibility | ( | bool | isVisible | ) |
Sets the root visibility.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetSelected | ( | SdfPathVector const & | paths | ) |
Sets (replaces) the list of prim paths that should be included in selection highlighting. These paths may include root paths which will be expanded internally.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetSelectionColor | ( | GfVec4f const & | color | ) |
Sets the selection highlighting color.
| USDIMAGINGGL_API void UsdImagingGLEngine::SetWindowPolicy | ( | CameraUtilConformWindowPolicy | policy | ) |
Set the window policy to use. XXX: This is currently used for scene cameras set via SetCameraPath. See comment in SetCameraState for the free cam.
| USDIMAGINGGL_API bool UsdImagingGLEngine::StopRenderer | ( | ) |
Stop the renderer.
Returns true if successful.
| USDIMAGINGGL_API bool UsdImagingGLEngine::TestIntersection | ( | const GfMatrix4d & | viewMatrix, |
| const GfMatrix4d & | projectionMatrix, | ||
| const UsdPrim & | root, | ||
| const UsdImagingGLRenderParams & | params, | ||
| GfVec3d * | outHitPoint, | ||
| GfVec3d * | outHitNormal, | ||
| SdfPath * | outHitPrimPath = NULL, |
||
| SdfPath * | outHitInstancerPath = NULL, |
||
| int * | outHitInstanceIndex = NULL, |
||
| HdInstancerContext * | outInstancerContext = NULL |
||
| ) |
Finds closest point of intersection with a frustum by rendering.
This method uses a PickRender and a customized depth buffer to find an approximate point of intersection by rendering. This is less accurate than implicit methods or rendering with GL_SELECT, but leverages any data already cached in the renderer.
Returns whether a hit occurred and if so, outHitPoint will contain the intersection point in world space (i.e. projectionMatrix and viewMatrix factored back out of the result), and outHitNormal will contain the world space normal at that point.
outHitPrimPath will point to the gprim selected by the pick. outHitInstancerPath will point to the point instancer (if applicable) of that gprim. For nested instancing, outHitInstancerPath points to the closest instancer.
|
friend |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
1.8.6 
