Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_KHR_ray_tracing_position_fetch

Description

Name

VK_KHR_ray_tracing_position_fetch - device extension

VK_KHR_ray_tracing_position_fetch

Name String: VK_KHR_ray_tracing_position_fetch

Extension Type

Device extension

Registered Extension Number

482

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_acceleration_structure

Contact

Eric Werness

Extension Proposal

VK_KHR_ray_tracing_position_fetch

Other Extension Metadata

Last Modified Date: 2023-02-17

Interactions and External Dependencies

This extension requires SPV_KHR_ray_tracing_position_fetch
This extension provides API support for GLSL_EXT_ray_tracing_position_fetch
Interacts with VK_KHR_ray_tracing_pipeline
Interacts with VK_KHR_ray_query

Contributors

Eric Werness, NVIDIA
Stu Smith, AMD
Yuriy O’Donnell, Epic Games
Ralph Potter, Samsung
Joshua Barczak, Intel
Lionel Landwerlin, Intel
Andrew Garrard, Imagination Technologies
Alex Bourd, Qualcomm
Yunpeng Zhu, Huawei Technologies
Marius Bjorge, Arm
Daniel Koch, NVIDIA

Description

VK_KHR_ray_tracing_position_fetch adds the ability to fetch the vertex positions in the shader from a hit triangle as stored in the acceleration structure.

An application adds BUILD_ACCELERATION_STRUCTURE_ALLOW_DATA_ACCESS_KHR to the acceleration structure at build time. Then, if the hit is a triangle geometry, the shader (any-hit or closest hit for ray pipelines or using ray query) can fetch the three, three-component vertex positions in object space, of the triangle which was hit.

New Structures

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceRayTracingPositionFetchFeaturesKHR

New Enum Constants

KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME

New Built-In Variables

HitTriangleVertexPositionsKHR

New SPIR-V Capabilities

RayTracingPositionFetchKHR

Issues

None Yet!

Version History

Revision 1, 2023-02-17 (Eric Werness)
- internal revisions

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

data PhysicalDeviceRayTracingPositionFetchFeaturesKHR = PhysicalDeviceRayTracingPositionFetchFeaturesKHR {
- rayTracingPositionFetch :: Bool
}
type KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION = 1
pattern KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION :: forall a. Integral a => a
type KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME = "VK_KHR_ray_tracing_position_fetch"
pattern KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
newtype BuildAccelerationStructureFlagBitsKHR where
type BuildAccelerationStructureFlagsKHR = BuildAccelerationStructureFlagBitsKHR

Documentation

data PhysicalDeviceRayTracingPositionFetchFeaturesKHR Source #

VkPhysicalDeviceRayTracingPositionFetchFeaturesKHR - Structure describing support for fetching vertex positions of hit triangles

Members

This structure describes the following feature:

Description

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

Valid Usage (Implicit)

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

type KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION = 1 Source #

pattern KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION :: forall a. Integral a => a Source #

type KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME = "VK_KHR_ray_tracing_position_fetch" Source #

pattern KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

newtype BuildAccelerationStructureFlagBitsKHR Source #

VkBuildAccelerationStructureFlagBitsKHR - Bitmask specifying additional parameters for acceleration structure builds

Description

Note

BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR and BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR may take more time and memory than a normal build, and so should only be used when those features are needed.

pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR	`BUILD_ACCELERATION_STRUCTURE_ALLOW_UPDATE_BIT_KHR` indicates that the specified acceleration structure can be updated with a `mode` of `BUILD_ACCELERATION_STRUCTURE_MODE_UPDATE_KHR` in `AccelerationStructureBuildGeometryInfoKHR` or an `update` of `TRUE` in `cmdBuildAccelerationStructureNV` .
pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR	`BUILD_ACCELERATION_STRUCTURE_ALLOW_COMPACTION_BIT_KHR` indicates that the specified acceleration structure can act as the source for a copy acceleration structure command with `mode` of `COPY_ACCELERATION_STRUCTURE_MODE_COMPACT_KHR` to produce a compacted acceleration structure.
pattern BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR	`BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_TRACE_BIT_KHR` indicates that the given acceleration structure build should prioritize trace performance over build time.
pattern BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR	`BUILD_ACCELERATION_STRUCTURE_PREFER_FAST_BUILD_BIT_KHR` indicates that the given acceleration structure build should prioritize build time over trace performance.
pattern BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_KHR :: BuildAccelerationStructureFlagBitsKHR	`BUILD_ACCELERATION_STRUCTURE_LOW_MEMORY_BIT_KHR` indicates that this acceleration structure should minimize the size of the scratch memory and the final result acceleration structure, potentially at the expense of build time or trace performance.
pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_DATA_ACCESS_KHR :: BuildAccelerationStructureFlagBitsKHR	`BUILD_ACCELERATION_STRUCTURE_ALLOW_DATA_ACCESS_KHR` indicates that the specified acceleration structure can be used when fetching the vertex positions of a hit triangle.
pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_DISPLACEMENT_MICROMAP_UPDATE_NV :: BuildAccelerationStructureFlagBitsKHR	`BUILD_ACCELERATION_STRUCTURE_ALLOW_DISPLACEMENT_MICROMAP_UPDATE_NV` indicates that the displacement micromaps associated with the specified acceleration structure may change with an acceleration structure update.
pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_DATA_UPDATE_EXT :: BuildAccelerationStructureFlagBitsKHR	`BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_DATA_UPDATE_EXT` indicates that the data of the opacity micromaps associated with the specified acceleration structure may change with an acceleration structure update.
pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_DISABLE_OPACITY_MICROMAPS_EXT :: BuildAccelerationStructureFlagBitsKHR	`BUILD_ACCELERATION_STRUCTURE_ALLOW_DISABLE_OPACITY_MICROMAPS_EXT` indicates that the specified acceleration structure may be referenced in an instance with `GEOMETRY_INSTANCE_DISABLE_OPACITY_MICROMAPS_EXT` set.
pattern BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_UPDATE_EXT :: BuildAccelerationStructureFlagBitsKHR	`BUILD_ACCELERATION_STRUCTURE_ALLOW_OPACITY_MICROMAP_UPDATE_EXT` indicates that the opacity micromaps associated with the specified acceleration structure may change with an acceleration structure update.
pattern BUILD_ACCELERATION_STRUCTURE_MOTION_BIT_NV :: BuildAccelerationStructureFlagBitsKHR

