Package org.lwjgl.vulkan

Class EXTDepthClampControl

java.lang.Object

org.lwjgl.vulkan.EXTDepthClampControl

public class EXTDepthClampControl
extends Object

This extension allows the application to control the viewport depth clamp range separately from the viewport minDepth and maxDepth. This gives the ability for the application to restrict depth values to an application-defined range rather than the viewport depth range or the range defined in the VK_EXT_depth_clamp_zero_one extension.

It can be used to set a smaller or larger clamping range than the viewport depth range without affecting the depth mapping of the viewport transform. Another possible use of this extension is to restrict depth values beyond the viewport depth range to a clamping range other than the [0, 1] range defined in the VK_EXT_depth_clamp_zero_one extension.

Name String

VK_EXT_depth_clamp_control

Extension Type

Device extension

Registered Extension Number

583

Revision

1

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Version 1.1

Contact

• Jules Blok jules

Extension Proposal

VK_EXT_depth_clamp_control

Other Extension Metadata

Last Modified Date

2024-07-15

Contributors

• Jules Blok, Independent

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_DYNAMIC_STATE_DEPTH_CLAMP_RANGE_EXT	Extends VkDynamicState.
static final String	VK_EXT_DEPTH_CLAMP_CONTROL_EXTENSION_NAME	The extension name.
static final int	VK_EXT_DEPTH_CLAMP_CONTROL_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DEPTH_CLAMP_CONTROL_FEATURES_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLAMP_CONTROL_CREATE_INFO_EXT	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdSetDepthClampRangeEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int depthClampMode, long pDepthClampRange)	Unsafe version of: CmdSetDepthClampRangeEXT
static void	vkCmdSetDepthClampRangeEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int depthClampMode, @Nullable VkDepthClampRangeEXT pDepthClampRange)	Set the viewport depth clamp range dynamically for a command buffer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_EXT_DEPTH_CLAMP_CONTROL_SPEC_VERSION

public static final int VK_EXT_DEPTH_CLAMP_CONTROL_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_EXT_DEPTH_CLAMP_CONTROL_EXTENSION_NAME

public static final String VK_EXT_DEPTH_CLAMP_CONTROL_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DEPTH_CLAMP_CONTROL_FEATURES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DEPTH_CLAMP_CONTROL_FEATURES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DEPTH_CLAMP_CONTROL_FEATURES_EXT
• STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLAMP_CONTROL_CREATE_INFO_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLAMP_CONTROL_CREATE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLAMP_CONTROL_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DEPTH_CLAMP_CONTROL_FEATURES_EXT
• STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLAMP_CONTROL_CREATE_INFO_EXT

See Also:

• Constant Field Values

VK_DYNAMIC_STATE_DEPTH_CLAMP_RANGE_EXT

public static final int VK_DYNAMIC_STATE_DEPTH_CLAMP_RANGE_EXT

Extends VkDynamicState.

See Also:

• Constant Field Values

Method Details

nvkCmdSetDepthClampRangeEXT

public static void nvkCmdSetDepthClampRangeEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 int depthClampMode,
 long pDepthClampRange)

Unsafe version of: CmdSetDepthClampRangeEXT

vkCmdSetDepthClampRangeEXT

public static void vkCmdSetDepthClampRangeEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 int depthClampMode,
 @Nullable VkDepthClampRangeEXT pDepthClampRange)

Set the viewport depth clamp range dynamically for a command buffer.

C Specification

To dynamically set the viewport depth clamp range parameters, call:

 void vkCmdSetDepthClampRangeEXT(
     VkCommandBuffer                             commandBuffer,
     VkDepthClampModeEXT                         depthClampMode,
     const VkDepthClampRangeEXT*                 pDepthClampRange);

Description

This command sets the viewport depth clamp range for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with DYNAMIC_STATE_DEPTH_CLAMP_RANGE_EXT set in VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkPipelineViewportDepthClampControlCreateInfoEXT::depthClampMode value used to create the currently active pipeline.

Valid Usage

• If depthClampMode is DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT, then pDepthClampRange must be a valid pointer to a valid VkDepthClampRangeEXT structure

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• depthClampMode must be a valid VkDepthClampModeEXT value
• If pDepthClampRange is not NULL, pDepthClampRange must be a valid pointer to a valid VkDepthClampRangeEXT structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics operations
• This command must only be called outside of a video coding scope

Host Synchronization

• Host access to commandBuffer must be externally synchronized
• Host access to the VkCommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Both	Outside	Graphics	State

See Also

VkDepthClampRangeEXT

Parameters:

commandBuffer - the command buffer into which the command will be recorded.

depthClampMode - determines how the clamp range is determined for each viewport.

pDepthClampRange - sets the depth clamp range for all viewports if depthClampMode is DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT.