Safe Haskell	None
Language	Haskell2010

OpenXR.Extensions.XR_FB_display_refresh_rate

Description

Name

XR_FB_display_refresh_rate - instance extension

Specification

See XR_FB_display_refresh_rate in the main specification for complete information.

Registered Extension Number

102

Revision

1

Extension and Version Dependencies

Requires OpenXR 1.0

Document Notes

For more information, see the OpenXR Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

enumerateDisplayRefreshRatesFB :: forall io. MonadIO io => Session -> io (Result, "displayRefreshRates" ::: Vector Float)
getDisplayRefreshRateFB :: forall io. MonadIO io => Session -> io (Result, "displayRefreshRate" ::: Float)
requestDisplayRefreshRateFB :: forall io. MonadIO io => Session -> ("displayRefreshRate" ::: Float) -> io Result
data EventDataDisplayRefreshRateChangedFB = EventDataDisplayRefreshRateChangedFB {
- fromDisplayRefreshRate :: Float
- toDisplayRefreshRate :: Float
}
type FB_display_refresh_rate_SPEC_VERSION = 1
pattern FB_display_refresh_rate_SPEC_VERSION :: forall a. Integral a => a
type FB_DISPLAY_REFRESH_RATE_EXTENSION_NAME = "XR_FB_display_refresh_rate"
pattern FB_DISPLAY_REFRESH_RATE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

enumerateDisplayRefreshRatesFB :: forall io. MonadIO io => Session -> io (Result, "displayRefreshRates" ::: Vector Float) Source #

xrEnumerateDisplayRefreshRatesFB - Enumerates display refresh rates

Parameter Descriptions

session is the session that enumerates the supported display refresh rates.

displayRefreshRateCapacityInput is the capacity of the displayRefreshRates, or 0 to retrieve the required capacity.
displayRefreshRateCountOutput is a pointer to the count of float displayRefreshRates written, or a pointer to the required capacity in the case that displayRefreshRateCapacityInput is 0.
displayRefreshRates is a pointer to an array of float display refresh rates, but can be NULL if displayRefreshRateCapacityInput is 0.
See Buffer Size Parameters chapter for a detailed description of retrieving the required displayRefreshRates size.

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 @@ extension must be enabled prior to calling enumerateDisplayRefreshRatesFB

session must be a valid Session 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

Success

SUCCESS
SESSION_LOSS_PENDING

Failure

Description

getDisplayRefreshRateFB retrieves the current display refresh rate.

Valid Usage (Implicit)

The @@ extension must be enabled prior to calling getDisplayRefreshRateFB

session must be a valid Session handle
displayRefreshRate must be a pointer to a float value

Return Codes

Success

SUCCESS
SESSION_LOSS_PENDING

Failure

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 @@ extension must be enabled prior to calling requestDisplayRefreshRateFB

session must be a valid Session handle

Return Codes

Success

SUCCESS
SESSION_LOSS_PENDING

Failure

