Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_EXT_depth_clamp_control

Description

Name

VK_EXT_depth_clamp_control - device extension

VK_EXT_depth_clamp_control

Name String: VK_EXT_depth_clamp_control

Extension Type

Device extension

Registered Extension Number

583

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Vulkan Version 1.1

Contact

Jules Blok @jules%0A*Here describe the issue or question you have about the VK_EXT_depth_clamp_control extension*

Extension Proposal

VK_EXT_depth_clamp_control

Other Extension Metadata

Last Modified Date: 2024-07-15

Contributors

Jules Blok, Independent

Description

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.

New Commands

cmdSetDepthClampRangeEXT

New Structures

DepthClampRangeEXT

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceDepthClampControlFeaturesEXT
Extending PipelineViewportStateCreateInfo:
- PipelineViewportDepthClampControlCreateInfoEXT

New Enums

DepthClampModeEXT

New Enum Constants

EXT_DEPTH_CLAMP_CONTROL_EXTENSION_NAME

Issues

1) Should the depth clamp range be a per-viewport parameter?

RESOLVED: No. Because the depth clamp range was previously defined to be equal to the viewport depth range, conformant runtimes are already handling the depth clamp range as a per-viewport parameter. However because of complexities from interactions with multiple viewports a per-viewport clamp range is left to a future extensions if a use case arises.

2) Should this pipeline state be dynamic?

RESOLVED: Yes. Since the viewport depth range can already be a dynamic state conformant runtimes are already able to handle the depth clamp range as a dynamic state.

3) Can the depth clamp range be ignored when depth clamping is disabled?

RESOLVED: Yes. This extension overrides the clamping range used only when depth clamping is enabled. The alternative would be highly unintuitive. As a consequence the VK_EXT_depth_clip_enable extension is required if depth clipping is desired in combination with this extension.

Version History

Revision 1, 2024-02-13 (Jules Blok)
- Initial draft

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

cmdSetDepthClampRangeEXT :: forall io. MonadIO io => CommandBuffer -> DepthClampModeEXT -> ("depthClampRange" ::: Maybe DepthClampRangeEXT) -> io ()
data PhysicalDeviceDepthClampControlFeaturesEXT = PhysicalDeviceDepthClampControlFeaturesEXT {
- depthClampControl :: Bool
}
data PipelineViewportDepthClampControlCreateInfoEXT = PipelineViewportDepthClampControlCreateInfoEXT {
- depthClampMode :: DepthClampModeEXT
- depthClampRange :: Maybe DepthClampRangeEXT
}
data DepthClampRangeEXT = DepthClampRangeEXT {
- minDepthClamp :: Float
- maxDepthClamp :: Float
}
newtype DepthClampModeEXT where
- DepthClampModeEXT Int32
- pattern DEPTH_CLAMP_MODE_VIEWPORT_RANGE_EXT :: DepthClampModeEXT
- pattern DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT :: DepthClampModeEXT
type EXT_DEPTH_CLAMP_CONTROL_SPEC_VERSION = 1
pattern EXT_DEPTH_CLAMP_CONTROL_SPEC_VERSION :: forall a. Integral a => a
type EXT_DEPTH_CLAMP_CONTROL_EXTENSION_NAME = "VK_EXT_depth_clamp_control"
pattern EXT_DEPTH_CLAMP_CONTROL_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

cmdSetDepthClampRangeEXT Source #

Arguments

:: forall io. MonadIO io
=> CommandBuffer	`commandBuffer` is the command buffer into which the command will be recorded.
-> DepthClampModeEXT	`depthClampMode` determines how the clamp range is determined for each viewport.
-> ("depthClampRange" ::: Maybe DepthClampRangeEXT)	`pDepthClampRange` sets the depth clamp range for all viewports if `depthClampMode` is `DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT`.
-> io ()

vkCmdSetDepthClampRangeEXT - Set the viewport depth clamp range dynamically for a command buffer

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 PipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the PipelineViewportDepthClampControlCreateInfoEXT::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 DepthClampRangeEXT structure

Valid Usage (Implicit)

commandBuffer must be a valid CommandBuffer handle

depthClampMode must be a valid DepthClampModeEXT value
If pDepthClampRange is not NULL, pDepthClampRange must be a valid pointer to a valid DepthClampRangeEXT structure
commandBuffer must be in the recording state
The CommandPool 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 CommandPool 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

Members

This structure describes the following feature:

Description

If the PhysicalDeviceDepthClampControlFeaturesEXT structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceDepthClampControlFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

Description

This structure extends PipelineViewportStateCreateInfo and specifies the depth clamp range used in the pipeline. If this structure is not provided in the next chain then depthClampMode defaults to DEPTH_CLAMP_MODE_VIEWPORT_RANGE_EXT.

