Class FBDisplayRefreshRate
- java.lang.Object
-
- org.lwjgl.openxr.FBDisplayRefreshRate
-
public class FBDisplayRefreshRate extends java.lang.ObjectThe FB_display_refresh_rate extension.
-
-
Field Summary
Fields Modifier and Type Field Description static intXR_ERROR_DISPLAY_REFRESH_RATE_UNSUPPORTED_FBExtendsXrResult.static java.lang.StringXR_FB_DISPLAY_REFRESH_RATE_EXTENSION_NAMEThe extension name.static intXR_FB_display_refresh_rate_SPEC_VERSIONThe extension specification version.static intXR_TYPE_EVENT_DATA_DISPLAY_REFRESH_RATE_CHANGED_FBExtendsXrStructureType.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static intnxrEnumerateDisplayRefreshRatesFB(XrSession session, int displayRefreshRateCapacityInput, long displayRefreshRateCountOutput, long displayRefreshRates)Unsafe version of:EnumerateDisplayRefreshRatesFBstatic intnxrGetDisplayRefreshRateFB(XrSession session, long displayRefreshRate)Unsafe version of:GetDisplayRefreshRateFBstatic intxrEnumerateDisplayRefreshRatesFB(XrSession session, java.nio.IntBuffer displayRefreshRateCountOutput, java.nio.FloatBuffer displayRefreshRates)Enumerates display refresh rates.static intxrGetDisplayRefreshRateFB(XrSession session, java.nio.FloatBuffer displayRefreshRate)Get the current display refresh rate.static intxrRequestDisplayRefreshRateFB(XrSession session, float displayRefreshRate)Request a display refresh rate.
-
-
-
Field Detail
-
XR_FB_display_refresh_rate_SPEC_VERSION
public static final int XR_FB_display_refresh_rate_SPEC_VERSION
The extension specification version.- See Also:
- Constant Field Values
-
XR_FB_DISPLAY_REFRESH_RATE_EXTENSION_NAME
public static final java.lang.String XR_FB_DISPLAY_REFRESH_RATE_EXTENSION_NAME
The extension name.- See Also:
- Constant Field Values
-
XR_TYPE_EVENT_DATA_DISPLAY_REFRESH_RATE_CHANGED_FB
public static final int XR_TYPE_EVENT_DATA_DISPLAY_REFRESH_RATE_CHANGED_FB
ExtendsXrStructureType.- See Also:
- Constant Field Values
-
XR_ERROR_DISPLAY_REFRESH_RATE_UNSUPPORTED_FB
public static final int XR_ERROR_DISPLAY_REFRESH_RATE_UNSUPPORTED_FB
ExtendsXrResult.- See Also:
- Constant Field Values
-
-
Method Detail
-
nxrEnumerateDisplayRefreshRatesFB
public static int nxrEnumerateDisplayRefreshRatesFB(XrSession session, int displayRefreshRateCapacityInput, long displayRefreshRateCountOutput, long displayRefreshRates)
Unsafe version of:EnumerateDisplayRefreshRatesFB- Parameters:
displayRefreshRateCapacityInput- the capacity of thedisplayRefreshRates, or 0 to retrieve the required capacity.
-
xrEnumerateDisplayRefreshRatesFB
public static int xrEnumerateDisplayRefreshRatesFB(XrSession session, java.nio.IntBuffer displayRefreshRateCountOutput, @Nullable java.nio.FloatBuffer displayRefreshRates)
Enumerates display refresh rates.C Specification
The
EnumerateDisplayRefreshRatesFBfunction is defined as:XrResult xrEnumerateDisplayRefreshRatesFB( XrSession session, uint32_t displayRefreshRateCapacityInput, uint32_t* displayRefreshRateCountOutput, float* displayRefreshRates);Description
EnumerateDisplayRefreshRatesFBenumerates 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_rateextension must be enabled prior to callingEnumerateDisplayRefreshRatesFB sessionmust be a validXrSessionhandledisplayRefreshRateCountOutputmust be a pointer to auint32_tvalue- If
displayRefreshRateCapacityInputis not 0,displayRefreshRatesmust be a pointer to an array ofdisplayRefreshRateCapacityInputfloatvalues
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
session- the session that enumerates the supported display refresh rates.displayRefreshRateCountOutput- a pointer to the count offloatdisplayRefreshRateswritten, or a pointer to the required capacity in the case thatdisplayRefreshRateCapacityInputis 0.displayRefreshRates- a pointer to an array offloatdisplay refresh rates, but can beNULLifdisplayRefreshRateCapacityInputis 0.
- The
-
nxrGetDisplayRefreshRateFB
public static int nxrGetDisplayRefreshRateFB(XrSession session, long displayRefreshRate)
Unsafe version of:GetDisplayRefreshRateFB
-
xrGetDisplayRefreshRateFB
public static int xrGetDisplayRefreshRateFB(XrSession session, java.nio.FloatBuffer displayRefreshRate)
Get the current display refresh rate.C Specification
The
GetDisplayRefreshRateFBfunction is defined as:XrResult xrGetDisplayRefreshRateFB( XrSession session, float* displayRefreshRate);Description
GetDisplayRefreshRateFBretrieves the current display refresh rate.Valid Usage (Implicit)
- The
XR_FB_display_refresh_rateextension must be enabled prior to callingGetDisplayRefreshRateFB sessionmust be a validXrSessionhandledisplayRefreshRatemust be a pointer to afloatvalue
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
session- theXrSessionto query.displayRefreshRate- a pointer to a float into which the current display refresh rate will be placed.
- The
-
xrRequestDisplayRefreshRateFB
public static int xrRequestDisplayRefreshRateFB(XrSession session, float displayRefreshRate)
Request a display refresh rate.C Specification
The
RequestDisplayRefreshRateFBfunction is defined as:XrResult xrRequestDisplayRefreshRateFB( XrSession session, float displayRefreshRate);Description
RequestDisplayRefreshRateFBprovides a mechanism for an application to request the system to dynamically change the display refresh rate to the application preferred value. The runtime must returnERROR_DISPLAY_REFRESH_RATE_UNSUPPORTED_FBifdisplayRefreshRateis not either0.0for one of the values enumerated byEnumerateDisplayRefreshRatesFB. A display refresh rate of0.0findicates 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_rateextension must be enabled prior to callingRequestDisplayRefreshRateFB sessionmust be a validXrSessionhandle
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
session- a validXrSessionhandle.displayRefreshRate-0.0for a supported display refresh rate. Supported display refresh rates are indicated byEnumerateDisplayRefreshRatesFB.
- The
-
-