Engine.Frame

Documentation

data Frame renderpass pipelines resources

All the information required to render a single frame

Constructors

Frame

Fields

• fIndex :: Word64

  Which number frame is this

• fWindow :: Window
• fSurface :: SurfaceKHR
• fSwapchainResources :: SwapchainResources
• fRenderpass :: renderpass
• fPipelines :: pipelines
• fRenderFinishedHostSemaphore :: Semaphore

  A timeline semaphore which increments to fIndex when this frame is done, the host can wait on this semaphore.

• fStageResources :: (RefCounted, InternalState)

  Swapchain-derived resources with a life time of this Frame's stage.

• fGPUWork :: IORef [GPUWork]

  Timeline semaphores and corresponding wait values, updates as the frame progresses.

• fResources :: (ReleaseKey, InternalState)

  The InternalState for tracking frame-local resources along with the key to release it in the global scope. This will be released when the frame is done with GPU work.

• fRecycledResources :: RecycledResources resources

  Resources which can be used for this frame and are then passed on to a later frame.

Instances

HasStateRef st (App GlobalHandles st, Frame rp p rr)

Defined in Engine.Types

Methods

stateRefL :: Lens' (App GlobalHandles st, Frame rp p rr) (SomeRef st)

HasDescSet tag rr => HasDescSet tag (env, Frame rp p rr)

Defined in Engine.Vulkan.DescSets

Methods

getDescSet :: (env, Frame rp p rr) -> Tagged tag DescriptorSet

HasDescSet tag rr => HasDescSet tag (Frame rp p rr)

Defined in Engine.Vulkan.DescSets

Methods

getDescSet :: Frame rp p rr -> Tagged tag DescriptorSet

MonadResource (RIO (env, Frame rp p rr))

Defined in Engine.Types

Methods

liftResourceT :: ResourceT IO a -> RIO (env, Frame rp p rr) a

HasLogFunc env => HasLogFunc (env, Frame rp p rr)

Defined in Engine.Types

Methods

logFuncL :: Lens' (env, Frame rp p rr) LogFunc

initial :: RenderPass rp => Maybe SwapchainResources -> DumpResource (RecycledResources rr) -> Stage rp p rr st -> StageRIO st (Frame rp p rr)

run :: (HasLogFunc env, HasVulkan env, MonadResource (RIO env)) => (RecycledResources rr -> IO ()) -> RIO (env, Frame rp p rr) a -> Frame rp p rr -> RIO env a

advance :: (HasLogFunc env, HasVulkan env, MonadResource (RIO env), RenderPass rp) => WaitResource (RecycledResources rr) -> Frame rp p rr -> Bool -> RIO env (Frame rp p rr)

Derive next frame

queueSubmit :: MonadVulkan env m => Queue -> Vector (SomeStruct SubmitInfo) -> IORef [GPUWork] -> Semaphore -> Word64 -> m ()

queueSubmit and add wait for the timeline Semaphore before retiring the frame.

data RecycledResources a

These are resources which are reused by a later frame when the current frame is retired

Constructors

RecycledResources

Fields

• rrImageAvailableSemaphore :: Semaphore

  A binary semaphore passed to acquireNextImageKHR

• rrRenderFinishedSemaphore :: Semaphore

  A binary semaphore to synchronize rendering and presenting

• rrQueues :: Queues CommandPool

  Pool for this frame's commands for each of the queue families. (might want more than one of these for multithreaded recording)

• rrData :: a

Instances

HasDescSet tag rr => HasDescSet tag (RecycledResources rr)

Defined in Engine.Vulkan.DescSets

Methods

getDescSet :: RecycledResources rr -> Tagged tag DescriptorSet

initialRecycledResources :: (MonadResource (RIO env), HasVulkan env, HasLogFunc env) => (Queues CommandPool -> rp -> p -> ResourceT (RIO env) rr) -> rp -> p -> ResourceT (RIO env) (RecycledResources rr)

timeoutError :: MonadThrow m => String -> m a