C Specification

The XrLoaderInitPropertyValueEXT structure is defined as:

typedef struct XrLoaderInitPropertyValueEXT {
    const char*    name;
    const char*    value;
} XrLoaderInitPropertyValueEXT;

Members

Member Descriptions

  • name is the name of the given property.

  • value is the value of the given property.

Description

This structure contains a single property name-value pair passed to loader initialization. The XrLoaderInitInfoPropertiesEXT structure is used to pass an array of these structures to the OpenXR loader, and the runtime upon loading, via xrInitializeLoaderKHR.

Rules for the value pair strings:

  • The loader must accept any valid UTF-8 string, including those that only contain whitespace, for both name and value except otherwise covered by a rule in this list. Whitespace-only strings are accepted by this extension because whitespace only paths are valid on some platforms.

  • The loader must return XR_ERROR_VALIDATION_FAILURE if name or value is NULL.

  • The loader must return XR_ERROR_VALIDATION_FAILURE if name is a zero length string.

  • The loader must treat a zero length value as if the environmental variable was unset in a platform specific way.

  • The loader may impose implementation or platform specific limitation on string lengths and/or total string memory usage and must return XR_ERROR_LIMIT_REACHED when hit.

  • The loader may impose length limits on name and/or value strings and must return XR_ERROR_LIMIT_REACHED when hit. Because they might be imposed by the platform, the limits are unspecified.

  • The loader must not reference the memory pointed to by the given strings beyond returning from this call, this implies that the loader will copy the strings into an internal database.

Valid Usage (Implicit)

See Also

XrLoaderInitInfoPropertiesEXT, xrInitializeLoaderKHR

Document Notes

For more information, see the OpenXR Specification

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

Copyright

Copyright 2014-2025 The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.