Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_depth_bias_control

Description

Name

VK_EXT_depth_bias_control - device extension

VK_EXT_depth_bias_control

Name String: VK_EXT_depth_bias_control

Extension Type

Device extension

Registered Extension Number

284

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Vulkan Version 1.1

Special Use

D3D support

Contact

Joshua Ashton @Joshua-Ashton%0A*Here describe the issue or question you have about the VK_EXT_depth_bias_control extension*

Extension Proposal

VK_EXT_depth_bias_control

Other Extension Metadata

Last Modified Date: 2023-02-15

IP Status

No known IP claims.

Contributors

Joshua Ashton, VALVE
Hans-Kristian Arntzen, VALVE
Mike Blumenkrantz, VALVE
Georg Lehmann, VALVE
Piers Daniell, NVIDIA
Lionel Landwerlin, INTEL
Tobias Hector, AMD
Ricardo Garcia, IGALIA
Jan-Harald Fredriksen, ARM
Shahbaz Youssefi, GOOGLE
Tom Olson, ARM

Description

This extension adds a new structure, DepthBiasRepresentationInfoEXT, that can be added to a pNext chain of PipelineRasterizationStateCreateInfo and allows setting the scaling and representation of depth bias for a pipeline.

This state can also be set dynamically by using the new structure mentioned above in combination with the new cmdSetDepthBias2EXT command.

New Commands

cmdSetDepthBias2EXT

New Structures

DepthBiasInfoEXT

Extending DepthBiasInfoEXT, PipelineRasterizationStateCreateInfo:
- DepthBiasRepresentationInfoEXT
Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceDepthBiasControlFeaturesEXT

New Enums

DepthBiasRepresentationEXT

New Enum Constants

EXT_DEPTH_BIAS_CONTROL_EXTENSION_NAME

Version History

Revision 1, 2022-09-22 (Joshua Ashton)
- 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

cmdSetDepthBias2EXT :: forall (a :: [Type]) io. (Extendss DepthBiasInfoEXT a, PokeChain a, MonadIO io) => CommandBuffer -> DepthBiasInfoEXT a -> io ()
data DepthBiasInfoEXT (es :: [Type]) = DepthBiasInfoEXT {
- next :: Chain es
- depthBiasConstantFactor :: Float
- depthBiasClamp :: Float
- depthBiasSlopeFactor :: Float
}
data DepthBiasRepresentationInfoEXT = DepthBiasRepresentationInfoEXT {
- depthBiasRepresentation :: DepthBiasRepresentationEXT
- depthBiasExact :: Bool
}
data PhysicalDeviceDepthBiasControlFeaturesEXT = PhysicalDeviceDepthBiasControlFeaturesEXT {
}
newtype DepthBiasRepresentationEXT where
type EXT_DEPTH_BIAS_CONTROL_SPEC_VERSION = 1
pattern EXT_DEPTH_BIAS_CONTROL_SPEC_VERSION :: Integral a => a
type EXT_DEPTH_BIAS_CONTROL_EXTENSION_NAME = "VK_EXT_depth_bias_control"
pattern EXT_DEPTH_BIAS_CONTROL_EXTENSION_NAME :: (Eq a, IsString a) => a

Documentation

cmdSetDepthBias2EXT Source #

Arguments

:: forall (a :: [Type]) io. (Extendss DepthBiasInfoEXT a, PokeChain a, MonadIO io)
=> CommandBuffer	`commandBuffer` is the command buffer into which the command will be recorded.
-> DepthBiasInfoEXT a	`pDepthBiasInfo` is a pointer to a `DepthBiasInfoEXT` structure specifying depth bias parameters.
-> io ()

vkCmdSetDepthBias2EXT - Set depth bias factors and clamp dynamically for a command buffer

Description

This command is functionally identical to cmdSetDepthBias, but includes extensible sub-structures that include sType and pNext parameters, allowing them to be more easily extended.

Valid Usage (Implicit)

commandBuffer must be a valid CommandBuffer handle

pDepthBiasInfo must be a valid pointer to a valid DepthBiasInfoEXT structure
commandBuffer must be in the recording state
The CommandPool that commandBuffer was allocated from must support QUEUE_GRAPHICS_BIT 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	VK_QUEUE_GRAPHICS_BIT	State

Conditional Rendering

vkCmdSetDepthBias2EXT is not affected by conditional rendering

Description

If pNext does not contain a DepthBiasRepresentationInfoEXT structure, then this command is equivalent to including a DepthBiasRepresentationInfoEXT with depthBiasExact set to FALSE and depthBiasRepresentation set to DEPTH_BIAS_REPRESENTATION_LEAST_REPRESENTABLE_VALUE_FORMAT_EXT.

Valid Usage

If the depthBiasClamp feature is not enabled, depthBiasClamp must be 0.0

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_DEPTH_BIAS_INFO_EXT

