Render: getVsync

getVsync()
  • Returns the VSync (Vertical Synchronization) mode

Return Type:
  • integer
Values:
  • 0 = bge.render.VSYNC_OFF
     
  • 1 = bge.render.VSYNC_ON
     
  • -1 = bge.render.VSYNC_ADAPTIVE
Definitions:
  • VSYNC_OFF = Vsync disabled
     
  • VSYNC_ON = Vsync enabled
     
  • VSYNC_ADAPTIVE = Vsync is disabled when framerate gets lower than the refresh rate
Blender 3D Vsync:
  • Properties menu >> Render button >> Systems >> Vsync

Vsync:

  • Vsync stands for Vertical Synchronization
     
  • Vsync synchronizes the game's FPS with the monitor's refresh rate
     
  • Vsync disabled:
    • Screen tearing can be seen when the game frame rate exceeds the monitor's refresh rate
  • Vsync enabled:
    • Screen tearing is eliminated by sychronizing the game frame rand and monitor's refresh rate
  • Adaptive Vsync:
    • Vsync is disabled when the game framerate gets lower than the monitor's refresh rate
Sample Code

################  get Vsync mode

# import bge module
import bge

# get the render module
rend = bge.render

# get Vsync mode
mode = rend.getVsync()