public Class FBDisplayRefreshRate

Extends XrResult.

The extension name.

The extension specification version.

Extends XrStructureType.

Unsafe version of: EnumerateDisplayRefreshRatesFB

Parameters

displayRefreshRateCapacityInput:int

the capacity of the displayRefreshRates, or 0 to retrieve the required capacity.

Unsafe version of: GetDisplayRefreshRateFB

Enumerates display refresh rates.

C Specification

The EnumerateDisplayRefreshRatesFB function is defined as:

XrResult xrEnumerateDisplayRefreshRatesFB(
    XrSession                                   session,
    uint32_t                                    displayRefreshRateCapacityInput,
    uint32_t*                                   displayRefreshRateCountOutput,
    float*                                      displayRefreshRates);

Description

EnumerateDisplayRefreshRatesFB enumerates the display refresh rates supported by the current session. Display refresh rates must be in order from lowest to highest supported display refresh rates. Runtimes must always return identical buffer contents from this enumeration for the lifetime of the session.

Valid Usage (Implicit)

• The XR_FB_display_refresh_rate extension must be enabled prior to calling EnumerateDisplayRefreshRatesFB
• session must be a valid XrSession handle
• displayRefreshRateCountOutput must be a pointer to a uint32_t value
• If displayRefreshRateCapacityInput is not 0, displayRefreshRates must be a pointer to an array of displayRefreshRateCapacityInput float values

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_SIZE_INSUFFICIENT

See Also

GetDisplayRefreshRateFB, RequestDisplayRefreshRateFB

Parameters

session:XrSession

the session that enumerates the supported display refresh rates.

displayRefreshRateCountOutput:IntBuffer

a pointer to the count of float displayRefreshRates written, or a pointer to the required capacity in the case that displayRefreshRateCapacityInput is insufficient.

displayRefreshRates:FloatBuffer

a pointer to an array of float display refresh rates, but can be NULL if displayRefreshRateCapacityInput is 0.

Annotations

@NativeType:XrResult

Get the current display refresh rate.

C Specification

The GetDisplayRefreshRateFB function is defined as:

XrResult xrGetDisplayRefreshRateFB(
    XrSession                                   session,
    float*                                      displayRefreshRate);

Description

GetDisplayRefreshRateFB retrieves the current display refresh rate.

Valid Usage (Implicit)

• The XR_FB_display_refresh_rate extension must be enabled prior to calling GetDisplayRefreshRateFB
• session must be a valid XrSession handle
• displayRefreshRate must be a pointer to a float value

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST

See Also

EnumerateDisplayRefreshRatesFB, RequestDisplayRefreshRateFB

Parameters

session:XrSession

the XrSession to query.

displayRefreshRate:FloatBuffer

a pointer to a float into which the current display refresh rate will be placed.

Annotations

@NativeType:XrResult

Request a display refresh rate.

C Specification

The RequestDisplayRefreshRateFB function is defined as:

XrResult xrRequestDisplayRefreshRateFB(
    XrSession                                   session,
    float                                       displayRefreshRate);

Description

RequestDisplayRefreshRateFB provides a mechanism for an application to request the system to dynamically change the display refresh rate to the application preferred value. The runtime must return ERROR_DISPLAY_REFRESH_RATE_UNSUPPORTED_FB if displayRefreshRate is not either 0.0f or one of the values enumerated by EnumerateDisplayRefreshRatesFB. A display refresh rate of 0.0f indicates the application has no preference.

Note that this is only a request and does not guarantee the system will switch to the requested display refresh rate.

Valid Usage (Implicit)

• The XR_FB_display_refresh_rate extension must be enabled prior to calling RequestDisplayRefreshRateFB
• session must be a valid XrSession handle

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_FEATURE_UNSUPPORTED
• ERROR_DISPLAY_REFRESH_RATE_UNSUPPORTED_FB

See Also

EnumerateDisplayRefreshRatesFB, GetDisplayRefreshRateFB

Parameters

session:XrSession

a valid XrSession handle.

displayRefreshRate:float

0.0f or a supported display refresh rate. Supported display refresh rates are indicated by EnumerateDisplayRefreshRatesFB.

Annotations

@NativeType:XrResult