Safe Haskell	None
Language	Haskell2010

OpenXR.Extensions.XR_KHR_vulkan_enable

Description

Name

XR_KHR_vulkan_enable - instance extension

Specification

See XR_KHR_vulkan_enable in the main specification for complete information.

Registered Extension Number

26

Revision

7

Extension and Version Dependencies

Requires OpenXR 1.0

Document Notes

For more information, see the OpenXR Specification

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

Synopsis

getVulkanInstanceExtensionsKHR :: forall io. MonadIO io => Instance -> SystemId -> io ("buffer" ::: ByteString)
getVulkanDeviceExtensionsKHR :: forall io. MonadIO io => Instance -> SystemId -> io ("buffer" ::: ByteString)
getVulkanGraphicsDeviceKHR :: forall io. MonadIO io => Instance -> SystemId -> ("vkInstance" ::: Ptr Instance_T) -> io ("vkPhysicalDevice" ::: Ptr PhysicalDevice_T)
getVulkanGraphicsRequirementsKHR :: forall io. MonadIO io => Instance -> SystemId -> io GraphicsRequirementsVulkanKHR
data GraphicsBindingVulkanKHR = GraphicsBindingVulkanKHR {
- instance' :: Ptr Instance_T
- physicalDevice :: Ptr PhysicalDevice_T
- device :: Ptr Device_T
- queueFamilyIndex :: Word32
- queueIndex :: Word32
}
data SwapchainImageVulkanKHR = SwapchainImageVulkanKHR {
- image :: Image
}
data GraphicsRequirementsVulkanKHR = GraphicsRequirementsVulkanKHR {
- minApiVersionSupported :: Version
- maxApiVersionSupported :: Version
}
type KHR_vulkan_enable_SPEC_VERSION = 7
pattern KHR_vulkan_enable_SPEC_VERSION :: forall a. Integral a => a
type KHR_VULKAN_ENABLE_EXTENSION_NAME = "XR_KHR_vulkan_enable"
pattern KHR_VULKAN_ENABLE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

getVulkanInstanceExtensionsKHR :: forall io. MonadIO io => Instance -> SystemId -> io ("buffer" ::: ByteString) Source #

xrGetVulkanInstanceExtensionsKHR - Get list of required Vulkan instance extensions for an OpenXR instance and system

Parameter Descriptions

instance is an Instance handle previously created with createInstance.

systemId is an https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrSystemId handle for the system which will be used to create a session.
bufferCapacityInput is the capacity of the buffer, or 0 to indicate a request to retrieve the required capacity.
bufferCountOutput is a pointer to the count of characters written (including terminating \0), or a pointer to the required capacity in the case that bufferCapacityInput is 0.
buffer is a pointer to an array of characters, but can be NULL if bufferCapacityInput is 0. The format of the output is a single space (ASCII 0x20) delimited string of extension names.
See Buffer Size Parameters chapter for a detailed description of retrieving the required buffer size.

Valid Usage (Implicit)

The @@ extension must be enabled prior to calling getVulkanInstanceExtensionsKHR

instance must be a valid Instance handle
bufferCountOutput must be a pointer to a uint32_t value
If bufferCapacityInput is not 0, buffer must be a pointer to an array of bufferCapacityInput null-terminated UTF-8 strings

Return Codes

Success

SUCCESS

Failure

Description

getVulkanGraphicsDeviceKHR function identifies to the application what graphics device (Vulkan VkPhysicalDevice) needs to be used. getVulkanGraphicsDeviceKHR must be called prior to calling createSession, and the VkPhysicalDevice that getVulkanGraphicsDeviceKHR returns should be passed to createSession in the GraphicsBindingVulkanKHR.

Valid Usage (Implicit)

The @@ extension must be enabled prior to calling getVulkanGraphicsDeviceKHR

instance must be a valid Instance handle
vkInstance must be a valid VkInstance value
vkPhysicalDevice must be a pointer to a VkPhysicalDevice value

Return Codes

Success

SUCCESS

