Vulkan.Extensions.VK_EXT_depth_clip_control

Name

VK_EXT_depth_clip_control - device extension

VK_EXT_depth_clip_control

Name String

VK_EXT_depth_clip_control

Extension Type

Device extension

Registered Extension Number

356

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2 to be enabled for any device-level functionality

Special Use

• OpenGL / ES support

Contact

• Shahbaz Youssefi @syoussefi%0A*Here describe the issue or question you have about the VK_EXT_depth_clip_control extension*

Other Extension Metadata

Last Modified Date

2021-11-09

Contributors

• Spencer Fricke, Samsung Electronics
• Shahbaz Youssefi, Google
• Ralph Potter, Samsung Electronics

Description

This extension allows the application to use the OpenGL depth range in NDC, i.e. with depth in range [-1, 1], as opposed to Vulkan’s default of [0, 1]. The purpose of this extension is to allow efficient layering of OpenGL over Vulkan, by avoiding emulation in the pre-rasterization shader stages. This emulation, which effectively duplicates gl_Position but with a different depth value, costs ALU and consumes shader output components that the implementation may not have to spare to meet OpenGL minimum requirements.

New Structures

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceDepthClipControlFeaturesEXT

• Extending PipelineViewportStateCreateInfo:

  • PipelineViewportDepthClipControlCreateInfoEXT

New Enum Constants

• EXT_DEPTH_CLIP_CONTROL_EXTENSION_NAME

• EXT_DEPTH_CLIP_CONTROL_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_DEPTH_CLIP_CONTROL_FEATURES_EXT
  • STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLIP_CONTROL_CREATE_INFO_EXT

Issues

1) Should this extension include an origin control option to match GL_LOWER_LEFT found in ARB_clip_control?

RESOLVED: No. The fix for porting over the origin is a simple y-axis flip. The depth clip control is a much harder problem to solve than what this extension is aimed to solve. Adding an equivalent to GL_LOWER_LEFT would require more testing.

2) Should this pipeline state be dynamic?

RESOLVED: Yes. The purpose of this extension is to emulate the OpenGL depth range, which is expected to be globally fixed (in case of OpenGL ES) or very infrequently changed (with glClipControl in OpenGL).

3) Should the control provided in this extension be an enum that could be extended in the future?

RESOLVED: No. It is highly unlikely that the depth range is changed to anything other than [0, 1] in the future. Should that happen a new extension will be required to extend such an enum, and that extension might as well add a new struct to chain to PipelineViewportStateCreateInfo::pNext instead.

Version History

• Revision 0, 2020-10-01 (Spencer Fricke)

  • Internal revisions

• Revision 1, 2020-11-26 (Shahbaz Youssefi)

  • Language fixes

See Also

PhysicalDeviceDepthClipControlFeaturesEXT, PipelineViewportDepthClipControlCreateInfoEXT

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.

Documentation

data PhysicalDeviceDepthClipControlFeaturesEXT

VkPhysicalDeviceDepthClipControlFeaturesEXT - Structure describing additional depth clip control supported by an implementation

Members

This structure describes the following feature:

Description

If the PhysicalDeviceDepthClipControlFeaturesEXT 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. PhysicalDeviceDepthClipControlFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_EXT_depth_clip_control, Bool32, StructureType

Constructors

PhysicalDeviceDepthClipControlFeaturesEXT

Fields

• depthClipControl :: Bool

  depthClipControl indicates that the implementation supports setting PipelineViewportDepthClipControlCreateInfoEXT::negativeOneToOne to TRUE.

Instances

Storable PhysicalDeviceDepthClipControlFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

sizeOf :: PhysicalDeviceDepthClipControlFeaturesEXT -> Int

alignment :: PhysicalDeviceDepthClipControlFeaturesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceDepthClipControlFeaturesEXT -> Int -> IO PhysicalDeviceDepthClipControlFeaturesEXT

pokeElemOff :: Ptr PhysicalDeviceDepthClipControlFeaturesEXT -> Int -> PhysicalDeviceDepthClipControlFeaturesEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceDepthClipControlFeaturesEXT

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceDepthClipControlFeaturesEXT -> IO ()

peek :: Ptr PhysicalDeviceDepthClipControlFeaturesEXT -> IO PhysicalDeviceDepthClipControlFeaturesEXT

poke :: Ptr PhysicalDeviceDepthClipControlFeaturesEXT -> PhysicalDeviceDepthClipControlFeaturesEXT -> IO ()

Show PhysicalDeviceDepthClipControlFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

showsPrec :: Int -> PhysicalDeviceDepthClipControlFeaturesEXT -> ShowS

show :: PhysicalDeviceDepthClipControlFeaturesEXT -> String

