Engine.Types

App globals

data GlobalHandles

A bunch of global, unchanging state we cart around

Constructors

GlobalHandles

Fields

• ghOptions :: Options
• ghWindow :: Window
• ghSurface :: SurfaceKHR
• ghInstance :: Instance
• ghPhysicalDevice :: PhysicalDevice
• ghPhysicalDeviceInfo :: PhysicalDeviceInfo
• ghDevice :: Device
• ghAllocator :: Allocator
• ghQueues :: Queues (QueueFamilyIndex, Queue)
• ghScreenVar :: Var Extent2D
• ghStageSwitch :: StageSwitchVar

Instances

HasVulkan GlobalHandles

Defined in Engine.Types

Methods

getInstance :: GlobalHandles -> Instance

getQueues :: GlobalHandles -> Queues (QueueFamilyIndex, Queue)

getPhysicalDevice :: GlobalHandles -> PhysicalDevice

getPhysicalDeviceInfo :: GlobalHandles -> PhysicalDeviceInfo

getDevice :: GlobalHandles -> Device

getAllocator :: GlobalHandles -> Allocator

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)

askScreenVar :: StageRIO env (Var Extent2D)

Stage stack

type StageStack = [StackStage]

data NextStage

Constructors

Finish

Replace StackStage

PushRestart StackStage

PushFreeze StackStage

data StackStage where

Constructors

StackStage :: forall rp p rr st. RenderPass rp => Stage rp p rr st -> StackStage

StackStageContinue :: forall rp p rr st. RenderPass rp => ReleaseKey -> st -> Stage rp p rr st -> StackStage

type StageSwitchVar = TMVar StageSwitch

data StageSwitch

Constructors

StageSwitchPending NextStage

StageSwitchHandled

Stage on a stack

type StageRIO st = RIO (App GlobalHandles st)

type StageSetupRIO = RIO (App GlobalHandles (Maybe SwapchainResources))

type StageFrameRIO rp p rr st = RIO (App GlobalHandles st, Frame rp p rr)

data Stage rp p rr st

Constructors

forall a. Stage

Fields

• sTitle :: Text
• sAllocateRP :: SwapchainResources -> ResourceT (StageRIO st) rp
• sAllocateP :: SwapchainResources -> rp -> ResourceT (StageRIO st) p
• sInitialRS :: StageRIO (Maybe SwapchainResources) (ReleaseKey, st)
• sInitialRR :: Queues CommandPool -> rp -> p -> ResourceT (StageRIO st) rr
• sBeforeLoop :: StageRIO st a
• sUpdateBuffers :: st -> rr -> StageFrameRIO rp p rr st ()
• sRecordCommands :: CommandBuffer -> rr -> ("image index" ::: Word32) -> StageFrameRIO rp p rr st ()
• sAfterLoop :: a -> StageRIO st ()

Frame loop inside a stage

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

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

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 (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

type GPUWork = ("host semaphore" ::: Semaphore, "frame index" ::: Word64)

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