|
A set of rendering parameters used among render passes. More...
#include <renderPassState.h>
Public Member Functions | |
virtual HD_API void | Prepare (HdResourceRegistrySharedPtr const &resourceRegistry) |
Schedule to update renderPassState parameters. | |
Application rendering state | |
HD_API void | SetOverrideColor (GfVec4f const &color) |
Set an override color for rendering where the R, G and B components are the color and the alpha component is the blend value. | |
const GfVec4f & | GetOverrideColor () const |
HD_API void | SetWireframeColor (GfVec4f const &color) |
Set a wireframe color for rendering where the R, G and B components are the color and the alpha component is the blend value. | |
const GfVec4f & | GetWireframeColor () const |
HD_API void | SetMaskColor (GfVec4f const &color) |
const GfVec4f & | GetMaskColor () const |
HD_API void | SetIndicatorColor (GfVec4f const &color) |
const GfVec4f & | GetIndicatorColor () const |
HD_API void | SetPointColor (GfVec4f const &color) |
Set a point color for rendering where the R, G and B components are the color and the alpha component is the blend value. | |
const GfVec4f & | GetPointColor () const |
HD_API void | SetPointSize (float size) |
Set the point size for unselected points. | |
float | GetPointSize () const |
HD_API void | SetPointSelectedSize (float size) |
Set the point size for selected points. | |
float | GetPointSelectedSize () const |
HD_API void | SetLightingEnabled (bool enabled) |
XXX: Hacky way of disabling lighting. | |
bool | GetLightingEnabled () const |
HD_API void | SetClippingEnabled (bool enabled) |
bool | GetClippingEnabled () const |
Render pipeline state | |
enum | ColorMask { ColorMaskNone , ColorMaskRGB , ColorMaskRGBA } |
HdCamera const * | _camera |
GfVec4f | _viewport |
CameraUtilFraming | _framing |
std::optional< CameraUtilConformWindowPolicy > | _overrideWindowPolicy |
GfVec4f | _overrideColor |
GfVec4f | _wireframeColor |
GfVec4f | _pointColor |
float | _pointSize |
bool | _lightingEnabled |
bool | _clippingEnabled |
GfVec4f | _maskColor |
GfVec4f | _indicatorColor |
float | _pointSelectedSize |
float | _alphaThreshold |
float | _tessLevel |
GfVec2f | _drawRange |
bool | _depthBiasUseDefault |
bool | _depthBiasEnabled |
float | _depthBiasConstantFactor |
float | _depthBiasSlopeFactor |
HdCompareFunction | _depthFunc |
bool | _depthMaskEnabled |
bool | _depthTestEnabled |
bool | _depthClampEnabled |
GfVec2f | _depthRange |
HdCullStyle | _cullStyle |
HdCompareFunction | _stencilFunc |
int | _stencilRef |
int | _stencilMask |
HdStencilOp | _stencilFailOp |
HdStencilOp | _stencilZFailOp |
HdStencilOp | _stencilZPassOp |
bool | _stencilEnabled |
float | _lineWidth |
HdBlendOp | _blendColorOp |
HdBlendFactor | _blendColorSrcFactor |
HdBlendFactor | _blendColorDstFactor |
HdBlendOp | _blendAlphaOp |
HdBlendFactor | _blendAlphaSrcFactor |
HdBlendFactor | _blendAlphaDstFactor |
GfVec4f | _blendConstantColor |
bool | _blendEnabled |
bool | _alphaToCoverageEnabled |
bool | _colorMaskUseDefault |
std::vector< ColorMask > | _colorMasks |
HdRenderPassAovBindingVector | _aovBindings |
HdRenderPassAovBindingVector | _aovInputBindings |
bool | _useMultiSampleAov |
bool | _conservativeRasterizationEnabled |
float | _stepSize |
float | _stepSizeLighting |
bool | _multiSampleEnabled |
HD_API void | SetAovBindings (HdRenderPassAovBindingVector const &aovBindings) |
Set the attachments for this renderpass to render into. | |
HD_API HdRenderPassAovBindingVector const & | GetAovBindings () const |
HD_API void | SetAovInputBindings (HdRenderPassAovBindingVector const &aovBindings) |
Set the AOVs that this renderpass needs to read from. | |
HD_API HdRenderPassAovBindingVector const & | GetAovInputBindings () const |
HD_API void | SetUseAovMultiSample (bool state) |
Returns true if the render pass wants to render into the multi-sample aovs. | |
HD_API bool | GetUseAovMultiSample () const |
HD_API void | SetCullStyle (HdCullStyle cullStyle) |
HD_API HdCullStyle | GetCullStyle () const |
HD_API void | SetAlphaThreshold (float alphaThreshold) |
float | GetAlphaThreshold () const |
HD_API void | SetTessLevel (float level) |
float | GetTessLevel () const |
HD_API void | SetDrawingRange (GfVec2f const &drawRange) |
GfVec2f | GetDrawingRange () const |
HD_API GfVec2f | GetDrawingRangeNDC () const |
HD_API void | SetDepthBiasUseDefault (bool useDefault) |
bool | GetDepthBiasUseDefault () const |
HD_API void | SetDepthBiasEnabled (bool enabled) |
bool | GetDepthBiasEnabled () const |
HD_API void | SetDepthBias (float constantFactor, float slopeFactor) |
HD_API void | SetDepthFunc (HdCompareFunction depthFunc) |
HdCompareFunction | GetDepthFunc () const |
HD_API void | SetEnableDepthMask (bool state) |
HD_API bool | GetEnableDepthMask () const |
HD_API void | SetEnableDepthTest (bool enabled) |
HD_API bool | GetEnableDepthTest () const |
HD_API void | SetEnableDepthClamp (bool enabled) |
HD_API bool | GetEnableDepthClamp () const |
HD_API void | SetDepthRange (GfVec2f const &depthRange) |
HD_API const GfVec2f & | GetDepthRange () const |
HD_API void | SetStencil (HdCompareFunction func, int ref, int mask, HdStencilOp fail, HdStencilOp zfail, HdStencilOp zpass) |
HdCompareFunction | GetStencilFunc () const |
int | GetStencilRef () const |
int | GetStencilMask () const |
HdStencilOp | GetStencilFailOp () const |
HdStencilOp | GetStencilDepthFailOp () const |
HdStencilOp | GetStencilDepthPassOp () const |
HD_API void | SetStencilEnabled (bool enabled) |
HD_API bool | GetStencilEnabled () const |
HD_API void | SetLineWidth (float width) |
float | GetLineWidth () const |
HD_API void | SetBlend (HdBlendOp colorOp, HdBlendFactor colorSrcFactor, HdBlendFactor colorDstFactor, HdBlendOp alphaOp, HdBlendFactor alphaSrcFactor, HdBlendFactor alphaDstFactor) |
HdBlendOp | GetBlendColorOp () |
HdBlendFactor | GetBlendColorSrcFactor () |
HdBlendFactor | GetBlendColorDstFactor () |
HdBlendOp | GetBlendAlphaOp () |
HdBlendFactor | GetBlendAlphaSrcFactor () |
HdBlendFactor | GetBlendAlphaDstFactor () |
HD_API void | SetBlendConstantColor (GfVec4f const &color) |
const GfVec4f & | GetBlendConstantColor () const |
HD_API void | SetBlendEnabled (bool enabled) |
HD_API void | SetAlphaToCoverageEnabled (bool enabled) |
bool | GetAlphaToCoverageEnabled () const |
HD_API void | SetColorMaskUseDefault (bool useDefault) |
bool | GetColorMaskUseDefault () const |
HD_API void | SetConservativeRasterizationEnabled (bool enabled) |
bool | GetConservativeRasterizationEnabled () const |
HD_API void | SetVolumeRenderingConstants (float stepSize, float stepSizeLighting) |
HD_API void | SetColorMasks (std::vector< ColorMask > const &masks) |
std::vector< ColorMask > const & | GetColorMasks () const |
HD_API void | SetMultiSampleEnabled (bool enabled) |
bool | GetMultiSampleEnabled () const |
Camera and framing state | |
using | ClipPlanesVector = std::vector< GfVec4d > |
HD_API void | SetCamera (const HdCamera *camera) |
Sets the camera. | |
HD_API void | SetOverrideWindowPolicy (const std::optional< CameraUtilConformWindowPolicy > &overrideWindowPolicy) |
Sets whether to override the window policy used to conform the camera if its aspect ratio is not matching the display window/viewport. | |
HD_API void | SetFraming (const CameraUtilFraming &framing) |
Sets the framing to show the camera. | |
HD_API void | SetViewport (const GfVec4d &viewport) |
Sets the viewport to show the camera. | |
HdCamera const * | GetCamera () const |
Get camera. | |
const CameraUtilFraming & | GetFraming () const |
Get framing information determining how the filmback plane maps to pixels. | |
const std::optional< CameraUtilConformWindowPolicy > & | GetOverrideWindowPolicy () const |
The override value for the window policy to conform the camera frustum that can be specified by the application. | |
HD_API CameraUtilConformWindowPolicy | GetWindowPolicy () const |
The resolved window policy to conform the camera frustum. | |
virtual HD_API GfMatrix4d | GetWorldToViewMatrix () const |
Camera getter API. | |
virtual HD_API GfMatrix4d | GetProjectionMatrix () const |
Compute projection matrix using physical attributes of an HdCamera. | |
GfVec4f const & | GetViewport () const |
Only use when clients did not specify a camera framing. | |
HD_API GfMatrix4d | GetImageToWorldMatrix () const |
Compute a transform from window relative coordinates (x,y,z,1) to homogeneous world coordinates (x,y,z,w), using the HdCamera's attributes, framing, and viewport dimensions. | |
virtual HD_API ClipPlanesVector const & | GetClipPlanes () const |
Returns HdCamera's clip planes. | |
A set of rendering parameters used among render passes.
Parameters are expressed as GL states, uniforms or shaders.
Definition at line 62 of file renderPassState.h.
using ClipPlanesVector = std::vector<GfVec4d> |
Definition at line 81 of file renderPassState.h.
enum ColorMask |
Definition at line 338 of file renderPassState.h.
|
inline |
Definition at line 237 of file renderPassState.h.
|
inline |
Definition at line 323 of file renderPassState.h.
|
inline |
Definition at line 314 of file renderPassState.h.
|
inline |
Definition at line 312 of file renderPassState.h.
|
inline |
Definition at line 313 of file renderPassState.h.
|
inline |
Definition at line 311 of file renderPassState.h.
|
inline |
Definition at line 309 of file renderPassState.h.
|
inline |
Definition at line 310 of file renderPassState.h.
|
inline |
Definition at line 317 of file renderPassState.h.
|
inline |
Get camera.
Definition at line 110 of file renderPassState.h.
|
inline |
Definition at line 205 of file renderPassState.h.
|
virtual |
Returns HdCamera's clip planes.
Reimplemented in HdStRenderPassState.
|
inline |
Definition at line 346 of file renderPassState.h.
|
inline |
Definition at line 327 of file renderPassState.h.
|
inline |
Definition at line 331 of file renderPassState.h.
|
inline |
Definition at line 233 of file renderPassState.h.
|
inline |
Definition at line 255 of file renderPassState.h.
|
inline |
Definition at line 251 of file renderPassState.h.
|
inline |
Definition at line 262 of file renderPassState.h.
|
inline |
Definition at line 245 of file renderPassState.h.
|
inline |
Get framing information determining how the filmback plane maps to pixels.
Definition at line 115 of file renderPassState.h.
HD_API GfMatrix4d GetImageToWorldMatrix | ( | ) | const |
Compute a transform from window relative coordinates (x,y,z,1) to homogeneous world coordinates (x,y,z,w), using the HdCamera's attributes, framing, and viewport dimensions.
|
inline |
Definition at line 180 of file renderPassState.h.
|
inline |
Definition at line 201 of file renderPassState.h.
|
inline |
Definition at line 300 of file renderPassState.h.
|
inline |
Definition at line 176 of file renderPassState.h.
|
inline |
Definition at line 350 of file renderPassState.h.
|
inline |
Definition at line 166 of file renderPassState.h.
|
inline |
The override value for the window policy to conform the camera frustum that can be specified by the application.
Definition at line 120 of file renderPassState.h.
|
inline |
Definition at line 186 of file renderPassState.h.
|
inline |
Definition at line 196 of file renderPassState.h.
|
inline |
Definition at line 191 of file renderPassState.h.
|
virtual |
Compute projection matrix using physical attributes of an HdCamera.
Reimplemented in HdStRenderPassState.
|
inline |
Definition at line 291 of file renderPassState.h.
|
inline |
Definition at line 292 of file renderPassState.h.
|
inline |
Definition at line 290 of file renderPassState.h.
|
inline |
Definition at line 287 of file renderPassState.h.
|
inline |
Definition at line 289 of file renderPassState.h.
|
inline |
Definition at line 288 of file renderPassState.h.
|
inline |
Definition at line 241 of file renderPassState.h.
|
inline |
Only use when clients did not specify a camera framing.
Definition at line 144 of file renderPassState.h.
HD_API CameraUtilConformWindowPolicy GetWindowPolicy | ( | ) | const |
The resolved window policy to conform the camera frustum.
This is either the override value specified by the application or the value from the scene delegate's camera.
|
inline |
Definition at line 172 of file renderPassState.h.
|
virtual |
|
virtual |
Schedule to update renderPassState parameters.
e.g. camera matrix, override color, id blend factor. Prepare, called once per frame after the sync phase, but prior to the commit phase.
Reimplemented in HdStRenderPassState.
HD_API void SetAovBindings | ( | HdRenderPassAovBindingVector const & | aovBindings | ) |
Set the attachments for this renderpass to render into.
HD_API void SetAovInputBindings | ( | HdRenderPassAovBindingVector const & | aovBindings | ) |
Set the AOVs that this renderpass needs to read from.
HD_API void SetCamera | ( | const HdCamera * | camera | ) |
Sets the camera.
HD_API void SetFraming | ( | const CameraUtilFraming & | framing | ) |
Sets the framing to show the camera.
If a valid framing is set, a viewport set earlier with SetViewport will be ignored.
HD_API void SetLightingEnabled | ( | bool | enabled | ) |
XXX: Hacky way of disabling lighting.
HD_API void SetOverrideColor | ( | GfVec4f const & | color | ) |
Set an override color for rendering where the R, G and B components are the color and the alpha component is the blend value.
HD_API void SetOverrideWindowPolicy | ( | const std::optional< CameraUtilConformWindowPolicy > & | overrideWindowPolicy | ) |
Sets whether to override the window policy used to conform the camera if its aspect ratio is not matching the display window/viewport.
If first value is false, the HdCamera's window policy is used.
HD_API void SetPointColor | ( | GfVec4f const & | color | ) |
Set a point color for rendering where the R, G and B components are the color and the alpha component is the blend value.
HD_API void SetPointSelectedSize | ( | float | size | ) |
Set the point size for selected points.
HD_API void SetPointSize | ( | float | size | ) |
Set the point size for unselected points.
HD_API void SetUseAovMultiSample | ( | bool | state | ) |
Returns true if the render pass wants to render into the multi-sample aovs.
Returns false if the render wants to render into the resolve aovs.
HD_API void SetViewport | ( | const GfVec4d & | viewport | ) |
Sets the viewport to show the camera.
If SetViewport is called, any framing set earlier with SetFraming will be ignored.
HD_API void SetWireframeColor | ( | GfVec4f const & | color | ) |
Set a wireframe color for rendering where the R, G and B components are the color and the alpha component is the blend value.
|
protected |
Definition at line 378 of file renderPassState.h.
|
protected |
Definition at line 417 of file renderPassState.h.
|
protected |
Definition at line 422 of file renderPassState.h.
|
protected |
Definition at line 423 of file renderPassState.h.
|
protected |
Definition at line 412 of file renderPassState.h.
|
protected |
Definition at line 410 of file renderPassState.h.
|
protected |
Definition at line 411 of file renderPassState.h.
|
protected |
Definition at line 409 of file renderPassState.h.
|
protected |
Definition at line 407 of file renderPassState.h.
|
protected |
Definition at line 408 of file renderPassState.h.
|
protected |
Definition at line 413 of file renderPassState.h.
|
protected |
Definition at line 414 of file renderPassState.h.
|
protected |
Definition at line 356 of file renderPassState.h.
|
protected |
Definition at line 369 of file renderPassState.h.
|
protected |
Definition at line 420 of file renderPassState.h.
|
protected |
Definition at line 419 of file renderPassState.h.
|
protected |
Definition at line 426 of file renderPassState.h.
|
protected |
Definition at line 392 of file renderPassState.h.
|
protected |
Definition at line 384 of file renderPassState.h.
|
protected |
Definition at line 383 of file renderPassState.h.
|
protected |
Definition at line 385 of file renderPassState.h.
|
protected |
Definition at line 382 of file renderPassState.h.
|
protected |
Definition at line 389 of file renderPassState.h.
|
protected |
Definition at line 386 of file renderPassState.h.
|
protected |
Definition at line 387 of file renderPassState.h.
|
protected |
Definition at line 390 of file renderPassState.h.
|
protected |
Definition at line 388 of file renderPassState.h.
|
protected |
Definition at line 380 of file renderPassState.h.
|
protected |
Definition at line 358 of file renderPassState.h.
|
protected |
Definition at line 372 of file renderPassState.h.
|
protected |
Definition at line 368 of file renderPassState.h.
|
protected |
Definition at line 404 of file renderPassState.h.
|
protected |
Definition at line 371 of file renderPassState.h.
|
protected |
Definition at line 431 of file renderPassState.h.
|
protected |
Definition at line 364 of file renderPassState.h.
|
protected |
Definition at line 359 of file renderPassState.h.
|
protected |
Definition at line 366 of file renderPassState.h.
|
protected |
Definition at line 373 of file renderPassState.h.
|
protected |
Definition at line 367 of file renderPassState.h.
|
protected |
Definition at line 401 of file renderPassState.h.
|
protected |
Definition at line 398 of file renderPassState.h.
|
protected |
Definition at line 395 of file renderPassState.h.
|
protected |
Definition at line 397 of file renderPassState.h.
|
protected |
Definition at line 396 of file renderPassState.h.
|
protected |
Definition at line 399 of file renderPassState.h.
|
protected |
Definition at line 400 of file renderPassState.h.
|
protected |
Definition at line 428 of file renderPassState.h.
|
protected |
Definition at line 429 of file renderPassState.h.
|
protected |
Definition at line 379 of file renderPassState.h.
|
protected |
Definition at line 424 of file renderPassState.h.
|
protected |
Definition at line 357 of file renderPassState.h.
|
protected |
Definition at line 365 of file renderPassState.h.