Safe Haskell | None |
---|---|
Language | Haskell2010 |
Name
XR_KHR_D3D12_enable - instance extension
Specification
See XR_KHR_D3D12_enable in the main specification for complete information.
Registered Extension Number
29
Revision
7
Extension and Version Dependencies
- Requires OpenXR 1.0
See Also
GraphicsBindingD3D12KHR
, GraphicsRequirementsD3D12KHR
,
SwapchainImageD3D12KHR
, getD3D12GraphicsRequirementsKHR
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
- getD3D12GraphicsRequirementsKHR :: forall io. MonadIO io => Instance -> SystemId -> io GraphicsRequirementsD3D12KHR
- data GraphicsBindingD3D12KHR = GraphicsBindingD3D12KHR {}
- data SwapchainImageD3D12KHR = SwapchainImageD3D12KHR {}
- data GraphicsRequirementsD3D12KHR = GraphicsRequirementsD3D12KHR {}
- type KHR_D3D12_enable_SPEC_VERSION = 7
- pattern KHR_D3D12_enable_SPEC_VERSION :: forall a. Integral a => a
- type KHR_D3D12_ENABLE_EXTENSION_NAME = "XR_KHR_D3D12_enable"
- pattern KHR_D3D12_ENABLE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
- data ID3D12CommandQueue
- data ID3D12Device
- data ID3D12Resource
- type LUID = Word64
- type D3D_FEATURE_LEVEL = Word32
Documentation
getD3D12GraphicsRequirementsKHR Source #
:: forall io. MonadIO io | |
=> Instance |
|
-> SystemId |
|
-> io GraphicsRequirementsD3D12KHR |
xrGetD3D12GraphicsRequirementsKHR - Retrieve the D3D12 feature level and graphics device requirements for an instance and system
Parameter Descriptions
Description
The getD3D12GraphicsRequirementsKHR
function identifies to the
application what graphics device (Windows LUID) needs to be used and the
minimum feature level to use. The runtime must return
ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING
(ERROR_VALIDATION_FAILURE
may be returned
due to legacy behavior) on calls to createSession
if getD3D12GraphicsRequirementsKHR
has not been called for the same
instance
and systemId
. The LUID and feature level that
getD3D12GraphicsRequirementsKHR
returns should be used to create the
ID3D12Device
that the application passes to
createSession
in the GraphicsBindingD3D12KHR
.
Valid Usage (Implicit)
- The @@
extension must be enabled prior to calling
getD3D12GraphicsRequirementsKHR
-
instance
must be a validInstance
handle -
graphicsRequirements
must be a pointer to anGraphicsRequirementsD3D12KHR
structure
Return Codes
See Also
GraphicsRequirementsD3D12KHR
, Instance
,
https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrSystemId,
createSession
data GraphicsBindingD3D12KHR Source #
XrGraphicsBindingD3D12KHR - The graphics binding structure to be passed at session creation to use D3D12
Member Descriptions
Description
When creating a D3D12-backed Session
, the
application will provide a pointer to an GraphicsBindingD3D12KHR
in
the next
chain of the SessionCreateInfo
.
Valid Usage (Implicit)
- The @@
extension must be enabled prior to using
GraphicsBindingD3D12KHR
-
type
must beTYPE_GRAPHICS_BINDING_D3D12_KHR
-
next
must beNULL
or a valid pointer to the next structure in a structure chain -
device
must be a pointer to anID3D12Device
value -
queue
must be a pointer to anID3D12CommandQueue
value
See Also
GraphicsBindingD3D12KHR | |
|
Instances
data SwapchainImageD3D12KHR Source #
XrSwapchainImageD3D12KHR - D3D12-specific swapchain image structure
Member Descriptions
Description
If a given session was created with GraphicsBindingD3D12KHR
, the
following conditions must apply.
- Calls to
enumerateSwapchainImages
on anSwapchain
in that session must return an array ofSwapchainImageD3D12KHR
structures. - Whenever an OpenXR function accepts an
SwapchainImageBaseHeader
pointer as a parameter in that session, the runtime must also accept a pointer to anSwapchainImageD3D12KHR
.
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 up, near Z plane at 0, and far Z plane at 1.
Valid Usage (Implicit)
- The @@
extension must be enabled prior to using
SwapchainImageD3D12KHR
-
type
must beTYPE_SWAPCHAIN_IMAGE_D3D12_KHR
-
next
must beNULL
or a valid pointer to the next structure in a structure chain -
texture
must be a pointer to anID3D12Resource
value
See Also
SwapchainImageD3D12KHR | |
|
Instances
data GraphicsRequirementsD3D12KHR Source #
XrGraphicsRequirementsD3D12KHR - D3D12 feature level and LUID requirements
Member Descriptions
Description
GraphicsRequirementsD3D12KHR
is populated by
getD3D12GraphicsRequirementsKHR
.
Valid Usage (Implicit)
- The @@
extension must be enabled prior to using
GraphicsRequirementsD3D12KHR
-
type
must beTYPE_GRAPHICS_REQUIREMENTS_D3D12_KHR
-
next
must beNULL
or a valid pointer to the next structure in a structure chain -
adapterLuid
must be a validLUID
value -
minFeatureLevel
must be a validD3D_FEATURE_LEVEL
value
See Also
GraphicsRequirementsD3D12KHR | |
|
Instances
type KHR_D3D12_enable_SPEC_VERSION = 7 Source #
pattern KHR_D3D12_enable_SPEC_VERSION :: forall a. Integral a => a Source #
type KHR_D3D12_ENABLE_EXTENSION_NAME = "XR_KHR_D3D12_enable" Source #
pattern KHR_D3D12_ENABLE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #
data ID3D12CommandQueue Source #
data ID3D12Device Source #
data ID3D12Resource Source #
type D3D_FEATURE_LEVEL = Word32 Source #