pNext must be NULL or a pointer to a valid instance of DepthBiasRepresentationInfoEXT
The sType value of each structure in the pNext chain must be unique

Members

This structure describes the following feature:

Valid Usage (Implicit)

depthBiasControl :: Bool
depthBiasControl indicates whether the implementation supports the cmdSetDepthBias2EXT command and the DepthBiasRepresentationInfoEXT structure.
leastRepresentableValueForceUnormRepresentation :: Bool
leastRepresentableValueForceUnormRepresentation indicates whether the implementation supports using the DEPTH_BIAS_REPRESENTATION_LEAST_REPRESENTABLE_VALUE_FORCE_UNORM_EXT depth bias representation.
floatRepresentation :: Bool
floatRepresentation indicates whether the implementation supports using the DEPTH_BIAS_REPRESENTATION_FLOAT_EXT depth bias representation.
depthBiasExact :: Bool
depthBiasExact indicates whether the implementation supports forcing depth bias to not be scaled to ensure a minimum resolvable difference using DepthBiasRepresentationInfoEXT::depthBiasExact.

Instances

Instances details

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

newtype DepthBiasRepresentationEXT Source #

VkDepthBiasRepresentationEXT - Specify the depth bias representation

Description

DEPTH_BIAS_REPRESENTATION_LEAST_REPRESENTABLE_VALUE_FORMAT_EXT specifies that the depth bias representation is a factor of the format’s r as described in https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#primsrast-depthbias-computation.

DEPTH_BIAS_REPRESENTATION_LEAST_REPRESENTABLE_VALUE_FORCE_UNORM_EXT specifies that the depth bias representation is a factor of a constant r defined by the bit-size or mantissa of the format as described in https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#primsrast-depthbias-computation.
DEPTH_BIAS_REPRESENTATION_FLOAT_EXT specifies that the depth bias representation is a factor of constant r equal to 1.

Extensible DepthBiasInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_bias_control Methods extensibleTypeName :: String Source # getNext :: forall (es :: [Type]). DepthBiasInfoEXT es -> Chain es Source # setNext :: forall (ds :: [Type]) (es :: [Type]). DepthBiasInfoEXT ds -> Chain es -> DepthBiasInfoEXT es Source # extends :: forall e b proxy. Typeable e => proxy e -> (Extends DepthBiasInfoEXT e => b) -> Maybe b Source #
Show (Chain es) => Show (DepthBiasInfoEXT es) Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_bias_control Methods showsPrec :: Int -> DepthBiasInfoEXT es -> ShowS # show :: DepthBiasInfoEXT es -> String # showList :: [DepthBiasInfoEXT es] -> ShowS #
(Extendss DepthBiasInfoEXT es, PeekChain es) => FromCStruct (DepthBiasInfoEXT es) Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_bias_control Methods peekCStruct :: Ptr (DepthBiasInfoEXT es) -> IO (DepthBiasInfoEXT es) Source #
(Extendss DepthBiasInfoEXT es, PokeChain es) => ToCStruct (DepthBiasInfoEXT es) Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_bias_control Methods withCStruct :: DepthBiasInfoEXT es -> (Ptr (DepthBiasInfoEXT es) -> IO b) -> IO b Source # pokeCStruct :: Ptr (DepthBiasInfoEXT es) -> DepthBiasInfoEXT es -> IO b -> IO b Source # withZeroCStruct :: (Ptr (DepthBiasInfoEXT es) -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr (DepthBiasInfoEXT es) -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
es ~ ('[] :: [Type]) => Zero (DepthBiasInfoEXT es) Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_depth_bias_control Methods zero :: DepthBiasInfoEXT es Source #

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

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

Name

VK_EXT_depth_bias_control

Other Extension Metadata

Description

New Commands

New Structures

New Enums

New Enum Constants

Version History

See Also

Document Notes

Documentation

Description

Valid Usage (Implicit)

Host Synchronization

Command Properties

Conditional Rendering

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Members

Valid Usage (Implicit)

See Also

Instances

Description

See Also

Instances

DepthBiasRepresentationInfoEXT
Fields depthBiasRepresentation :: DepthBiasRepresentationEXT `depthBiasRepresentation` is a `DepthBiasRepresentationEXT` value specifying the depth bias representation. depthBiasExact :: Bool `depthBiasExact` specifies that the implementation is not allowed to scale the depth bias value to ensure a minimum resolvable distance.

pattern DEPTH_BIAS_REPRESENTATION_LEAST_REPRESENTABLE_VALUE_FORMAT_EXT :: DepthBiasRepresentationEXT
pattern DEPTH_BIAS_REPRESENTATION_LEAST_REPRESENTABLE_VALUE_FORCE_UNORM_EXT :: DepthBiasRepresentationEXT
pattern DEPTH_BIAS_REPRESENTATION_FLOAT_EXT :: DepthBiasRepresentationEXT