openxr-0.1: Bindings to the OpenXR API
Safe HaskellNone
LanguageHaskell2010

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

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

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)

Return Codes

Success
Failure

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)

See Also

StructureType, createSession

Constructors

GraphicsBindingD3D12KHR 

Fields

Instances

Instances details
Eq GraphicsBindingD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

Show GraphicsBindingD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

Storable GraphicsBindingD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

Zero GraphicsBindingD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

ToCStruct GraphicsBindingD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

FromCStruct GraphicsBindingD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

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.

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)

See Also

StructureType, SwapchainImageBaseHeader

Constructors

SwapchainImageD3D12KHR 

Fields

Instances

Instances details
Eq SwapchainImageD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

Show SwapchainImageD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

Storable SwapchainImageD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

Zero SwapchainImageD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

ToCStruct SwapchainImageD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

FromCStruct SwapchainImageD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

IsSwapchainImage SwapchainImageD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

data GraphicsRequirementsD3D12KHR Source #

XrGraphicsRequirementsD3D12KHR - D3D12 feature level and LUID requirements

Member Descriptions

Description

GraphicsRequirementsD3D12KHR is populated by getD3D12GraphicsRequirementsKHR.

Valid Usage (Implicit)

See Also

StructureType, getD3D12GraphicsRequirementsKHR

Constructors

GraphicsRequirementsD3D12KHR 

Fields

Instances

Instances details
Eq GraphicsRequirementsD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

Show GraphicsRequirementsD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

Storable GraphicsRequirementsD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

Zero GraphicsRequirementsD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

ToCStruct GraphicsRequirementsD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

FromCStruct GraphicsRequirementsD3D12KHR Source # 
Instance details

Defined in OpenXR.Extensions.XR_KHR_D3D12_enable

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 #