Safe Haskell	None
Language	Haskell2010

OpenXR.Extensions.XR_KHR_D3D12_enable

Description

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

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 {
- device :: Ptr ID3D12Device
- queue :: Ptr ID3D12CommandQueue
}
data SwapchainImageD3D12KHR = SwapchainImageD3D12KHR {
- texture :: Ptr ID3D12Resource
}
data GraphicsRequirementsD3D12KHR = GraphicsRequirementsD3D12KHR {
- adapterLuid :: LUID
- minFeatureLevel :: D3D_FEATURE_LEVEL
}
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 #

Arguments

:: 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.
-> 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 valid Instance handle
graphicsRequirements must be a pointer to an GraphicsRequirementsD3D12KHR structure

Return Codes

Success

SUCCESS

Failure

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 be TYPE_GRAPHICS_BINDING_D3D12_KHR
next must be NULL or a valid pointer to the next structure in a structure chain
device must be a pointer to an ID3D12Device value
queue must be a pointer to an ID3D12CommandQueue value

Description

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

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

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 be TYPE_SWAPCHAIN_IMAGE_D3D12_KHR
next must be NULL or a valid pointer to the next structure in a structure chain
texture must be a pointer to an ID3D12Resource value

Description

GraphicsRequirementsD3D12KHR is populated by getD3D12GraphicsRequirementsKHR.

Valid Usage (Implicit)

The @@ extension must be enabled prior to using GraphicsRequirementsD3D12KHR

type must be TYPE_GRAPHICS_REQUIREMENTS_D3D12_KHR
next must be NULL or a valid pointer to the next structure in a structure chain
adapterLuid must be a valid LUID value
minFeatureLevel must be a valid D3D_FEATURE_LEVEL value

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

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 LUID = Word64 Source #

type D3D_FEATURE_LEVEL = Word32 Source #

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

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

Name

Specification

Registered Extension Number

Revision

Extension and Version Dependencies

See Also

Document Notes

Documentation

Parameter Descriptions

Description

Valid Usage (Implicit)

Return Codes

See Also

Member Descriptions

Description

Valid Usage (Implicit)

See Also

Instances

Member Descriptions

Description

Valid Usage (Implicit)

See Also

Instances

Member Descriptions

Description

Valid Usage (Implicit)

See Also

Instances

GraphicsBindingD3D12KHR
Fields device :: Ptr ID3D12Device `device` is a pointer to a valid `ID3D12Device` to use. queue :: Ptr ID3D12CommandQueue `queue` is a pointer to a valid `ID3D12CommandQueue` to use.

SwapchainImageD3D12KHR
Fields texture :: Ptr ID3D12Resource `texture` is a pointer to a valid `ID3D12Texture2D` to use.

GraphicsRequirementsD3D12KHR
Fields adapterLuid :: LUID `adapterLuid` identifies what graphics device needs to be used. minFeatureLevel :: D3D_FEATURE_LEVEL `minFeatureLevel` is the minimum feature level that the D3D12 device must be initialized with.