Instances

Instances details

Storable BuildAccelerationStructureFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_acceleration_structure Methods sizeOf :: BuildAccelerationStructureFlagBitsKHR -> Int # alignment :: BuildAccelerationStructureFlagBitsKHR -> Int # peekElemOff :: Ptr BuildAccelerationStructureFlagBitsKHR -> Int -> IO BuildAccelerationStructureFlagBitsKHR # pokeElemOff :: Ptr BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR -> IO () # peekByteOff :: Ptr b -> Int -> IO BuildAccelerationStructureFlagBitsKHR # pokeByteOff :: Ptr b -> Int -> BuildAccelerationStructureFlagBitsKHR -> IO () # peek :: Ptr BuildAccelerationStructureFlagBitsKHR -> IO BuildAccelerationStructureFlagBitsKHR # poke :: Ptr BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> IO () #
Bits BuildAccelerationStructureFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_acceleration_structure Methods (.&.) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR # (.\|.) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR # xor :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR # complement :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR # shift :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # rotate :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # zeroBits :: BuildAccelerationStructureFlagBitsKHR # bit :: Int -> BuildAccelerationStructureFlagBitsKHR # setBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # clearBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # complementBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # testBit :: BuildAccelerationStructureFlagBitsKHR -> Int -> Bool # bitSizeMaybe :: BuildAccelerationStructureFlagBitsKHR -> Maybe Int # bitSize :: BuildAccelerationStructureFlagBitsKHR -> Int # isSigned :: BuildAccelerationStructureFlagBitsKHR -> Bool # shiftL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # unsafeShiftL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # shiftR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # unsafeShiftR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # rotateL :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # rotateR :: BuildAccelerationStructureFlagBitsKHR -> Int -> BuildAccelerationStructureFlagBitsKHR # popCount :: BuildAccelerationStructureFlagBitsKHR -> Int #
FiniteBits BuildAccelerationStructureFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_acceleration_structure Methods finiteBitSize :: BuildAccelerationStructureFlagBitsKHR -> Int # countLeadingZeros :: BuildAccelerationStructureFlagBitsKHR -> Int # countTrailingZeros :: BuildAccelerationStructureFlagBitsKHR -> Int #
Read BuildAccelerationStructureFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_acceleration_structure Methods readsPrec :: Int -> ReadS BuildAccelerationStructureFlagBitsKHR # readList :: ReadS [BuildAccelerationStructureFlagBitsKHR] # readPrec :: ReadPrec BuildAccelerationStructureFlagBitsKHR # readListPrec :: ReadPrec [BuildAccelerationStructureFlagBitsKHR] #
Show BuildAccelerationStructureFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_acceleration_structure Methods showsPrec :: Int -> BuildAccelerationStructureFlagBitsKHR -> ShowS # show :: BuildAccelerationStructureFlagBitsKHR -> String # showList :: [BuildAccelerationStructureFlagBitsKHR] -> ShowS #
Eq BuildAccelerationStructureFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_acceleration_structure Methods (==) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Bool # (/=) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Bool #
Ord BuildAccelerationStructureFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_acceleration_structure Methods compare :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Ordering # (<) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Bool # (<=) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Bool # (>) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Bool # (>=) :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> Bool # max :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR # min :: BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR -> BuildAccelerationStructureFlagBitsKHR #
Zero BuildAccelerationStructureFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_acceleration_structure Methods zero :: BuildAccelerationStructureFlagBitsKHR Source #

type BuildAccelerationStructureFlagsKHR = BuildAccelerationStructureFlagBitsKHR Source #

Name

VK_KHR_ray_tracing_position_fetch

Other Extension Metadata

Description

New Structures

New Enum Constants

New Built-In Variables

New SPIR-V Capabilities

Issues

Version History

See Also

Document Notes

Documentation

Members

Description

Valid Usage (Implicit)

See Also

Instances

Description

See Also

Instances

PhysicalDeviceRayTracingPositionFetchFeaturesKHR
Fields rayTracingPositionFetch :: Bool `rayTracingPositionFetch` indicates that the implementation supports fetching the object space vertex positions of a hit triangle.