Safe Haskell	None
Language	Haskell2010

OpenXR.Extensions.XR_KHR_D3D11_enable

Description

Name

XR_KHR_D3D11_enable - instance extension

Specification

See XR_KHR_D3D11_enable in the main specification for complete information.

Registered Extension Number

28

Revision

5

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

getD3D11GraphicsRequirementsKHR :: forall io. MonadIO io => Instance -> SystemId -> io GraphicsRequirementsD3D11KHR
data GraphicsBindingD3D11KHR = GraphicsBindingD3D11KHR {
- device :: Ptr ID3D11Device
}
data SwapchainImageD3D11KHR = SwapchainImageD3D11KHR {
- texture :: Ptr ID3D11Texture2D
}
data GraphicsRequirementsD3D11KHR = GraphicsRequirementsD3D11KHR {
- adapterLuid :: LUID
- minFeatureLevel :: D3D_FEATURE_LEVEL
}
type KHR_D3D11_enable_SPEC_VERSION = 5
pattern KHR_D3D11_enable_SPEC_VERSION :: forall a. Integral a => a
type KHR_D3D11_ENABLE_EXTENSION_NAME = "XR_KHR_D3D11_enable"
pattern KHR_D3D11_ENABLE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
type LUID = Word64
type D3D_FEATURE_LEVEL = Word32
data ID3D11Device
data ID3D11Texture2D

Documentation

getD3D11GraphicsRequirementsKHR 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 GraphicsRequirementsD3D11KHR

xrGetD3D11GraphicsRequirementsKHR - Retrieve the D3D11 feature level and graphics device requirements for an instance and system

Parameter Descriptions

Description

The getD3D11GraphicsRequirementsKHR 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 getD3D11GraphicsRequirementsKHR has not been called for the same instance and systemId. The LUID and feature level that getD3D11GraphicsRequirementsKHR returns should be used to create the ID3D11Device that the application passes to createSession in the GraphicsBindingD3D11KHR.

Valid Usage (Implicit)

The @@ extension must be enabled prior to calling getD3D11GraphicsRequirementsKHR

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

Return Codes

Success

SUCCESS

Failure

Description

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

Valid Usage (Implicit)

The @@ extension must be enabled prior to using GraphicsBindingD3D11KHR

type must be TYPE_GRAPHICS_BINDING_D3D11_KHR
next must be NULL or a valid pointer to the next structure in a structure chain
device must be a pointer to an ID3D11Device value

Description

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

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

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 SwapchainImageD3D11KHR

type must be TYPE_SWAPCHAIN_IMAGE_D3D11_KHR
next must be NULL or a valid pointer to the next structure in a structure chain
texture must be a pointer to an ID3D11Texture2D value

Description

GraphicsRequirementsD3D11KHR is populated by getD3D11GraphicsRequirementsKHR.

Valid Usage (Implicit)

The @@ extension must be enabled prior to using GraphicsRequirementsD3D11KHR

type must be TYPE_GRAPHICS_REQUIREMENTS_D3D11_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 GraphicsRequirementsD3D11KHR Source #
Instance details Defined in OpenXR.Extensions.XR_KHR_D3D11_enable Methods (==) :: GraphicsRequirementsD3D11KHR -> GraphicsRequirementsD3D11KHR -> Bool # (/=) :: GraphicsRequirementsD3D11KHR -> GraphicsRequirementsD3D11KHR -> Bool #
Show GraphicsRequirementsD3D11KHR Source #
Instance details Defined in OpenXR.Extensions.XR_KHR_D3D11_enable Methods showsPrec :: Int -> GraphicsRequirementsD3D11KHR -> ShowS # show :: GraphicsRequirementsD3D11KHR -> String # showList :: [GraphicsRequirementsD3D11KHR] -> ShowS #
Storable GraphicsRequirementsD3D11KHR Source #
Instance details Defined in OpenXR.Extensions.XR_KHR_D3D11_enable Methods sizeOf :: GraphicsRequirementsD3D11KHR -> Int # alignment :: GraphicsRequirementsD3D11KHR -> Int # peekElemOff :: Ptr GraphicsRequirementsD3D11KHR -> Int -> IO GraphicsRequirementsD3D11KHR # pokeElemOff :: Ptr GraphicsRequirementsD3D11KHR -> Int -> GraphicsRequirementsD3D11KHR -> IO () # peekByteOff :: Ptr b -> Int -> IO GraphicsRequirementsD3D11KHR # pokeByteOff :: Ptr b -> Int -> GraphicsRequirementsD3D11KHR -> IO () # peek :: Ptr GraphicsRequirementsD3D11KHR -> IO GraphicsRequirementsD3D11KHR # poke :: Ptr GraphicsRequirementsD3D11KHR -> GraphicsRequirementsD3D11KHR -> IO () #
Zero GraphicsRequirementsD3D11KHR Source #
Instance details Defined in OpenXR.Extensions.XR_KHR_D3D11_enable Methods zero :: GraphicsRequirementsD3D11KHR #
ToCStruct GraphicsRequirementsD3D11KHR Source #
Instance details Defined in OpenXR.Extensions.XR_KHR_D3D11_enable Methods withCStruct :: GraphicsRequirementsD3D11KHR -> (Ptr GraphicsRequirementsD3D11KHR -> IO b) -> IO b # pokeCStruct :: Ptr GraphicsRequirementsD3D11KHR -> GraphicsRequirementsD3D11KHR -> IO b -> IO b # withZeroCStruct :: (Ptr GraphicsRequirementsD3D11KHR -> IO b) -> IO b # pokeZeroCStruct :: Ptr GraphicsRequirementsD3D11KHR -> IO b -> IO b # cStructSize :: Int # cStructAlignment :: Int #
FromCStruct GraphicsRequirementsD3D11KHR Source #
Instance details Defined in OpenXR.Extensions.XR_KHR_D3D11_enable Methods peekCStruct :: Ptr GraphicsRequirementsD3D11KHR -> IO GraphicsRequirementsD3D11KHR #

type KHR_D3D11_enable_SPEC_VERSION = 5 Source #

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

type KHR_D3D11_ENABLE_EXTENSION_NAME = "XR_KHR_D3D11_enable" Source #

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

type LUID = Word64 Source #

type D3D_FEATURE_LEVEL = Word32 Source #

data ID3D11Device Source #

data ID3D11Texture2D Source #

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

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

GraphicsBindingD3D11KHR
Fields device :: Ptr ID3D11Device `device` is a pointer to a valid `ID3D11Device` to use.

SwapchainImageD3D11KHR
Fields texture :: Ptr ID3D11Texture2D `texture` is a pointer to a valid `ID3D11Texture2D` to use.

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