Skip to content

Commit

Permalink
Updated documentation for DepthClamp device feature and DepthClipEnab…
Browse files Browse the repository at this point in the history
…le member of the RasterizerStateDesc struct
  • Loading branch information
TheMostDiligent committed Aug 23, 2023
1 parent 5db6a60 commit 1b4a057
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Graphics/GraphicsEngine/interface/GraphicsTypes.h
Original file line number Diff line number Diff line change
Expand Up @@ -1678,6 +1678,12 @@ struct DeviceFeatures
DEVICE_FEATURE_STATE DepthBiasClamp DEFAULT_INITIALIZER(DEVICE_FEATURE_STATE_DISABLED);

/// Indicates if device supports depth clamping
///
/// \remarks By default polygon faces are clipped against the near and far planes of the view
/// frustum. If depth clipping is disabled in the PSO, the depth of the fragments that
/// would be clipped is clamped to the near/far plane instead of discarding them.
/// If this feature is enabled, the DepthClipEnable member of the RasterizerStateDesc
/// struct can be set to False. Otherwise it must always be set to True.
DEVICE_FEATURE_STATE DepthClamp DEFAULT_INITIALIZER(DEVICE_FEATURE_STATE_DISABLED);

/// Indicates if device supports depth clamping
Expand Down
7 changes: 7 additions & 0 deletions Graphics/GraphicsEngine/interface/RasterizerState.h
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,13 @@ struct RasterizerStateDesc

/// Enable clipping against near and far clip planes.
/// Default value: True.
///
/// \remarks By default polygon faces are clipped against the near and far planes of the view
/// frustum. If depth clipping is disabled, the depth of the fragments that would be
/// clipped is clamped to the near/far plane instead of discarding them.
///
/// To check if the device supports depth clamping, use the DepthClamp device feature.
/// If it is not supported, the value of this member must be True.
Bool DepthClipEnable DEFAULT_INITIALIZER(True);

/// Enable scissor-rectangle culling. All pixels outside an active scissor rectangle are culled.
Expand Down

0 comments on commit 1b4a057

Please sign in to comment.