Valid Usage

If depthClampMode is DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT, and the pipeline is not created with DYNAMIC_STATE_DEPTH_CLAMP_RANGE_EXT, then pDepthClampRange must be a valid pointer to a valid DepthClampRangeEXT structure

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLAMP_CONTROL_CREATE_INFO_EXT

depthClampMode must be a valid DepthClampModeEXT value
If pDepthClampRange is not NULL, pDepthClampRange must be a valid pointer to a valid DepthClampRangeEXT structure

Storable PhysicalDeviceDepthClampControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods sizeOf :: PhysicalDeviceDepthClampControlFeaturesEXT -> Int # alignment :: PhysicalDeviceDepthClampControlFeaturesEXT -> Int # peekElemOff :: Ptr PhysicalDeviceDepthClampControlFeaturesEXT -> Int -> IO PhysicalDeviceDepthClampControlFeaturesEXT # pokeElemOff :: Ptr PhysicalDeviceDepthClampControlFeaturesEXT -> Int -> PhysicalDeviceDepthClampControlFeaturesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceDepthClampControlFeaturesEXT # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceDepthClampControlFeaturesEXT -> IO () # peek :: Ptr PhysicalDeviceDepthClampControlFeaturesEXT -> IO PhysicalDeviceDepthClampControlFeaturesEXT # poke :: Ptr PhysicalDeviceDepthClampControlFeaturesEXT -> PhysicalDeviceDepthClampControlFeaturesEXT -> IO () #
Show PhysicalDeviceDepthClampControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods showsPrec :: Int -> PhysicalDeviceDepthClampControlFeaturesEXT -> ShowS # show :: PhysicalDeviceDepthClampControlFeaturesEXT -> String # showList :: [PhysicalDeviceDepthClampControlFeaturesEXT] -> ShowS #
Eq PhysicalDeviceDepthClampControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods (==) :: PhysicalDeviceDepthClampControlFeaturesEXT -> PhysicalDeviceDepthClampControlFeaturesEXT -> Bool # (/=) :: PhysicalDeviceDepthClampControlFeaturesEXT -> PhysicalDeviceDepthClampControlFeaturesEXT -> Bool #
FromCStruct PhysicalDeviceDepthClampControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods peekCStruct :: Ptr PhysicalDeviceDepthClampControlFeaturesEXT -> IO PhysicalDeviceDepthClampControlFeaturesEXT Source #
ToCStruct PhysicalDeviceDepthClampControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods withCStruct :: PhysicalDeviceDepthClampControlFeaturesEXT -> (Ptr PhysicalDeviceDepthClampControlFeaturesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceDepthClampControlFeaturesEXT -> PhysicalDeviceDepthClampControlFeaturesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceDepthClampControlFeaturesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceDepthClampControlFeaturesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceDepthClampControlFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods zero :: PhysicalDeviceDepthClampControlFeaturesEXT Source #

Show PipelineViewportDepthClampControlCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods showsPrec :: Int -> PipelineViewportDepthClampControlCreateInfoEXT -> ShowS # show :: PipelineViewportDepthClampControlCreateInfoEXT -> String # showList :: [PipelineViewportDepthClampControlCreateInfoEXT] -> ShowS #
FromCStruct PipelineViewportDepthClampControlCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods peekCStruct :: Ptr PipelineViewportDepthClampControlCreateInfoEXT -> IO PipelineViewportDepthClampControlCreateInfoEXT Source #
ToCStruct PipelineViewportDepthClampControlCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods withCStruct :: PipelineViewportDepthClampControlCreateInfoEXT -> (Ptr PipelineViewportDepthClampControlCreateInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PipelineViewportDepthClampControlCreateInfoEXT -> PipelineViewportDepthClampControlCreateInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PipelineViewportDepthClampControlCreateInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PipelineViewportDepthClampControlCreateInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PipelineViewportDepthClampControlCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods zero :: PipelineViewportDepthClampControlCreateInfoEXT Source #

Storable DepthClampRangeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods sizeOf :: DepthClampRangeEXT -> Int # alignment :: DepthClampRangeEXT -> Int # peekElemOff :: Ptr DepthClampRangeEXT -> Int -> IO DepthClampRangeEXT # pokeElemOff :: Ptr DepthClampRangeEXT -> Int -> DepthClampRangeEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO DepthClampRangeEXT # pokeByteOff :: Ptr b -> Int -> DepthClampRangeEXT -> IO () # peek :: Ptr DepthClampRangeEXT -> IO DepthClampRangeEXT # poke :: Ptr DepthClampRangeEXT -> DepthClampRangeEXT -> IO () #
Show DepthClampRangeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods showsPrec :: Int -> DepthClampRangeEXT -> ShowS # show :: DepthClampRangeEXT -> String # showList :: [DepthClampRangeEXT] -> ShowS #
Eq DepthClampRangeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods (==) :: DepthClampRangeEXT -> DepthClampRangeEXT -> Bool # (/=) :: DepthClampRangeEXT -> DepthClampRangeEXT -> Bool #
FromCStruct DepthClampRangeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods peekCStruct :: Ptr DepthClampRangeEXT -> IO DepthClampRangeEXT Source #
ToCStruct DepthClampRangeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods withCStruct :: DepthClampRangeEXT -> (Ptr DepthClampRangeEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr DepthClampRangeEXT -> DepthClampRangeEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr DepthClampRangeEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr DepthClampRangeEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero DepthClampRangeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods zero :: DepthClampRangeEXT Source #

Storable DepthClampModeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods sizeOf :: DepthClampModeEXT -> Int # alignment :: DepthClampModeEXT -> Int # peekElemOff :: Ptr DepthClampModeEXT -> Int -> IO DepthClampModeEXT # pokeElemOff :: Ptr DepthClampModeEXT -> Int -> DepthClampModeEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO DepthClampModeEXT # pokeByteOff :: Ptr b -> Int -> DepthClampModeEXT -> IO () # peek :: Ptr DepthClampModeEXT -> IO DepthClampModeEXT # poke :: Ptr DepthClampModeEXT -> DepthClampModeEXT -> IO () #
Read DepthClampModeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods readsPrec :: Int -> ReadS DepthClampModeEXT # readList :: ReadS [DepthClampModeEXT] # readPrec :: ReadPrec DepthClampModeEXT # readListPrec :: ReadPrec [DepthClampModeEXT] #
Show DepthClampModeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods showsPrec :: Int -> DepthClampModeEXT -> ShowS # show :: DepthClampModeEXT -> String # showList :: [DepthClampModeEXT] -> ShowS #
Eq DepthClampModeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods (==) :: DepthClampModeEXT -> DepthClampModeEXT -> Bool # (/=) :: DepthClampModeEXT -> DepthClampModeEXT -> Bool #
Ord DepthClampModeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods compare :: DepthClampModeEXT -> DepthClampModeEXT -> Ordering # (<) :: DepthClampModeEXT -> DepthClampModeEXT -> Bool # (<=) :: DepthClampModeEXT -> DepthClampModeEXT -> Bool # (>) :: DepthClampModeEXT -> DepthClampModeEXT -> Bool # (>=) :: DepthClampModeEXT -> DepthClampModeEXT -> Bool # max :: DepthClampModeEXT -> DepthClampModeEXT -> DepthClampModeEXT # min :: DepthClampModeEXT -> DepthClampModeEXT -> DepthClampModeEXT #
Zero DepthClampModeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_clamp_control Methods zero :: DepthClampModeEXT Source #

Name

VK_EXT_depth_clamp_control

Other Extension Metadata

Description

New Commands

New Structures

New Enums

New Enum Constants

Issues

Version History

See Also

Document Notes

Documentation

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

See Also

Members

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Valid Usage

See Also

Instances

See Also

Instances

PhysicalDeviceDepthClampControlFeaturesEXT
Fields depthClampControl :: Bool `depthClampControl` indicates that the implementation supports setting `PipelineViewportDepthClampControlCreateInfoEXT`::`depthClampMode` to `DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT`.

PipelineViewportDepthClampControlCreateInfoEXT
Fields depthClampMode :: DepthClampModeEXT `depthClampMode` determines how the clamp range is determined for each viewport. depthClampRange :: Maybe DepthClampRangeEXT `pDepthClampRange` sets the depth clamp range for all viewports if `depthClampMode` is `DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT`.

DepthClampRangeEXT
Fields minDepthClamp :: Float `minDepthClamp` sets zmin in the depth clamp range of the viewport. maxDepthClamp :: Float `maxDepthClamp` sets zmax in the depth clamp range of the viewport.

pattern DEPTH_CLAMP_MODE_VIEWPORT_RANGE_EXT :: DepthClampModeEXT	`DEPTH_CLAMP_MODE_VIEWPORT_RANGE_EXT` specifies that the depth clamp range follows the viewport depth range. The depth clamp range of each viewport will implicitly be set to zmin = min(n,f) and zmax = max(n,f), where n and f are the `minDepth` and `maxDepth` depth range values of the viewport.
pattern DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT :: DepthClampModeEXT	`DEPTH_CLAMP_MODE_USER_DEFINED_RANGE_EXT` specifies that a single user-defined depth clamp range will be used for all viewports. The user-defined depth clamp range is defined by the `minDepthClamp` and `maxDepthClamp` members of `DepthClampRangeEXT`.