Loading...
Searching...
No Matches
renderPassState.h
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_IMAGING_HD_RENDER_PASS_STATE_H
8#define PXR_IMAGING_HD_RENDER_PASS_STATE_H
9
10#include "pxr/pxr.h"
11#include "pxr/imaging/hd/api.h"
12#include "pxr/imaging/hd/aov.h"
13#include "pxr/imaging/hd/version.h"
14#include "pxr/imaging/hd/enums.h"
15
16#include "pxr/imaging/cameraUtil/framing.h"
17
18#include "pxr/usd/sdf/path.h"
19
20#include "pxr/base/tf/token.h"
21#include "pxr/base/vt/value.h"
22#include "pxr/base/gf/matrix4d.h"
23#include "pxr/base/gf/vec2f.h"
24#include "pxr/base/gf/vec4d.h"
25#include "pxr/base/gf/vec4f.h"
26
27#include <memory>
28
29#include <optional>
30
31PXR_NAMESPACE_OPEN_SCOPE
32
33
34using HdRenderPassStateSharedPtr = std::shared_ptr<class HdRenderPassState>;
35using HdResourceRegistrySharedPtr = std::shared_ptr<class HdResourceRegistry>;
36
37class HdCamera;
38
45class HdRenderPassState
46{
47public:
48 HD_API
49 HdRenderPassState();
50 HD_API
51 virtual ~HdRenderPassState();
52
57 HD_API
58 virtual void Prepare(HdResourceRegistrySharedPtr const &resourceRegistry);
59
60 // ---------------------------------------------------------------------- //
62 // ---------------------------------------------------------------------- //
63
64 using ClipPlanesVector = std::vector<GfVec4d>;
65
67 HD_API
68 void SetCamera(const HdCamera *camera);
69
74 HD_API
75 void SetOverrideWindowPolicy(
76 const std::optional<CameraUtilConformWindowPolicy> &
77 overrideWindowPolicy);
78
81 HD_API
82 void SetFraming(const CameraUtilFraming &framing);
83
88 HD_API
89 void SetViewport(const GfVec4d &viewport);
90
92 HdCamera const *
93 GetCamera() const { return _camera; }
94
97 const CameraUtilFraming &
98 GetFraming() const { return _framing; }
99
102 const std::optional<CameraUtilConformWindowPolicy> &
103 GetOverrideWindowPolicy() const { return _overrideWindowPolicy; }
104
108 HD_API
109 CameraUtilConformWindowPolicy
110 GetWindowPolicy() const;
111
116 HD_API
117 virtual GfMatrix4d GetWorldToViewMatrix() const;
118
121 HD_API
122 virtual GfMatrix4d GetProjectionMatrix() const;
123
127 GfVec4f const & GetViewport() const { return _viewport; }
128
133 HD_API
134 GfMatrix4d GetImageToWorldMatrix() const;
135
138 HD_API
139 virtual ClipPlanesVector const & GetClipPlanes() const;
140
141 // ---------------------------------------------------------------------- //
143 // ---------------------------------------------------------------------- //
144
148 HD_API
149 void SetOverrideColor(GfVec4f const &color);
150 const GfVec4f& GetOverrideColor() const { return _overrideColor; }
151
155 HD_API
156 void SetWireframeColor(GfVec4f const &color);
157 const GfVec4f& GetWireframeColor() const { return _wireframeColor; }
158
160 HD_API
161 void SetMaskColor(GfVec4f const &color);
162 const GfVec4f& GetMaskColor() const { return _maskColor; }
163
165 HD_API
166 void SetIndicatorColor(GfVec4f const &color);
167 const GfVec4f& GetIndicatorColor() const { return _indicatorColor; }
168
172 HD_API
173 void SetPointColor(GfVec4f const &color);
174 const GfVec4f& GetPointColor() const { return _pointColor; }
175
177 HD_API
178 void SetPointSize(float size);
179 float GetPointSize() const { return _pointSize; }
180
182 HD_API
183 void SetPointSelectedSize(float size);
184 float GetPointSelectedSize() const { return _pointSelectedSize; }
185
187 HD_API
188 void SetLightingEnabled(bool enabled);
189 bool GetLightingEnabled() const { return _lightingEnabled; }
190
191 HD_API
192 void SetClippingEnabled(bool enabled);
193 bool GetClippingEnabled() const { return _clippingEnabled; }
194
195 HD_API
196 void SetEnableExposureCompensation(bool enableExposureCompensation);
197 bool GetEnableExposureCompensation() const { return _enableExposureCompensation; }
198
199 // ---------------------------------------------------------------------- //
201 // ---------------------------------------------------------------------- //
202
204 HD_API
205 void SetAovBindings(HdRenderPassAovBindingVector const &aovBindings);
206 HD_API
207 HdRenderPassAovBindingVector const& GetAovBindings() const;
208
210 HD_API
211 void SetAovInputBindings(HdRenderPassAovBindingVector const &aovBindings);
212 HD_API
213 HdRenderPassAovBindingVector const& GetAovInputBindings() const;
214
217 HD_API
218 void SetUseAovMultiSample(bool state);
219 HD_API
220 bool GetUseAovMultiSample() const;
221
222 HD_API
223 void SetCullStyle(HdCullStyle cullStyle);
224 HD_API
225 HdCullStyle GetCullStyle() const { return _cullStyle; }
226
227 HD_API
228 void SetAlphaThreshold(float alphaThreshold);
229 float GetAlphaThreshold() const { return _alphaThreshold; }
230
231 HD_API
232 void SetTessLevel(float level);
233 float GetTessLevel() const { return _tessLevel; }
234
235 HD_API
236 void SetDrawingRange(GfVec2f const &drawRange);
237 GfVec2f GetDrawingRange() const { return _drawRange; } // in pixel
238 HD_API
239 GfVec2f GetDrawingRangeNDC() const; // in ndc
240
241 HD_API
242 void SetDepthBiasUseDefault(bool useDefault);
243 bool GetDepthBiasUseDefault() const { return _depthBiasUseDefault; }
244
245 HD_API
246 void SetDepthBiasEnabled(bool enabled);
247 bool GetDepthBiasEnabled() const { return _depthBiasEnabled; }
248
249 HD_API
250 void SetDepthBias(float constantFactor, float slopeFactor);
251
252 HD_API
253 void SetDepthFunc(HdCompareFunction depthFunc);
254 HdCompareFunction GetDepthFunc() const { return _depthFunc; }
255
256 HD_API
257 void SetEnableDepthMask(bool state);
258 HD_API
259 bool GetEnableDepthMask() const;
260
261 HD_API
262 void SetEnableDepthTest(bool enabled);
263 HD_API
264 bool GetEnableDepthTest() const;
265
266 HD_API
267 void SetEnableDepthClamp(bool enabled);
268 HD_API
269 bool GetEnableDepthClamp() const;
270
271 HD_API
272 void SetDepthRange(GfVec2f const &depthRange);
273 HD_API
274 const GfVec2f& GetDepthRange() const;
275
276 HD_API
277 void SetStencil(HdCompareFunction func, int ref, int mask,
278 HdStencilOp fail, HdStencilOp zfail, HdStencilOp zpass);
279 HdCompareFunction GetStencilFunc() const { return _stencilFunc; }
280 int GetStencilRef() const { return _stencilRef; }
281 int GetStencilMask() const { return _stencilMask; }
282 HdStencilOp GetStencilFailOp() const { return _stencilFailOp; }
283 HdStencilOp GetStencilDepthFailOp() const { return _stencilZFailOp; }
284 HdStencilOp GetStencilDepthPassOp() const { return _stencilZPassOp; }
285 HD_API
286 void SetStencilEnabled(bool enabled);
287 HD_API
288 bool GetStencilEnabled() const;
289
290 HD_API
291 void SetLineWidth(float width);
292 float GetLineWidth() const { return _lineWidth; }
293
294 HD_API
295 void SetBlend(HdBlendOp colorOp,
296 HdBlendFactor colorSrcFactor,
297 HdBlendFactor colorDstFactor,
298 HdBlendOp alphaOp,
299 HdBlendFactor alphaSrcFactor,
300 HdBlendFactor alphaDstFactor);
301 HdBlendOp GetBlendColorOp() { return _blendColorOp; }
302 HdBlendFactor GetBlendColorSrcFactor() { return _blendColorSrcFactor; }
303 HdBlendFactor GetBlendColorDstFactor() { return _blendColorDstFactor; }
304 HdBlendOp GetBlendAlphaOp() { return _blendAlphaOp; }
305 HdBlendFactor GetBlendAlphaSrcFactor() { return _blendAlphaSrcFactor; }
306 HdBlendFactor GetBlendAlphaDstFactor() { return _blendAlphaDstFactor; }
307
308 // Blend constant color is specified in the render color space
309 HD_API
310 void SetBlendConstantColor(GfVec4f const & color);
311 const GfVec4f& GetBlendConstantColor() const { return _blendConstantColor; }
312 HD_API
313 void SetBlendEnabled(bool enabled);
314
315 HD_API
316 void SetAlphaToCoverageEnabled(bool enabled);
317 bool GetAlphaToCoverageEnabled() const { return _alphaToCoverageEnabled; }
318
319 HD_API
320 void SetColorMaskUseDefault(bool useDefault);
321 bool GetColorMaskUseDefault() const { return _colorMaskUseDefault;}
322
323 HD_API
324 void SetConservativeRasterizationEnabled(bool enabled);
325 bool GetConservativeRasterizationEnabled() const {
326 return _conservativeRasterizationEnabled;
327 }
328
329 HD_API
330 void SetVolumeRenderingConstants(float stepSize, float stepSizeLighting);
331
332 enum ColorMask {
333 ColorMaskNone,
334 ColorMaskRGB,
335 ColorMaskRGBA
336 };
337
338 HD_API
339 void SetColorMasks(std::vector<ColorMask> const& masks);
340 std::vector<ColorMask> const& GetColorMasks() const { return _colorMasks; }
341
342 HD_API
343 void SetMultiSampleEnabled(bool enabled);
344 bool GetMultiSampleEnabled() const { return _multiSampleEnabled; }
345
346protected:
347 // ---------------------------------------------------------------------- //
348 // Camera and framing state
349 // ---------------------------------------------------------------------- //
350 HdCamera const *_camera;
351 GfVec4f _viewport;
352 CameraUtilFraming _framing;
353 std::optional<CameraUtilConformWindowPolicy> _overrideWindowPolicy;
354
355 // ---------------------------------------------------------------------- //
356 // Application rendering state
357 // ---------------------------------------------------------------------- //
358 GfVec4f _overrideColor;
359 GfVec4f _wireframeColor;
360 GfVec4f _pointColor;
361 float _pointSize;
362 bool _lightingEnabled;
363 bool _clippingEnabled;
364 bool _enableExposureCompensation;
365
366 GfVec4f _maskColor;
367 GfVec4f _indicatorColor;
368 float _pointSelectedSize;
369
370 // ---------------------------------------------------------------------- //
371 // Render pipeline state
372 // ---------------------------------------------------------------------- //
373 float _alphaThreshold;
374 float _tessLevel;
375 GfVec2f _drawRange;
376
377 bool _depthBiasUseDefault; // inherit existing state, ignore values below.
378 bool _depthBiasEnabled;
379 float _depthBiasConstantFactor;
380 float _depthBiasSlopeFactor;
381 HdCompareFunction _depthFunc;
382 bool _depthMaskEnabled;
383 bool _depthTestEnabled;
384 bool _depthClampEnabled;
385 GfVec2f _depthRange;
386
387 HdCullStyle _cullStyle;
388
389 // Stencil RenderPassState
390 HdCompareFunction _stencilFunc;
391 int _stencilRef;
392 int _stencilMask;
393 HdStencilOp _stencilFailOp;
394 HdStencilOp _stencilZFailOp;
395 HdStencilOp _stencilZPassOp;
396 bool _stencilEnabled;
397
398 // Line width
399 float _lineWidth;
400
401 // Blending
402 HdBlendOp _blendColorOp;
403 HdBlendFactor _blendColorSrcFactor;
404 HdBlendFactor _blendColorDstFactor;
405 HdBlendOp _blendAlphaOp;
406 HdBlendFactor _blendAlphaSrcFactor;
407 HdBlendFactor _blendAlphaDstFactor;
408 GfVec4f _blendConstantColor;
409 bool _blendEnabled;
410
411 // alpha to coverage
412 bool _alphaToCoverageEnabled;
413
414 bool _colorMaskUseDefault;
415 std::vector<ColorMask> _colorMasks;
416
417 HdRenderPassAovBindingVector _aovBindings;
418 HdRenderPassAovBindingVector _aovInputBindings;
419 bool _useMultiSampleAov;
420
421 bool _conservativeRasterizationEnabled;
422
423 float _stepSize;
424 float _stepSizeLighting;
425
426 bool _multiSampleEnabled;
427};
428
429PXR_NAMESPACE_CLOSE_SCOPE
430
431#endif // PXR_IMAGING_HD_RENDER_PASS_STATE_H
CameraUtilFraming
Framing information.
Definition: framing.h:63
GfMatrix4d
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:71
GfVec2f
Basic type for a vector of 2 float components.
Definition: vec2f.h:46
GfVec4d
Basic type for a vector of 4 double components.
Definition: vec4d.h:46
GfVec4f
Basic type for a vector of 4 float components.
Definition: vec4f.h:46
HdCamera
Hydra schema for a camera that pulls the params (see above) during Sync.
Definition: camera.h:92
HdRenderPassState
A set of rendering parameters used among render passes.
Definition: renderPassState.h:46
HdRenderPassState::GetImageToWorldMatrix
HD_API GfMatrix4d GetImageToWorldMatrix() const
Compute a transform from window relative coordinates (x,y,z,1) to homogeneous world coordinates (x,...
HdRenderPassState::GetViewport
GfVec4f const & GetViewport() const
Only use when clients did not specify a camera framing.
Definition: renderPassState.h:127
HdRenderPassState::GetWindowPolicy
HD_API CameraUtilConformWindowPolicy GetWindowPolicy() const
The resolved window policy to conform the camera frustum.
HdRenderPassState::GetClipPlanes
virtual HD_API ClipPlanesVector const & GetClipPlanes() const
Returns HdCamera's clip planes.
HdRenderPassState::SetMaskColor
HD_API void SetMaskColor(GfVec4f const &color)
The color is specified in the render color space.
HdRenderPassState::SetFraming
HD_API void SetFraming(const CameraUtilFraming &framing)
Sets the framing to show the camera.
HdRenderPassState::SetOverrideWindowPolicy
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 matc...
HdRenderPassState::SetAovInputBindings
HD_API void SetAovInputBindings(HdRenderPassAovBindingVector const &aovBindings)
Set the AOVs that this renderpass needs to read from.
HdRenderPassState::Prepare
virtual HD_API void Prepare(HdResourceRegistrySharedPtr const &resourceRegistry)
Schedule to update renderPassState parameters.
HdRenderPassState::SetAovBindings
HD_API void SetAovBindings(HdRenderPassAovBindingVector const &aovBindings)
Set the attachments for this renderpass to render into.
HdRenderPassState::SetCamera
HD_API void SetCamera(const HdCamera *camera)
Sets the camera.
HdRenderPassState::SetPointColor
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...
HdRenderPassState::SetOverrideColor
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 compo...
HdRenderPassState::GetCamera
HdCamera const * GetCamera() const
Get camera.
Definition: renderPassState.h:93
HdRenderPassState::SetPointSize
HD_API void SetPointSize(float size)
Set the point size for unselected points.
HdRenderPassState::SetViewport
HD_API void SetViewport(const GfVec4d &viewport)
Sets the viewport to show the camera.
HdRenderPassState::SetWireframeColor
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 compo...
HdRenderPassState::SetPointSelectedSize
HD_API void SetPointSelectedSize(float size)
Set the point size for selected points.
HdRenderPassState::GetProjectionMatrix
virtual HD_API GfMatrix4d GetProjectionMatrix() const
Compute projection matrix using physical attributes of an HdCamera.
HdRenderPassState::SetLightingEnabled
HD_API void SetLightingEnabled(bool enabled)
XXX: Hacky way of disabling lighting.
HdRenderPassState::GetOverrideWindowPolicy
const std::optional< CameraUtilConformWindowPolicy > & GetOverrideWindowPolicy() const
The override value for the window policy to conform the camera frustum that can be specified by the a...
Definition: renderPassState.h:103
HdRenderPassState::SetUseAovMultiSample
HD_API void SetUseAovMultiSample(bool state)
Returns true if the render pass wants to render into the multi-sample aovs.
HdRenderPassState::GetFraming
const CameraUtilFraming & GetFraming() const
Get framing information determining how the filmback plane maps to pixels.
Definition: renderPassState.h:98
HdRenderPassState::SetIndicatorColor
HD_API void SetIndicatorColor(GfVec4f const &color)
The color is specified in the render color space.
HdRenderPassState::GetWorldToViewMatrix
virtual HD_API GfMatrix4d GetWorldToViewMatrix() const
Camera getter API.
token.h
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...