Vulkan.Extensions.VK_KHR_shader_clock

Name

VK_KHR_shader_clock - device extension

VK_KHR_shader_clock

Name String

VK_KHR_shader_clock

Extension Type

Device extension

Registered Extension Number

182

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2

Contact

• Aaron Hagan @ahagan%0A<<Here describe the issue or question you have about the VK_KHR_shader_clock extension> >

Other Extension Metadata

Last Modified Date

2019-4-25

IP Status

No known IP claims.

Interactions and External Dependencies

• This extension requires SPV_KHR_shader_clock.
• This extension provides API support for ARB_shader_clock and EXT_shader_realtime_clock

Contributors

• Aaron Hagan, AMD
• Daniel Koch, NVIDIA

Description

This extension advertises the SPIR-V ShaderClockKHR capability for Vulkan, which allows a shader to query a real-time or monotonically incrementing counter at the subgroup level or across the device level. The two valid SPIR-V scopes for OpReadClockKHR are Subgroup and Device.

When using GLSL source-based shading languages, the clockRealtime*EXT() timing functions map to the OpReadClockKHR instruction with a scope of Device, and the clock*ARB() timing functions map to the OpReadClockKHR instruction with a scope of Subgroup.

New Structures

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceShaderClockFeaturesKHR

New Enum Constants

• KHR_SHADER_CLOCK_EXTENSION_NAME

• KHR_SHADER_CLOCK_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_CLOCK_FEATURES_KHR

New SPIR-V Capabilities

• ShaderClockKHR

Version History

• Revision 1, 2019-4-25 (Aaron Hagan)

  • Initial revision

See Also

PhysicalDeviceShaderClockFeaturesKHR

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 PhysicalDeviceShaderClockFeaturesKHR

VkPhysicalDeviceShaderClockFeaturesKHR - Structure describing features supported by VK_KHR_shader_clock

Members

This structure describes the following features:

Description

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

Valid Usage (Implicit)

See Also

VK_KHR_shader_clock, Bool32, StructureType

Constructors

PhysicalDeviceShaderClockFeaturesKHR

Fields

• shaderSubgroupClock :: Bool

  shaderSubgroupClock indicates whether shaders can perform Subgroup scoped clock reads.

• shaderDeviceClock :: Bool

  shaderDeviceClock indicates whether shaders can perform Device scoped clock reads.

Instances

Eq PhysicalDeviceShaderClockFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_shader_clock

Methods

(==) :: PhysicalDeviceShaderClockFeaturesKHR -> PhysicalDeviceShaderClockFeaturesKHR -> Bool

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

Show PhysicalDeviceShaderClockFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_shader_clock

Methods

showsPrec :: Int -> PhysicalDeviceShaderClockFeaturesKHR -> ShowS

show :: PhysicalDeviceShaderClockFeaturesKHR -> String

showList :: [PhysicalDeviceShaderClockFeaturesKHR] -> ShowS

Storable PhysicalDeviceShaderClockFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_shader_clock

Methods

sizeOf :: PhysicalDeviceShaderClockFeaturesKHR -> Int

alignment :: PhysicalDeviceShaderClockFeaturesKHR -> Int

peekElemOff :: Ptr PhysicalDeviceShaderClockFeaturesKHR -> Int -> IO PhysicalDeviceShaderClockFeaturesKHR

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

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

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

peek :: Ptr PhysicalDeviceShaderClockFeaturesKHR -> IO PhysicalDeviceShaderClockFeaturesKHR

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

FromCStruct PhysicalDeviceShaderClockFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_shader_clock

Methods

peekCStruct :: Ptr PhysicalDeviceShaderClockFeaturesKHR -> IO PhysicalDeviceShaderClockFeaturesKHR

ToCStruct PhysicalDeviceShaderClockFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_shader_clock

Methods

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

pokeCStruct :: Ptr PhysicalDeviceShaderClockFeaturesKHR -> PhysicalDeviceShaderClockFeaturesKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceShaderClockFeaturesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceShaderClockFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_shader_clock

Methods

zero :: PhysicalDeviceShaderClockFeaturesKHR

type KHR_SHADER_CLOCK_SPEC_VERSION = 1

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

type KHR_SHADER_CLOCK_EXTENSION_NAME = "VK_KHR_shader_clock"

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