C Specification

Each XrViewConfigurationView specifies properties related to rendering of an individual view within a view configuration.

The XrViewConfigurationView structure is defined as:

typedef struct XrViewConfigurationView {
    XrStructureType       type;
    void* XR_MAY_ALIAS    next;
    uint32_t              recommendedImageRectWidth;
    uint32_t              maxImageRectWidth;
    uint32_t              recommendedImageRectHeight;
    uint32_t              maxImageRectHeight;
    uint32_t              recommendedSwapchainSampleCount;
    uint32_t              maxSwapchainSampleCount;
} XrViewConfigurationView;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

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

  • recommendedImageRectWidth is the optimal width of imageRect to use when rendering this view into a swapchain.

  • maxImageRectWidth is the maximum width of imageRect supported when rendering this view into a swapchain.

  • recommendedImageRectHeight is the optimal height of imageRect to use when rendering this view into a swapchain.

  • maxImageRectHeight is the maximum height of imageRect supported when rendering this view into a swapchain.

  • recommendedSwapchainSampleCount is the recommended number of sub-data element samples to create for each swapchain image that will be rendered into for this view.

  • maxSwapchainSampleCount is the maximum number of sub-data element samples supported for swapchain images that will be rendered into for this view.

Description

See XrSwapchainSubImage for more information about imageRect values, and XrSwapchainCreateInfo for more information about creating swapchains appropriately sized to support those imageRect values.

The array of XrViewConfigurationView returned by the runtime must adhere to the rules defined in XrViewConfigurationType, such as the count and association to the left and right eyes.

Valid Usage (Implicit)

  • type must be XR_TYPE_VIEW_CONFIGURATION_VIEW

  • next must be NULL

  • recommendedImageRectWidth must be a valid uint32_t value

  • maxImageRectWidth must be a valid uint32_t value

  • recommendedImageRectHeight must be a valid uint32_t value

  • maxImageRectHeight must be a valid uint32_t value

  • recommendedSwapchainSampleCount must be a valid uint32_t value

  • maxSwapchainSampleCount must be a valid uint32_t value

See Also

XrStructureType, XrViewConfigurationProperties, XrViewConfigurationType, xrEnumerateViewConfigurationViews

Document Notes

For more information, see the OpenXR Specification at URL

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

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.