Failure

Description

The getVulkanGraphicsRequirementsKHR function identifies to the application the minimum Vulkan version requirement and the highest known tested Vulkan version. The runtime must return ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING (ERROR_VALIDATION_FAILURE may be returned due to legacy behavior) on calls to createSession if getVulkanGraphicsRequirementsKHR has not been called for the same instance and systemId.

Valid Usage (Implicit)

The @@ extension must be enabled prior to calling getVulkanGraphicsRequirementsKHR

instance must be a valid Instance handle
graphicsRequirements must be a pointer to an GraphicsRequirementsVulkanKHR structure

Return Codes

Success

SUCCESS

Failure

Description

When creating a Vulkan-backed Session, the application will provide a pointer to an GraphicsBindingVulkanKHR in the next chain of the SessionCreateInfo.

Valid Usage

instance must have enabled a Vulkan API version in the range specified by GraphicsBindingVulkanKHR

instance must have enabled all the instance extensions specified by getVulkanInstanceExtensionsKHR
physicalDevice VkPhysicalDevice must match the device specified by getVulkanGraphicsDeviceKHR
device must have enabled all the device extensions specified by getVulkanDeviceExtensionsKHR

Valid Usage (Implicit)

The @@ extension must be enabled prior to using GraphicsBindingVulkanKHR

type must be TYPE_GRAPHICS_BINDING_VULKAN_KHR
next must be NULL or a valid pointer to the next structure in a structure chain
instance must be a valid VkInstance value
physicalDevice must be a valid VkPhysicalDevice value
device must be a valid VkDevice value

Description

If a given session was created with GraphicsBindingVulkanKHR, the following conditions must apply.

Calls to enumerateSwapchainImages on an Swapchain in that session must return an array of SwapchainImageVulkanKHR structures.
Whenever an OpenXR function accepts an SwapchainImageBaseHeader pointer as a parameter in that session, the runtime must also accept a pointer to an SwapchainImageVulkanKHR.

The OpenXR runtime must interpret the top-left corner of the swapchain image as the coordinate origin unless specified otherwise by extension functionality.

The OpenXR runtime must interpret the swapchain images in a clip space of positive Y pointing down, near Z plane at 0, and far Z plane at 1.

Valid Usage (Implicit)

The @@ extension must be enabled prior to using SwapchainImageVulkanKHR

type must be TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR
next must be NULL or a valid pointer to the next structure in a structure chain
image must be a valid VkImage value

Description

GraphicsRequirementsVulkanKHR is populated by getVulkanGraphicsRequirementsKHR with the runtime’s Vulkan API version requirements.

Valid Usage (Implicit)

The @@ extension must be enabled prior to using GraphicsRequirementsVulkanKHR

type must be TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR
next must be NULL or a valid pointer to the next structure in a structure chain

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

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

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

:: forall io. MonadIO io
=> Instance	`instance` is an `Instance` handle previously created with `createInstance`.
-> SystemId	`systemId` is an https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrSystemId handle for the system which will be used to create a session.
-> ("vkInstance" ::: Ptr Instance_T)	`vkInstance` is a valid Vulkan `VkInstance`.
-> io ("vkPhysicalDevice" ::: Ptr PhysicalDevice_T)

SwapchainImageVulkanKHR
Fields image :: Image `image` is a valid Vulkan `VkImage` to use.

Name

Specification

Registered Extension Number

Revision

Extension and Version Dependencies

See Also

Document Notes

Documentation

Parameter Descriptions

Valid Usage (Implicit)

Return Codes

See Also

Parameter Descriptions

Valid Usage (Implicit)

Return Codes

See Also

Parameter Descriptions

Description

Valid Usage (Implicit)

Return Codes

See Also

Parameter Descriptions

Description

Valid Usage (Implicit)

Return Codes

See Also

Member Descriptions

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Member Descriptions

Description

Valid Usage (Implicit)

See Also

Instances

Member Descriptions

Description

Valid Usage (Implicit)

See Also

Instances