showList :: [PhysicalDeviceDepthClipControlFeaturesEXT] -> ShowS

Eq PhysicalDeviceDepthClipControlFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

(==) :: PhysicalDeviceDepthClipControlFeaturesEXT -> PhysicalDeviceDepthClipControlFeaturesEXT -> Bool

(/=) :: PhysicalDeviceDepthClipControlFeaturesEXT -> PhysicalDeviceDepthClipControlFeaturesEXT -> Bool

FromCStruct PhysicalDeviceDepthClipControlFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

peekCStruct :: Ptr PhysicalDeviceDepthClipControlFeaturesEXT -> IO PhysicalDeviceDepthClipControlFeaturesEXT

ToCStruct PhysicalDeviceDepthClipControlFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

withCStruct :: PhysicalDeviceDepthClipControlFeaturesEXT -> (Ptr PhysicalDeviceDepthClipControlFeaturesEXT -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceDepthClipControlFeaturesEXT -> PhysicalDeviceDepthClipControlFeaturesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceDepthClipControlFeaturesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceDepthClipControlFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceDepthClipControlFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

zero :: PhysicalDeviceDepthClipControlFeaturesEXT

data PipelineViewportDepthClipControlCreateInfoEXT

VkPipelineViewportDepthClipControlCreateInfoEXT - Structure specifying parameters of a newly created pipeline depth clip control state

Valid Usage

• If depthClipControl is not enabled, negativeOneToOne must be FALSE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_DEPTH_CLIP_CONTROL_CREATE_INFO_EXT

See Also

VK_EXT_depth_clip_control, Bool32, StructureType

Constructors

PipelineViewportDepthClipControlCreateInfoEXT

Fields

• negativeOneToOne :: Bool

  negativeOneToOne sets the zm in the view volume to -wc

Instances

Storable PipelineViewportDepthClipControlCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

sizeOf :: PipelineViewportDepthClipControlCreateInfoEXT -> Int

alignment :: PipelineViewportDepthClipControlCreateInfoEXT -> Int

peekElemOff :: Ptr PipelineViewportDepthClipControlCreateInfoEXT -> Int -> IO PipelineViewportDepthClipControlCreateInfoEXT

pokeElemOff :: Ptr PipelineViewportDepthClipControlCreateInfoEXT -> Int -> PipelineViewportDepthClipControlCreateInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PipelineViewportDepthClipControlCreateInfoEXT

pokeByteOff :: Ptr b -> Int -> PipelineViewportDepthClipControlCreateInfoEXT -> IO ()

peek :: Ptr PipelineViewportDepthClipControlCreateInfoEXT -> IO PipelineViewportDepthClipControlCreateInfoEXT

poke :: Ptr PipelineViewportDepthClipControlCreateInfoEXT -> PipelineViewportDepthClipControlCreateInfoEXT -> IO ()

Show PipelineViewportDepthClipControlCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

showsPrec :: Int -> PipelineViewportDepthClipControlCreateInfoEXT -> ShowS

show :: PipelineViewportDepthClipControlCreateInfoEXT -> String

showList :: [PipelineViewportDepthClipControlCreateInfoEXT] -> ShowS

Eq PipelineViewportDepthClipControlCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

(==) :: PipelineViewportDepthClipControlCreateInfoEXT -> PipelineViewportDepthClipControlCreateInfoEXT -> Bool

(/=) :: PipelineViewportDepthClipControlCreateInfoEXT -> PipelineViewportDepthClipControlCreateInfoEXT -> Bool

FromCStruct PipelineViewportDepthClipControlCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

peekCStruct :: Ptr PipelineViewportDepthClipControlCreateInfoEXT -> IO PipelineViewportDepthClipControlCreateInfoEXT

ToCStruct PipelineViewportDepthClipControlCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

withCStruct :: PipelineViewportDepthClipControlCreateInfoEXT -> (Ptr PipelineViewportDepthClipControlCreateInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr PipelineViewportDepthClipControlCreateInfoEXT -> PipelineViewportDepthClipControlCreateInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PipelineViewportDepthClipControlCreateInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PipelineViewportDepthClipControlCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineViewportDepthClipControlCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_depth_clip_control

Methods

zero :: PipelineViewportDepthClipControlCreateInfoEXT

type EXT_DEPTH_CLIP_CONTROL_SPEC_VERSION = 1

pattern EXT_DEPTH_CLIP_CONTROL_SPEC_VERSION :: forall a. Integral a => a

type EXT_DEPTH_CLIP_CONTROL_EXTENSION_NAME = "VK_EXT_depth_clip_control"

pattern EXT_DEPTH_CLIP_CONTROL_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a