sdlSetWindowSurfaceVSync function

bool sdlSetWindowSurfaceVSync(
  1. Pointer<SdlWindow> window,
  2. int vsync
)

Toggle VSync for the window surface.

When a window surface is created, vsync defaults to SDL_WINDOW_SURFACE_VSYNC_DISABLED.

The vsync parameter can be 1 to synchronize present with every vertical refresh, 2 to synchronize present with every second vertical refresh, etc., SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync), or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is supported by every driver, so you should check the return value to see whether the requested setting is supported.

\param window the window. \param vsync the vertical refresh sync interval. \returns true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

\since This function is available since SDL 3.1.3.

\sa SDL_GetWindowSurfaceVSync

extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowSurfaceVSync(SDL_Window *window, int vsync)

Implementation

bool sdlSetWindowSurfaceVSync(Pointer<SdlWindow> window, int vsync) {
  final sdlSetWindowSurfaceVSyncLookupFunction = libSdl3.lookupFunction<
      Uint8 Function(Pointer<SdlWindow> window, Int32 vsync),
      int Function(
          Pointer<SdlWindow> window, int vsync)>('SDL_SetWindowSurfaceVSync');
  return sdlSetWindowSurfaceVSyncLookupFunction(window, vsync) == 1;
}