XrRenderModelPropertiesFB(3)

C Specification

The XrRenderModelPropertiesFB structure is defined as:

// Provided by XR_FB_render_model
typedef struct XrRenderModelPropertiesFB {
    XrStructureType         type;
    void*                   next;
    uint32_t                vendorId;
    char                    modelName[XR_MAX_RENDER_MODEL_NAME_SIZE_FB];
    XrRenderModelKeyFB      modelKey;
    uint32_t                modelVersion;
    XrRenderModelFlagsFB    flags;
} XrRenderModelPropertiesFB;

Members

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to the next structure in a structure chain. XrRenderModelCapabilitiesRequestFB is a structure in this structure chain and should be linked when this structure is passed to xrGetRenderModelPropertiesFB.
vendorId is the vendor id of the model.
modelName is the name of the model.
modelKey is the unique model key used to load the model in xrLoadRenderModelFB.
modelVersion is the version number of the model.
flags is a bitmask of XrRenderModelFlagsFB. After a successful call to xrGetRenderModelPropertiesFB, flags must contain the support level of the model and no other support levels.

Description

XrRenderModelPropertiesFB contains information about the render model for a device. XrRenderModelPropertiesFB must be provided when calling xrGetRenderModelPropertiesFB. The XrRenderModelKeyFB included in the properties is a unique key for each render model that is valid across multiple instances and installs.

If the application decides to cache or save the render model in any way, modelVersion can be used to determine if the render model has changed. The application should then update its cached or saved version.

Valid Usage (Implicit)

The XR_FB_render_model extension must be enabled prior to using XrRenderModelPropertiesFB
type must be XR_TYPE_RENDER_MODEL_PROPERTIES_FB
next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrRenderModelCapabilitiesRequestFB
modelName must be a null-terminated UTF-8 string whose length is less than or equal to XR_MAX_RENDER_MODEL_NAME_SIZE_FB
flags must be a valid combination of XrRenderModelFlagBitsFB values
flags must not be 0

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

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

XrRenderModelPropertiesFB(3) Manual Page

Name

C Specification

Members

Description

See Also

Document Notes

Copyright