Modulevulkan-utils-0.5.11.0Haskell2010

Vulkan.Utils.WindowLoop

Per-frame window loop shared by windowed applications.

The skeleton — read swapchain, run a frame inside runFrame, recreate on threwSwapchainError, advance — is the same for any windowed Vulkan app. Each consumer only varies in:

the per-swapchain state it holds (framebuffers, descriptor sets, …),
the per-frame render action, and
the "what to do on exit / per-frame metric" hooks.

runWindowLoop takes those four points as fields of a WindowLoop record.

1 type
5 values

Packagevulkan-utils-0.5.11.0
Exports6
LanguageHaskell2010
LicenceBSD-3-Clause
SourceWindowLoop.hs

datadata WindowLoop s rr

Constructors

WindowLoop
- wlMkState :: Swapchain -> ResourceT IO (s, ReleaseKey)
  Build per-swapchain state. The release key is fired when the swapchain is recreated and a fresh state replaces this one.
- wlMkRecycled :: InitRecycledResources (ResourceT IO) rr
- wlRender :: s -> Frame rr -> ResourceT IO ()
  Per-frame render action; runs inside runFrame.
- wlOnFrame :: Word64 -> Word64 -> ResourceT IO ()
  Optional metric hook with start/end nanoseconds around runFrame. Use noOnFrame if you don't care.
- wlOnExit :: Frame rr -> ResourceT IO ()
  Fired once when the window closes. Use noOnExit if you don't care.

valuerunWindowLoop

:: VulkanContext rr
-> Swapchain
-> IO Extent2D
Get current drawable size (called on resize)
-> IO Bool
Per-frame poller; True means quit
-> WindowLoop s rr
-> ResourceT IO ()

valuenoWindowState :: Swapchain -> ResourceT IO ((), ReleaseKey)

wlMkState for callers that have no per-swapchain state.

valuenoRecycledResources :: Applicative m => InitRecycledResources m ()

valuenoOnFrame :: Word64 -> Word64 -> ResourceT IO ()

valuenoOnExit :: Frame rr -> ResourceT IO ()