C Specification

The XrInstanceCreateInfo structure is defined as:

typedef struct XrInstanceCreateInfo {
    XrStructureType             type;
    const void* XR_MAY_ALIAS    next;
    XrInstanceCreateFlags       createFlags;
    XrApplicationInfo           applicationInfo;
    uint32_t                    enabledApiLayerCount;
    const char* const*          enabledApiLayerNames;
    uint32_t                    enabledExtensionCount;
    const char* const*          enabledExtensionNames;
} XrInstanceCreateInfo;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to an extension-specific structure.

  • createFlags is a bitmask of XrInstanceCreateFlags that identifies options that apply to the creation.

  • applicationInfo is an instance of XrApplicationInfo. This information helps runtimes recognize behavior inherent to classes of applications. XrApplicationInfo is defined in detail below.

  • enabledApiLayerCount is the number of global API layers to enable.

  • enabledApiLayerNames is a pointer to an array of enabledApiLayerCount strings containing the names of API layers to enable for the created instance. See the API Layers And Extensions section for further details.

  • enabledExtensionCount is the number of global extensions to enable.

  • enabledExtensionNames is a pointer to an array of enabledExtensionCount strings containing the names of extensions to enable.

Description

Valid Usage (Implicit)

  • type must be XR_TYPE_INSTANCE_CREATE_INFO

  • Each next member of any structure (including this one) in the next chain must be either NULL or a pointer to a valid instance of XrDebugUtilsMessengerCreateInfoEXT or XrInstanceCreateInfoAndroidKHR

  • Each type member in the next chain must be unique

  • createFlags must be 0 or a valid combination of XrInstanceCreateFlagBits values

  • applicationInfo must be a valid XrApplicationInfo structure

  • If enabledApiLayerCount is not 0, enabledApiLayerCount must be a valid uint32_t value

  • If enabledApiLayerCount is not 0, enabledApiLayerNames must be a pointer to an array of enabledApiLayerCount null-terminated UTF-8 strings

  • If enabledExtensionCount is not 0, enabledExtensionCount must be a valid uint32_t value

  • If enabledExtensionCount is not 0, enabledExtensionNames must be a pointer to an array of enabledExtensionCount null-terminated UTF-8 strings

See Also

XrApplicationInfo, XrInstanceCreateFlags, XrStructureType, xrCreateInstance

Document Notes

For more information, see the OpenXR Specification at URL

https://www.khronos.org/registry/openxr/specs/1.0-extensions/html/xrspec.html#XrInstanceCreateInfo

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.