WGPU.Classy

WGPU commands commonly take parameters such as the Instance, Device, etc, which are relatively unchanged across multiple commands. This module provides a way to supply those parameters from a MonadReader. Useful for the truly lazy among us.

Constraints

type HasInstance r m = (RIO r m, Has Instance r)

type HasSurface r m = (RIO r m, Has Surface r)

type HasAdapter r m = (RIO r m, Has Adapter r)

type HasDevice r m = (RIO r m, Has Device r)

type HasSwapChain r m = (RIO r m, Has SwapChain r)

type HasCommandEncoder r m = (RIO r m, Has CommandEncoder r)

type HasRenderPassEncoder r m = (RIO r m, Has RenderPassEncoder r)

type HasQueue r m = (RIO r m, Has Queue r)

Classes

Lifted Functions

Adapter

requestAdapter :: HasSurface r m => m (Maybe Adapter)

getAdapterProperties :: HasAdapter r m => m AdapterProperties

Device

requestDevice :: HasAdapter r m => DeviceDescriptor -> m (Maybe Device)

Swapchain

getSwapChainPreferredFormat :: (HasSurface r m, HasAdapter r m) => m TextureFormat

createSwapChain :: (HasDevice r m, HasSurface r m) => SwapChainDescriptor -> m SwapChain

getSwapChainCurrentTextureView :: HasSwapChain r m => m TextureView

swapChainPresent :: HasSwapChain r m => m ()

Resource Binding

createBindGroupLayout :: HasDevice r m => BindGroupLayoutDescriptor -> m BindGroupLayout

Shader Modules

createShaderModule :: HasDevice r m => ShaderModuleDescriptor -> m ShaderModule

createShaderModuleSPIRV :: HasDevice r m => Text -> SPIRV -> m ShaderModule

createShaderModuleWGSL :: HasDevice r m => Text -> WGSL -> m ShaderModule

Pipelines

Render

createPipelineLayout :: HasDevice r m => PipelineLayoutDescriptor -> m PipelineLayout

createRenderPipeline :: HasDevice r m => RenderPipelineDescriptor -> m RenderPipeline

Command Encoding

createCommandEncoder :: HasDevice r m => Text -> m CommandEncoder

commandEncoderFinish :: HasCommandEncoder r m => Text -> m CommandBuffer

beginRenderPass :: HasCommandEncoder r m => RenderPassDescriptor -> m RenderPassEncoder

renderPassSetPipeline :: HasRenderPassEncoder r m => RenderPipeline -> m ()

renderPassDraw :: HasRenderPassEncoder r m => Range Word32 -> Range Word32 -> m ()

endRenderPass :: HasRenderPassEncoder r m => m ()

Queue

getQueue :: HasDevice r m => m Queue

queueSubmit :: HasQueue r m => Vector CommandBuffer -> m ()

queueSubmit' :: HasDevice r m => Vector CommandBuffer -> m ()

Fetch the queue from a device and submit command buffers to it.

Version

getVersion :: HasInstance r m => m Version

Logging

connectLog :: HasInstance r m => m ()

disconnectLog :: HasInstance r m => m ()

setLogLevel :: HasInstance r m => LogLevel -> m ()

Reader Contexts

addEnv :: MonadReader r m => q -> ReaderT (q, r) m a -> m a

Add q into the reader environment.

Building

Command Encoding

buildCommandBuffer

Arguments

:: forall r m. HasDevice r m

=> Text

Debugging label for the command encoder.

-> Text

Debugging label for the command buffer.

-> ReaderT (CommandEncoder, r) m ()

Action to configure the CommandEncoder.

-> m CommandBuffer

Completed CommandBuffer.

Build a CommandBuffer by running actions in an environment that has access to a CommandEncoder.

buildRenderPass :: forall r m. HasCommandEncoder r m => RenderPassDescriptor -> ReaderT (RenderPassEncoder, r) m () -> m ()

Build a render pass by running actions in an environment that has access to a RenderPassEncoder.