WVR_EXPORT WVR_Result WVR_SetFrameRate(uint32_t frameRate)
Function to set rendering frame rate.
Use this function to set rendering frame rate if HMD device supported. This function must be called after calling WVR_RenderInit().
- API Level 12
- Supported since Runtime version 12 or higher.
- Return Value
WVR_SUCCESS: Set frame rate success, otherwise returns false.
WVR_Error_RuntimeVersionNotSupport: This feature is supported from Runtime version 12 or higher.
WVR_Error_FeatureNotSupport: This feature is not supported on this device.
WVR_Error_SystemInvalid: The runtime initialization was not finished.
Others: Failed, please see WVR_Result for more information.
How to use¶
Here is an example for the function:
uint32_t frameRate = 75; WVR_SetFrameRate(frameRate);
- If you want to use different frame rate with the system default, it is recommeneded to set required frame rate after WVR_RenderInit is just called.
- Before setting the frame rate, suggest to confirm which frame rates are available by WVR_GetAvailableFrameRates.
- System will take some processing time, about 12~14 frame time, to make the frame rate change effective after API calling. So, if you call WVR_GetFrameRate to get current render target frame rate right after the WVR_SetFrameRate, it will get the previous render target frame rate.
- When switching the frame rate, the screen might appear noise or tearing shortly, so please DO NOT change frame rate frequently unless it is the necessary for content design.