Eq EventDataDisplayRefreshRateChangedFB Source #
Instance details Defined in OpenXR.Extensions.XR_FB_display_refresh_rate Methods (==) :: EventDataDisplayRefreshRateChangedFB -> EventDataDisplayRefreshRateChangedFB -> Bool # (/=) :: EventDataDisplayRefreshRateChangedFB -> EventDataDisplayRefreshRateChangedFB -> Bool #
Show EventDataDisplayRefreshRateChangedFB Source #
Instance details Defined in OpenXR.Extensions.XR_FB_display_refresh_rate Methods showsPrec :: Int -> EventDataDisplayRefreshRateChangedFB -> ShowS # show :: EventDataDisplayRefreshRateChangedFB -> String # showList :: [EventDataDisplayRefreshRateChangedFB] -> ShowS #
Storable EventDataDisplayRefreshRateChangedFB Source #
Instance details Defined in OpenXR.Extensions.XR_FB_display_refresh_rate Methods sizeOf :: EventDataDisplayRefreshRateChangedFB -> Int # alignment :: EventDataDisplayRefreshRateChangedFB -> Int # peekElemOff :: Ptr EventDataDisplayRefreshRateChangedFB -> Int -> IO EventDataDisplayRefreshRateChangedFB # pokeElemOff :: Ptr EventDataDisplayRefreshRateChangedFB -> Int -> EventDataDisplayRefreshRateChangedFB -> IO () # peekByteOff :: Ptr b -> Int -> IO EventDataDisplayRefreshRateChangedFB # pokeByteOff :: Ptr b -> Int -> EventDataDisplayRefreshRateChangedFB -> IO () # peek :: Ptr EventDataDisplayRefreshRateChangedFB -> IO EventDataDisplayRefreshRateChangedFB # poke :: Ptr EventDataDisplayRefreshRateChangedFB -> EventDataDisplayRefreshRateChangedFB -> IO () #
Zero EventDataDisplayRefreshRateChangedFB Source #
Instance details Defined in OpenXR.Extensions.XR_FB_display_refresh_rate Methods zero :: EventDataDisplayRefreshRateChangedFB #
ToCStruct EventDataDisplayRefreshRateChangedFB Source #
Instance details Defined in OpenXR.Extensions.XR_FB_display_refresh_rate Methods withCStruct :: EventDataDisplayRefreshRateChangedFB -> (Ptr EventDataDisplayRefreshRateChangedFB -> IO b) -> IO b # pokeCStruct :: Ptr EventDataDisplayRefreshRateChangedFB -> EventDataDisplayRefreshRateChangedFB -> IO b -> IO b # withZeroCStruct :: (Ptr EventDataDisplayRefreshRateChangedFB -> IO b) -> IO b # pokeZeroCStruct :: Ptr EventDataDisplayRefreshRateChangedFB -> IO b -> IO b # cStructSize :: Int # cStructAlignment :: Int #
FromCStruct EventDataDisplayRefreshRateChangedFB Source #
Instance details Defined in OpenXR.Extensions.XR_FB_display_refresh_rate Methods peekCStruct :: Ptr EventDataDisplayRefreshRateChangedFB -> IO EventDataDisplayRefreshRateChangedFB #
IsEventData EventDataDisplayRefreshRateChangedFB Source #
Instance details Defined in OpenXR.Extensions.XR_FB_display_refresh_rate Methods toEventDataBaseHeader :: EventDataDisplayRefreshRateChangedFB -> EventDataBaseHeader Source #

type FB_display_refresh_rate_SPEC_VERSION = 1 Source #

pattern FB_display_refresh_rate_SPEC_VERSION :: forall a. Integral a => a Source #

type FB_DISPLAY_REFRESH_RATE_EXTENSION_NAME = "XR_FB_display_refresh_rate" Source #

pattern FB_DISPLAY_REFRESH_RATE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

Name

Specification

Registered Extension Number

Revision

Extension and Version Dependencies

See Also

Document Notes

Documentation

Parameter Descriptions

Description

Valid Usage (Implicit)

Return Codes

See Also

Parameter Descriptions

Description

Valid Usage (Implicit)

Return Codes

See Also

Parameter Descriptions

Description

Valid Usage (Implicit)

Return Codes

See Also

Valid Usage (Implicit)

See Also

Instances

:: forall io. MonadIO io
=> Session	`session` is the `Session` to query.
-> io (Result, "displayRefreshRate" ::: Float)

:: forall io. MonadIO io
=> Session	`session` is a valid `Session` handle.
-> ("displayRefreshRate" ::: Float)	`displayRefreshRate` is `0.0f` or a supported display refresh rate. Supported display refresh rates are indicated by `enumerateDisplayRefreshRatesFB`.
-> io Result

EventDataDisplayRefreshRateChangedFB
Fields fromDisplayRefreshRate :: Float `fromDisplayRefreshRate` is the previous display refresh rate. toDisplayRefreshRate :: Float `toDisplayRefreshRate` is the new display refresh rate.