Copyright	Copyright (C) Jonathan Merritt 2021
License	BSD-3-Clause
Maintainer	Jonathan Merritt <j.s.merritt@gmail.com>
Stability	experimental
Portability	macOS, Linux, Windows
Safe Haskell	None
Language	Haskell2010

WGPU

Contents

Description

Layout of this module should be guided by the evolving WebGPU Specification.

Synopsis

data Instance
withPlatformInstance :: MonadIO m => (m Instance -> (Instance -> m ()) -> r) -> r
withInstance :: MonadIO m => FilePath -> (m Instance -> (Instance -> m ()) -> r) -> r
data Surface
data Adapter
data AdapterType
- = AdapterTypeDiscreteGPU
- | AdapterTypeIntegratedGPU
- | AdapterTypeCPU
- | AdapterTypeUnknown
data BackendType
- = BackendTypeNull
- | BackendTypeD3D11
- | BackendTypeD3D12
- | BackendTypeMetal
- | BackendTypeVulkan
- | BackendTypeOpenGL
- | BackendTypeOpenGLES
data AdapterProperties = AdapterProperties {
- deviceID :: !Word32
- vendorID :: !Word32
- adapterName :: !Text
- driverDescription :: !Text
- adapterType :: !AdapterType
- backendType :: !BackendType
}
requestAdapter :: MonadIO m => Surface -> m (Maybe Adapter)
getAdapterProperties :: MonadIO m => Adapter -> m AdapterProperties
adapterPropertiesToText :: AdapterProperties -> Text
data Device
data DeviceDescriptor = DeviceDescriptor {
- deviceLabel :: !Text
- features :: !Features
- limits :: !Limits
}
data Limits = Limits {
- maxTextureDimension1D :: !Word32
- maxTextureDimension2D :: !Word32
- maxTextureDimension3D :: !Word32
- maxTextureArrayLayers :: !Word32
- maxBindGroups :: !Word32
- maxDynamicStorageBuffersPerPipelineLayout :: !Word32
- maxStorageBuffersPerShaderStage :: !Word32
- maxStorageBufferBindingSize :: !Word32
}
newtype Features = Features {
- textureAdapterSpecificFormatFeatures :: Bool
}
requestDevice :: MonadIO m => Adapter -> DeviceDescriptor -> m (Maybe Device)
data Buffer
data BufferDescriptor = BufferDescriptor {
- bufferLabel :: !Text
- bufferSize :: !ByteSize
- bufferUsage :: !BufferUsage
- mappedAtCreation :: Bool
}
data BufferUsage = BufferUsage {
- bufMapRead :: !Bool
- bufMapWrite :: !Bool
- bufCopySrc :: !Bool
- bufCopyDst :: !Bool
- bufIndex :: !Bool
- bufVertex :: !Bool
- bufUniform :: !Bool
- bufStorage :: !Bool
- bufIndirect :: !Bool
}
createBuffer :: MonadIO m => Device -> BufferDescriptor -> m Buffer
createBufferInit :: forall a m. (MonadIO m, ReadableMemoryBuffer a) => Device -> Text -> BufferUsage -> a -> m Buffer
data Texture
data TextureView
data TextureViewDimension
- = TextureViewDimension1D
- | TextureViewDimension2D
- | TextureViewDimension2DArray
- | TextureViewDimensionCube
- | TextureViewDimensionCubeArray
- | TextureViewDimension3D
data TextureFormat
- = TextureFormatR8Unorm
- | TextureFormatR8Snorm
- | TextureFormatR8Uint
- | TextureFormatR8Sint
- | TextureFormatR16Uint
- | TextureFormatR16Sint
- | TextureFormatR16Float
- | TextureFormatRG8Unorm
- | TextureFormatRG8Snorm
- | TextureFormatRG8Uint
- | TextureFormatRG8Sint
- | TextureFormatR32Float
- | TextureFormatR32Uint
- | TextureFormatR32Sint
- | TextureFormatRG16Uint
- | TextureFormatRG16Sint
- | TextureFormatRG16Float
- | TextureFormatRGBA8Unorm
- | TextureFormatRGBA8UnormSrgb
- | TextureFormatRGBA8Snorm
- | TextureFormatRGBA8Uint
- | TextureFormatRGBA8Sint
- | TextureFormatBGRA8Unorm
- | TextureFormatBGRA8UnormSrgb
- | TextureFormatRGB10A2Unorm
- | TextureFormatRG11B10Ufloat
- | TextureFormatRGB9E5Ufloat
- | TextureFormatRG32Float
- | TextureFormatRG32Uint
- | TextureFormatRG32Sint
- | TextureFormatRGBA16Uint
- | TextureFormatRGBA16Sint
- | TextureFormatRGBA16Float
- | TextureFormatRGBA32Float
- | TextureFormatRGBA32Uint
- | TextureFormatRGBA32Sint
- | TextureFormatDepth32Float
- | TextureFormatDepth24Plus
- | TextureFormatDepth24PlusStencil8
- | TextureFormatStencil8
- | TextureFormatBC1RGBAUnorm
- | TextureFormatBC1RGBAUnormSrgb
- | TextureFormatBC2RGBAUnorm
- | TextureFormatBC2RGBAUnormSrgb
- | TextureFormatBC3RGBAUnorm
- | TextureFormatBC3RGBAUnormSrgb
- | TextureFormatBC4RUnorm
- | TextureFormatBC4RSnorm
- | TextureFormatBC5RGUnorm
- | TextureFormatBC5RGSnorm
- | TextureFormatBC6HRGBUfloat
- | TextureFormatBC6HRGBFloat
- | TextureFormatBC7RGBAUnorm
- | TextureFormatBC7RGBAUnormSrgb
data TextureUsage = TextureUsage {
- texCopySrc :: !Bool
- texCopyDst :: !Bool
- texSampled :: !Bool
- texStorage :: !Bool
- texRenderAttachment :: !Bool
}
data Extent3D = Extent3D {
- extentWidth :: !Word32
- extentHeight :: !Word32
- extentDepthOrArrayLayers :: !Word32
}
data TextureDimension
- = TextureDimension1D
- | TextureDimension2D
- | TextureDimension3D
data TextureDescriptor = TextureDescriptor {
- textureLabel :: !Text
- textureSize :: !Extent3D
- mipLevelCount :: !Word32
- sampleCount :: !Word32
- dimension :: !TextureDimension
- format :: !TextureFormat
- textureUsage :: !TextureUsage
}
data Origin3D = Origin3D {
- originX :: !Word32
- originY :: !Word32
- originZ :: !Word32
}
data TextureAspect
- = TextureAspectAll
- | TextureAspectStencilOnly
- | TextureAspectDepthOnly
data ImageCopyTexture = ImageCopyTexture {
- texture :: !Texture
- mipLevel :: !Word32
- origin :: !Origin3D
- aspect :: !TextureAspect
}
data TextureDataLayout = TextureDataLayout {
- textureOffset :: !Word64
- bytesPerRow :: !Word32
- rowsPerImage :: !Word32
}
data TextureViewDescriptor = TextureViewDescriptor {
- textureViewLabel :: !Text
- textureViewFormat :: !TextureFormat
- textureViewDimension :: !TextureViewDimension
- textureViewBaseMipLevel :: !Word32
- textureViewMipLevelCount :: !Word32
- baseArrayLayer :: !Word32
- arrayLayerCount :: !Word32
- textureViewAspect :: !TextureAspect
}
createTexture :: MonadIO m => Device -> TextureDescriptor -> m Texture
createView :: MonadIO m => Texture -> TextureViewDescriptor -> m TextureView
data SwapChain
data SwapChainDescriptor = SwapChainDescriptor {
- swapChainLabel :: !Text
- usage :: !TextureUsage
- swapChainFormat :: !TextureFormat
- swapChainWidth :: !Word32
- swapChainHeight :: !Word32
- presentMode :: !PresentMode
}
data PresentMode
- = PresentModeImmediate
- | PresentModeMailbox
- | PresentModeFifo
getSwapChainPreferredFormat :: MonadIO m => Surface -> Adapter -> m TextureFormat
createSwapChain :: MonadIO m => Device -> Surface -> SwapChainDescriptor -> m SwapChain
getSwapChainCurrentTextureView :: MonadIO m => SwapChain -> m TextureView
swapChainPresent :: MonadIO m => SwapChain -> m ()
data Sampler
data AddressMode
- = AddressModeClampToEdge
- | AddressModeRepeat
- | AddressModeMirrorRepeat
data FilterMode
- = FilterModeNearest
- | FilterModeLinear
data SamplerDescriptor = SamplerDescriptor {
- samplerLabel :: !Text
- addressModeU :: !AddressMode
- addressModeV :: !AddressMode
- addressModeW :: !AddressMode
- magFilter :: !FilterMode
- minFilter :: !FilterMode
- mipmapFilter :: !FilterMode
- lodMinClamp :: !Float
- lodMaxClamp :: !Float
- samplerCompare :: !CompareFunction
- maxAnisotropy :: !Word16
}
createSampler :: MonadIO m => Device -> SamplerDescriptor -> m Sampler
data BindGroup
data BindGroupLayout
data BindGroupDescriptor = BindGroupDescriptor {
- bindGroupLabel :: !Text
- bindGroupLayout :: !BindGroupLayout
- bindGroupEntries :: !(Vector BindGroupEntry)
}
data BindGroupEntry = BindGroupEntry {
- binding :: !Binding
- resource :: !BindingResource
}
data BindGroupLayoutDescriptor = BindGroupLayoutDescriptor {
- bindGroupLayoutLabel :: !Text
- layoutEntries :: !(Vector BindGroupLayoutEntry)
}
data BindGroupLayoutEntry = BindGroupLayoutEntry {
- layoutBinding :: !Binding
- visibility :: !ShaderStage
- bindGroupLayoutEntryType :: !BindingType
}
newtype Binding = Binding {
- unBinding :: Word32
}
data ShaderStage = ShaderStage {
- stageVertex :: !Bool
- stageFragment :: !Bool
- stageCompute :: !Bool
}
data BindingType
- = BindingTypeBuffer !BufferBindingLayout
- | BindingTypeSampler !SamplerBindingLayout
- | BindingTypeTexture !TextureBindingLayout
- | BindingTypeStorageTexture !StorageTextureBindingLayout
data BufferBindingLayout = BufferBindingLayout {
- bindingBufferLayoutType :: !BufferBindingType
- hasDynamicOffset :: !Bool
- minBindingSize :: !(SMaybe Word64)
}
data SamplerBindingLayout
- = SamplerBindingLayoutFiltering
- | SamplerBindingLayoutNonFiltering
- | SamplerBindingLayoutComparison
data TextureBindingLayout = TextureBindingLayout {
- sampleType :: !TextureSampleType
- textureBindingViewDimension :: !TextureViewDimension
- multiSampled :: !Bool
}
data StorageTextureBindingLayout = StorageTextureBindingLayout {
- access :: !StorageTextureAccess
- storageTextureFormat :: !TextureFormat
- storageTextureViewDimension :: !TextureViewDimension
}
data StorageTextureAccess
- = StorageTextureAccessReadOnly
- | StorageTextureAccessWriteOnly
- | StorageTextureAccessReadWrite
data TextureSampleType
- = TextureSampleTypeFloat {
  - filterable :: !Bool
  }
- | TextureSampleTypeDepth
- | TextureSampleTypeSignedInt
- | TextureSampleTypeUnsignedInt
data BufferBindingType
- = Uniform
- | Storage {
  - readOnly :: !Bool
  }
data BindingResource
- = BindingResourceBuffer !BufferBinding
- | BindingResourceSampler !Sampler
- | BindingResourceTextureView !TextureView
data BufferBinding = BufferBinding {
- bindingBuffer :: !Buffer
- bindingBufferOffset :: !Word64
- bindingBufferSize :: !Word64
}
createBindGroup :: MonadIO m => Device -> BindGroupDescriptor -> m BindGroup
createBindGroupLayout :: MonadIO m => Device -> BindGroupLayoutDescriptor -> m BindGroupLayout
data ShaderModule
data ShaderModuleDescriptor = ShaderModuleDescriptor {
- shaderLabel :: !Text
- source :: !ShaderSource
}
data ShaderSource
- = ShaderSourceSPIRV !SPIRV
- | ShaderSourceWGSL !WGSL
newtype SPIRV = SPIRV ByteString
newtype WGSL = WGSL Text
newtype ShaderEntryPoint = ShaderEntryPoint {
- unShaderEntryPoint :: Text
}
createShaderModule :: MonadIO m => Device -> ShaderModuleDescriptor -> m ShaderModule
createShaderModuleSPIRV :: MonadIO m => Device -> Text -> SPIRV -> m ShaderModule
createShaderModuleWGSL :: MonadIO m => Device -> Text -> WGSL -> m ShaderModule
data PipelineLayout
data RenderPipeline
data PipelineLayoutDescriptor = PipelineLayoutDescriptor {
- pipelineLabel :: !Text
- bindGroupLayouts :: !(Vector BindGroupLayout)
}
data RenderPipelineDescriptor = RenderPipelineDescriptor {
- renderPipelineLabel :: !Text
- layout :: !(SMaybe PipelineLayout)
- vertex :: !VertexState
- primitive :: !PrimitiveState
- depthStencil :: !(SMaybe DepthStencilState)
- multisample :: !MultisampleState
- fragment :: !(SMaybe FragmentState)
}
data VertexFormat
- = VertexFormatUint8x2
- | VertexFormatUint8x4
- | VertexFormatSint8x2
- | VertexFormatSint8x4
- | VertexFormatUnorm8x2
- | VertexFormatUnorm8x4
- | VertexFormatSnorm8x2
- | VertexFormatSnorm8x4
- | VertexFormatUint16x2
- | VertexFormatUint16x4
- | VertexFormatSint16x2
- | VertexFormatSint16x4
- | VertexFormatUnorm16x2
- | VertexFormatUnorm16x4
- | VertexFormatSnorm16x2
- | VertexFormatSnorm16x4
- | VertexFormatFloat16x2
- | VertexFormatFloat16x4
- | VertexFormatFloat32
- | VertexFormatFloat32x2
- | VertexFormatFloat32x3
- | VertexFormatFloat32x4
- | VertexFormatUint32
- | VertexFormatUint32x2
- | VertexFormatUint32x3
- | VertexFormatUint32x4
- | VertexFormatSint32
- | VertexFormatSint32x2
- | VertexFormatSint32x3
- | VertexFormatSint32x4
data VertexAttribute = VertexAttribute {
- vertexFormat :: !VertexFormat
- vertexOffset :: !Word64
- shaderLocation :: !Word32
}
data InputStepMode
- = InputStepModeVertex
- | InputStepModeInstance
data VertexBufferLayout = VertexBufferLayout {
- arrayStride :: !Word64
- stepMode :: !InputStepMode
- attributes :: !(Vector VertexAttribute)
}
data VertexState = VertexState {
- vertexShaderModule :: !ShaderModule
- vertexEntryPoint :: !ShaderEntryPoint
- buffers :: !(Vector VertexBufferLayout)
}
data PrimitiveTopology
- = PrimitiveTopologyPointList
- | PrimitiveTopologyLineList
- | PrimitiveTopologyLineStrip
- | PrimitiveTopologyTriangleList
- | PrimitiveTopologyTriangleStrip
data IndexFormat
- = IndexFormatUint16
- | IndexFormatUint32
data FrontFace
- = FrontFaceCCW
- | FrontFaceCW
data CullMode
- = CullModeFront
- | CullModeBack
- | CullModeNone
data PrimitiveState = PrimitiveState {
- topology :: !PrimitiveTopology
- stripIndexFormat :: !(SMaybe IndexFormat)
- frontFace :: !FrontFace
- cullMode :: !CullMode
}
data StencilOperation
- = StencilOperationKeep
- | StencilOperationZero
- | StencilOperationReplace
- | StencilOperationInvert
- | StencilOperationIncrementClamp
- | StencilOperationDecrementClamp
- | StencilOperationIncrementWrap
- | StencilOperationDecrementWrap
data StencilState = StencilState {
- front :: !StencilFaceState
- back :: !StencilFaceState
- readMask :: !Word8
- writeMask :: !Word8
}
data DepthBiasState = DepthBiasState {
- constant :: !Int32
- slopeScale :: !Float
- clamp :: !Float
}
data DepthStencilState = DepthStencilState {
- depthStencilTextureFormat :: !TextureFormat
- depthWriteEnabled :: !Bool
- depthCompare :: !CompareFunction
- stencil :: !StencilState
- bias :: !DepthBiasState
}
data MultisampleState = MultisampleState {
- count :: Word32
- mask :: Word32
- alphaToCoverageEnabled :: Bool
}
data BlendFactor
- = BlendFactorZero
- | BlendFactorOne
- | BlendFactorSrc
- | BlendFactorOneMinusSrc
- | BlendFactorSrcAlpha
- | BlendFactorOneMinusSrcAlpha
- | BlendFactorDst
- | BlendFactorOneMinusDst
- | BlendFactorDstAlpha
- | BlendFactorOneMinusDstAlpha
- | BlendFactorSrcAlphaSaturated
- | BlendFactorConstant
- | BlendFactorOneMinusConstant
data BlendOperation
- = BlendOperationAdd
- | BlendOperationSubtract
- | BlendOperationReverseSubtract
- | BlendOperationMin
- | BlendOperationMax
data BlendComponent = BlendComponent {
- srcFactor :: !BlendFactor
- dstFactor :: !BlendFactor
- operation :: !BlendOperation
}
data BlendState = BlendState {
- blendColor :: !BlendComponent
- blendAlpha :: !BlendComponent
}
data ColorWriteMask = ColorWriteMask {
- maskRed :: !Bool
- maskGreen :: !Bool
- maskBlue :: !Bool
- maskAlpha :: !Bool
}
data ColorTargetState = ColorTargetState {
- colorTextureFormat :: !TextureFormat
- blend :: !(SMaybe BlendState)
- colorWriteMask :: !ColorWriteMask
}
data FragmentState = FragmentState {
- fragmentShaderModule :: !ShaderModule
- fragmentEntryPoint :: !ShaderEntryPoint
- targets :: !(Vector ColorTargetState)
}
createPipelineLayout :: MonadIO m => Device -> PipelineLayoutDescriptor -> m PipelineLayout
createRenderPipeline :: MonadIO m => Device -> RenderPipelineDescriptor -> m RenderPipeline
colorWriteMaskAll :: ColorWriteMask
data CommandBuffer
data CommandEncoder
data RenderPassEncoder
data Color = Color {
- red :: !Double
- green :: !Double
- blue :: !Double
- alpha :: !Double
}
data LoadOp a
- = LoadOpClear !a
- | LoadOpLoad
data StoreOp
- = StoreOpStore
- | StoreOpClear
data Operations a = Operations {
- load :: !(LoadOp a)
- store :: !StoreOp
}
data RenderPassColorAttachment = RenderPassColorAttachment {
- colorView :: !TextureView
- resolveTarget :: !(SMaybe TextureView)
- operations :: !(Operations Color)
}
data RenderPassDepthStencilAttachment = RenderPassDepthStencilAttachment {
- depthStencilView :: !TextureView
- depthOps :: !(SMaybe (Operations Float))
- stencilOps :: !(SMaybe (Operations Word32))
}
data RenderPassDescriptor = RenderPassDescriptor {
- renderPassLabel :: !Text
- colorAttachments :: !(Vector RenderPassColorAttachment)
- depthStencilAttachment :: !(SMaybe RenderPassDepthStencilAttachment)
}
data Range a = Range {
- rangeStart :: !a
- rangeLength :: !a
}
createCommandEncoder :: MonadIO m => Device -> Text -> m CommandEncoder
commandEncoderFinish :: MonadIO m => CommandEncoder -> Text -> m CommandBuffer
beginRenderPass :: MonadIO m => CommandEncoder -> RenderPassDescriptor -> m RenderPassEncoder
renderPassSetPipeline :: MonadIO m => RenderPassEncoder -> RenderPipeline -> m ()
renderPassSetBindGroup :: MonadIO m => RenderPassEncoder -> Word32 -> BindGroup -> Vector Word32 -> m ()
renderPassSetIndexBuffer :: MonadIO m => RenderPassEncoder -> Buffer -> IndexFormat -> Word64 -> Word64 -> m ()
renderPassSetVertexBuffer :: MonadIO m => RenderPassEncoder -> Word32 -> Buffer -> Word64 -> Word64 -> m ()
renderPassDraw :: MonadIO m => RenderPassEncoder -> Range Word32 -> Range Word32 -> m ()
renderPassDrawIndexed :: MonadIO m => RenderPassEncoder -> Range Word32 -> Int32 -> Range Word32 -> m ()
endRenderPass :: MonadIO m => RenderPassEncoder -> m ()
data Queue
getQueue :: MonadIO m => Device -> m Queue
queueSubmit :: MonadIO m => Queue -> Vector CommandBuffer -> m ()
queueWriteTexture :: (MonadIO m, ReadableMemoryBuffer a) => Queue -> ImageCopyTexture -> TextureDataLayout -> Extent3D -> a -> m ()
queueWriteBuffer :: (MonadIO m, ReadableMemoryBuffer a) => Queue -> Buffer -> a -> m ()
data Version = Version {
- major :: !Word8
- minor :: !Word8
- patch :: !Word8
- subPatch :: !Word8
}
getVersion :: MonadIO m => Instance -> m Version
versionToText :: Version -> Text
data LogLevel
- = Trace
- | Debug
- | Info
- | Warn
- | Error
connectLog :: MonadIO m => Instance -> m ()
disconnectLog :: MonadIO m => Instance -> m ()
setLogLevel :: MonadIO m => Instance -> LogLevel -> m ()
data CompareFunction
- = CompareFunctionNever
- | CompareFunctionLess
- | CompareFunctionEqual
- | CompareFunctionLessEqual
- | CompareFunctionGreater
- | CompareFunctionNotEqual
- | CompareFunctionGreaterEqual
- | CompareFunctionAlways
data SMaybe a
- = SNothing
- | SJust !a
fromSMaybe :: a -> SMaybe a -> a
class ReadableMemoryBuffer a where
- withReadablePtr :: a -> (Ptr () -> IO b) -> IO b
- readableMemoryBufferSize :: a -> ByteSize
newtype ByteSize = ByteSize {
- unByteSize :: Word64
}

Introduction

Introduction to WebGPU

WebGPU is a future web standard for graphics and compute, developed by the W3C. It is currently (August 2021) an emerging technology, and not yet stable. In addition to its JavaScript API, there are also early attempts to create a native binding (ie. a C language binding). Two implementations of the native binding are:

wgpu-native: a Rust implementation used in the Firefox web browser.
dawn: a C++ implementation,used in the Chrome web browser.

The native bindings to WebGPU have the potential to become a portable, next-generation GPU API which is easy to use. Vulkan is also currently available across platforms, but it is very low-level. In the opinion of the author of this package, Vulkan is very difficult to use directly from Haskell. It would benefit greatly from a shim layer which performs common tasks and streamlines many operations. Not unexpectedly, that is exactly the role that WebGPU native can play.

Platform Support

Currently, macOS (Metal), Windows and Linux are supported.

Windowing System Support

The bindings support both GLFW-b and SDL as windowing systems on macOS, Windows and Linux. The windowing system bindings are somewhat hacky (due to the early stage of WebGPU Native), but they work.

Structure of Bindings

The bindings to wgpu-native are structured in three packages:

The wgpu-raw-hs-codegen package is a code generator for the raw bindings. It creates all the packages named WGPU.Raw.Generated.* (without exception!).
The wgpu-raw-hs package provides raw bindings to wgpu-native. They are "raw" in the sense that they contain raw pointers and are not usable without manual construction of the C structs that must be passed to the API.
The wgpu-hs package (this one) provides high-level bindings. These bindings are written manually. They are improvements on the raw bindings in the following ways:
- There are no more raw Ptr types.
- There are no callbacks.
- Several parts of the API are tweaked slightly to more closely resemble the Rust API.
- Names are de-duplicated.

Native Library Handling

The native library for wgpu-native is not required at compile-time for this package. The library is loaded dynamically at runtime.

Initialization

The first step in using these Haskell bindings is to obtain an Instance. This acts as a handle to the rest of the API. An Instance is obtained at runtime by loading a dynamic library containing the WGPU binding symbols. Currently, only the C/Rust library from wgpu-native is supported.

To load the dynamic library and obtain an instance, use the withPlatformInstance or withInstance bracketing functions. These functions take a function that performs bracketing.

withPlatformInstance bracket $ inst -> do -- attach the logger and set the logging level (optional) connectLog inst setLogLevel inst Warn -- run the rest of the program...

After creating an Instance, you may next want to create a surface.

data Instance #

Instance of the WGPU API.

An instance is loaded from a dynamic library using the withInstance function.

Instances

Instances details

Show Instance
Instance details Defined in WGPU.Internal.Instance Methods showsPrec :: Int -> Instance -> ShowS # show :: Instance -> String # showList :: [Instance] -> ShowS #
Has Instance Resources Source #
Instance details Defined in WGPU.BoneYard.SimpleSDL Methods getter :: Resources -> Instance # modifier :: (Instance -> Instance) -> Resources -> Resources # hasLens :: Lens Resources Instance #
ToRaw Instance WGPUHsInstance
Instance details Defined in WGPU.Internal.Instance Methods raw :: Instance -> ContT r IO WGPUHsInstance #

withPlatformInstance #

Arguments

:: MonadIO m
=> (m Instance -> (Instance -> m ()) -> r)	Bracketing function. This can (for example) be something like `bracket`.
-> r	Usage or action component of the bracketing function.

Load the WGPU API from a dynamic library and supply an Instance to a program.

This is the same as withInstance, except that it uses a default, per-platform name for the library, based on the value returned by os.

withInstance #

Arguments

:: MonadIO m
=> FilePath	Name of the `wgpu-native` dynamic library, or a complete path to it.
-> (m Instance -> (Instance -> m ()) -> r)	Bracketing function. This can (for example) be something like `bracket`.
-> r	Usage or action component of the bracketing function.

Load the WGPU API from a dynamic library and supply an Instance to a program.

Surface

A Surface is a handle to a platform-specific presentable surface, like a window. First, create either a GLFW or SDL window, and then create a surface using either createSurface (GLFW) or createSurface (SDL2).

Once you have a Surface, the next step is usually to request an adapter that is compatible with it.

data Surface #

Handle to a presentable surface.

A Surface presents a platform-specific surface (eg. a window) on to which rendered images may be presented. A Surface can be created for a GLFW window using createGLFWSurface.

Instances

Instances details

Eq Surface
Instance details Defined in WGPU.Internal.Surface Methods (==) :: Surface -> Surface -> Bool # (/=) :: Surface -> Surface -> Bool #
Show Surface
Instance details Defined in WGPU.Internal.Surface Methods showsPrec :: Int -> Surface -> ShowS # show :: Surface -> String # showList :: [Surface] -> ShowS #
Has Surface Resources Source #
Instance details Defined in WGPU.BoneYard.SimpleSDL Methods getter :: Resources -> Surface # modifier :: (Surface -> Surface) -> Resources -> Resources # hasLens :: Lens Resources Surface #
ToRaw Surface WGPUSurface
Instance details Defined in WGPU.Internal.Surface Methods raw :: Surface -> ContT r IO WGPUSurface #

Adapter

An Adapter is a handle to a physical device. For example, a physical display adaptor (GPU) or a software renderer. Currently you obtain an adapter using requestAdapter, which requests an adapter that is compatible with an existing Surface.

After obtaining an adapter, you will typically want to request a device.

data Adapter #

Handle to a physical graphics and/or compute device.

Request an Adapter for a Surface using the requestAdapter function.

Instances

Instances details

Eq Adapter
Instance details Defined in WGPU.Internal.Adapter Methods (==) :: Adapter -> Adapter -> Bool # (/=) :: Adapter -> Adapter -> Bool #
Show Adapter
Instance details Defined in WGPU.Internal.Adapter Methods showsPrec :: Int -> Adapter -> ShowS # show :: Adapter -> String # showList :: [Adapter] -> ShowS #
Has Adapter Resources Source #
Instance details Defined in WGPU.BoneYard.SimpleSDL Methods getter :: Resources -> Adapter # modifier :: (Adapter -> Adapter) -> Resources -> Resources # hasLens :: Lens Resources Adapter #
ToRaw Adapter WGPUAdapter
Instance details Defined in WGPU.Internal.Adapter Methods raw :: Adapter -> ContT r IO WGPUAdapter #

data AdapterType #

Physical device type.

Constructors

AdapterTypeDiscreteGPU
AdapterTypeIntegratedGPU
AdapterTypeCPU
AdapterTypeUnknown

Instances

Instances details

Eq AdapterType
Instance details Defined in WGPU.Internal.Adapter Methods (==) :: AdapterType -> AdapterType -> Bool # (/=) :: AdapterType -> AdapterType -> Bool #
Show AdapterType
Instance details Defined in WGPU.Internal.Adapter Methods showsPrec :: Int -> AdapterType -> ShowS # show :: AdapterType -> String # showList :: [AdapterType] -> ShowS #
ToRaw AdapterType WGPUAdapterType
Instance details Defined in WGPU.Internal.Adapter Methods raw :: AdapterType -> ContT r IO WGPUAdapterType #
FromRaw WGPUAdapterType AdapterType
Instance details Defined in WGPU.Internal.Adapter Methods fromRaw :: MonadIO m => WGPUAdapterType -> m AdapterType #

data BackendType #

Backends supported by WGPU.

Constructors

BackendTypeNull
BackendTypeD3D11
BackendTypeD3D12
BackendTypeMetal
BackendTypeVulkan
BackendTypeOpenGL
BackendTypeOpenGLES

Instances

Instances details

Eq BackendType
Instance details Defined in WGPU.Internal.Adapter Methods (==) :: BackendType -> BackendType -> Bool # (/=) :: BackendType -> BackendType -> Bool #
Show BackendType
Instance details Defined in WGPU.Internal.Adapter Methods showsPrec :: Int -> BackendType -> ShowS # show :: BackendType -> String # showList :: [BackendType] -> ShowS #
ToRaw BackendType WGPUBackendType
Instance details Defined in WGPU.Internal.Adapter Methods raw :: BackendType -> ContT r IO WGPUBackendType #
FromRaw WGPUBackendType BackendType
Instance details Defined in WGPU.Internal.Adapter Methods fromRaw :: MonadIO m => WGPUBackendType -> m BackendType #

data AdapterProperties #

Constructors

AdapterProperties
Fields deviceID :: !Word32 vendorID :: !Word32 adapterName :: !Text driverDescription :: !Text adapterType :: !AdapterType backendType :: !BackendType

Instances

Instances details

Eq AdapterProperties
Instance details Defined in WGPU.Internal.Adapter Methods (==) :: AdapterProperties -> AdapterProperties -> Bool # (/=) :: AdapterProperties -> AdapterProperties -> Bool #
Show AdapterProperties
Instance details Defined in WGPU.Internal.Adapter Methods showsPrec :: Int -> AdapterProperties -> ShowS # show :: AdapterProperties -> String # showList :: [AdapterProperties] -> ShowS #
ToRaw AdapterProperties WGPUAdapterProperties
Instance details Defined in WGPU.Internal.Adapter Methods raw :: AdapterProperties -> ContT r IO WGPUAdapterProperties #
FromRaw WGPUAdapterProperties AdapterProperties
Instance details Defined in WGPU.Internal.Adapter Methods fromRaw :: MonadIO m => WGPUAdapterProperties -> m AdapterProperties #

requestAdapter #

Arguments

:: MonadIO m
=> Surface	Existing surface for which to request an `Adapter`.
-> m (Maybe Adapter)	The returned `Adapter`, if it could be retrieved.

Request an Adapter that is compatible with a given Surface.

This action blocks until an available adapter is returned.

getAdapterProperties :: MonadIO m => Adapter -> m AdapterProperties #

Get information about an adapter.

adapterPropertiesToText :: AdapterProperties -> Text #

Format adapter properties into a multi-line block of text.

This can be useful for debugging purposes.

Device

A Device is an open connection to a graphics and/or compute device. A Device is created using the requestDevice function.

(According to the WebGPU API documentation, a Device may also be "lost". However, it's not yet clear how that event will be signalled to the C API, nor how to handle it.)

data Device #

An open connection to a graphics and/or compute device.

A Device may be created using the requestDevice function.

Instances

Instances details

Eq Device
Instance details Defined in WGPU.Internal.Device Methods (==) :: Device -> Device -> Bool # (/=) :: Device -> Device -> Bool #
Show Device
Instance details Defined in WGPU.Internal.Device Methods showsPrec :: Int -> Device -> ShowS # show :: Device -> String # showList :: [Device] -> ShowS #
Has Device Resources Source #
Instance details Defined in WGPU.BoneYard.SimpleSDL Methods getter :: Resources -> Device # modifier :: (Device -> Device) -> Resources -> Resources # hasLens :: Lens Resources Device #
ToRaw Device WGPUDevice
Instance details Defined in WGPU.Internal.Device Methods raw :: Device -> ContT r IO WGPUDevice #

data DeviceDescriptor #

Describes a Device.

Constructors

DeviceDescriptor
Fields deviceLabel :: !Text Debug label for the device. features :: !Features Features that the device should support. limits :: !Limits Limits that the device should support (minimum values).

Instances

Instances details

Eq DeviceDescriptor
Instance details Defined in WGPU.Internal.Device Methods (==) :: DeviceDescriptor -> DeviceDescriptor -> Bool # (/=) :: DeviceDescriptor -> DeviceDescriptor -> Bool #
Show DeviceDescriptor
Instance details Defined in WGPU.Internal.Device Methods showsPrec :: Int -> DeviceDescriptor -> ShowS # show :: DeviceDescriptor -> String # showList :: [DeviceDescriptor] -> ShowS #
Default DeviceDescriptor
Instance details Defined in WGPU.Internal.Device Methods def :: DeviceDescriptor #
ToRaw DeviceDescriptor WGPUDeviceExtras
Instance details Defined in WGPU.Internal.Device Methods raw :: DeviceDescriptor -> ContT r IO WGPUDeviceExtras #

data Limits #

Device limits.

Represents the set of limits an adapter/device supports.

Constructors

Limits

Fields

maxTextureDimension1D :: !Word32
Maximum allowed value for the width of a 1D texture.
maxTextureDimension2D :: !Word32
Maximum allowed value for the width and height of a 2D texture.
maxTextureDimension3D :: !Word32
Maximum allowed value for the width, height or depth of a 3D texture.
maxTextureArrayLayers :: !Word32
Maximum allowed value for the array layers of a texture.
maxBindGroups :: !Word32
Amount of bind groups that can be attached to a pipeline at the same time.
maxDynamicStorageBuffersPerPipelineLayout :: !Word32
Amount of storage buffer bindings that can be dynamic in a single pipeline.
maxStorageBuffersPerShaderStage :: !Word32
Amount of sampled textures visible in a single shader stage.
maxStorageBufferBindingSize :: !Word32
Maximum size in bytes of a binding to a uniform buffer.

Instances

Instances details

Eq Limits
Instance details Defined in WGPU.Internal.Device Methods (==) :: Limits -> Limits -> Bool # (/=) :: Limits -> Limits -> Bool #
Show Limits
Instance details Defined in WGPU.Internal.Device Methods showsPrec :: Int -> Limits -> ShowS # show :: Limits -> String # showList :: [Limits] -> ShowS #
Default Limits
Instance details Defined in WGPU.Internal.Device Methods def :: Limits #

newtype Features #

Device features that are not guaranteed to be supported.

NOTE: The Rust API currently has far more extensive Features. Perhaps they have not yet been ported to the C API? https://docs.rs/wgpu-types/0.9.0/wgpu_types/struct.Features.html

Constructors

Features
Fields textureAdapterSpecificFormatFeatures :: Bool

Instances

Instances details

Eq Features
Instance details Defined in WGPU.Internal.Device Methods (==) :: Features -> Features -> Bool # (/=) :: Features -> Features -> Bool #
Show Features
Instance details Defined in WGPU.Internal.Device Methods showsPrec :: Int -> Features -> ShowS # show :: Features -> String # showList :: [Features] -> ShowS #
Default Features
Instance details Defined in WGPU.Internal.Device Methods def :: Features #
ToRaw Features WGPUNativeFeature
Instance details Defined in WGPU.Internal.Device Methods raw :: Features -> ContT r IO WGPUNativeFeature #

requestDevice #

Arguments

:: MonadIO m
=> Adapter	`Adapter` for which the device will be returned.
-> DeviceDescriptor	The features and limits requested for the device.
-> m (Maybe Device)	The returned `Device`, if it could be retrieved.

Requests a connection to a physical device, creating a logical device.

This action blocks until an available device is returned.

Buffers

data Buffer #

Handle to a buffer.

Instances

Instances details

Eq Buffer
Instance details Defined in WGPU.Internal.Buffer Methods (==) :: Buffer -> Buffer -> Bool # (/=) :: Buffer -> Buffer -> Bool #
Show Buffer
Instance details Defined in WGPU.Internal.Buffer Methods showsPrec :: Int -> Buffer -> ShowS # show :: Buffer -> String # showList :: [Buffer] -> ShowS #
ToRaw Buffer WGPUBuffer
Instance details Defined in WGPU.Internal.Buffer Methods raw :: Buffer -> ContT r IO WGPUBuffer #

data BufferDescriptor #

Describes a Buffer.

Constructors

BufferDescriptor

Fields

bufferLabel :: !Text
Debugging label for the buffer.
bufferSize :: !ByteSize
Size of the buffer, in bytes.
bufferUsage :: !BufferUsage
Usage(s) of the buffer.
mappedAtCreation :: Bool
Is the buffer mapped to host memory at creation? If this is set to True, then the buffer may be more easily populated with data initially. See createBufferInit for a way to create a buffer and initialize it with data in one step.

Instances

Instances details

Eq BufferDescriptor
Instance details Defined in WGPU.Internal.Buffer Methods (==) :: BufferDescriptor -> BufferDescriptor -> Bool # (/=) :: BufferDescriptor -> BufferDescriptor -> Bool #
Show BufferDescriptor
Instance details Defined in WGPU.Internal.Buffer Methods showsPrec :: Int -> BufferDescriptor -> ShowS # show :: BufferDescriptor -> String # showList :: [BufferDescriptor] -> ShowS #
ToRaw BufferDescriptor WGPUBufferDescriptor
Instance details Defined in WGPU.Internal.Buffer Methods raw :: BufferDescriptor -> ContT r IO WGPUBufferDescriptor #

data BufferUsage #

Different ways you can use a buffer.

Constructors

BufferUsage

Fields

bufMapRead :: !Bool
Allow a buffer to be mapped for reading.
bufMapWrite :: !Bool
Allow a buffer to be mapped for writing.
bufCopySrc :: !Bool
Allow a buffer to be a source buffer for a copy operation.
bufCopyDst :: !Bool
Allow a buffer to be a destination buffer for a copy operation.
bufIndex :: !Bool
Allow a buffer to be the index buffer in a draw operation.
bufVertex :: !Bool
Allow a buffer to be the vertex buffer in a draw operation.
bufUniform :: !Bool
Allow a buffer to be a uniform binding in a bind group.
bufStorage :: !Bool
Allow a buffer to be a storage binding in a bind group.
bufIndirect :: !Bool
Allow a buffer to be the indirect buffer in an indirect draw call.

Instances

Instances details

Eq BufferUsage
Instance details Defined in WGPU.Internal.Buffer Methods (==) :: BufferUsage -> BufferUsage -> Bool # (/=) :: BufferUsage -> BufferUsage -> Bool #
Show BufferUsage
Instance details Defined in WGPU.Internal.Buffer Methods showsPrec :: Int -> BufferUsage -> ShowS # show :: BufferUsage -> String # showList :: [BufferUsage] -> ShowS #
Default BufferUsage
Instance details Defined in WGPU.Internal.Buffer Methods def :: BufferUsage #
ToRaw BufferUsage Word32
Instance details Defined in WGPU.Internal.Buffer Methods raw :: BufferUsage -> ContT r IO Word32 #

createBuffer :: MonadIO m => Device -> BufferDescriptor -> m Buffer #

Create a Buffer.

createBufferInit #

Arguments

:: forall a m. (MonadIO m, ReadableMemoryBuffer a)
=> Device	Device for which to create the buffer.
-> Text	Debugging label for the buffer.
-> BufferUsage	Usage for the buffer.
-> a	Data to initialize the buffer with.
-> m Buffer	Buffer created with the specified data.

Create a Buffer with data to initialize it.

Textures and Views

data Texture #

Handle to a texture.

Instances

Instances details

Eq Texture
Instance details Defined in WGPU.Internal.Multipurpose Methods (==) :: Texture -> Texture -> Bool # (/=) :: Texture -> Texture -> Bool #
Show Texture
Instance details Defined in WGPU.Internal.Multipurpose Methods showsPrec :: Int -> Texture -> ShowS # show :: Texture -> String # showList :: [Texture] -> ShowS #
ToRaw Texture WGPUTexture
Instance details Defined in WGPU.Internal.Multipurpose Methods raw :: Texture -> ContT r IO WGPUTexture #

data TextureView #

Handle to a texture view.

A TextureView describes a texture and associated metadata needed by a rendering pipeline or bind group.

Instances

Instances details

Eq TextureView
Instance details Defined in WGPU.Internal.Texture Methods (==) :: TextureView -> TextureView -> Bool # (/=) :: TextureView -> TextureView -> Bool #
Show TextureView
Instance details Defined in WGPU.Internal.Texture Methods showsPrec :: Int -> TextureView -> ShowS # show :: TextureView -> String # showList :: [TextureView] -> ShowS #
ToRaw TextureView WGPUTextureView
Instance details Defined in WGPU.Internal.Texture Methods raw :: TextureView -> ContT r IO WGPUTextureView #

data TextureViewDimension #

Dimensions of a particular texture view.

Constructors

TextureViewDimension1D
TextureViewDimension2D
TextureViewDimension2DArray
TextureViewDimensionCube
TextureViewDimensionCubeArray
TextureViewDimension3D

Instances

Instances details

Eq TextureViewDimension
Instance details Defined in WGPU.Internal.Texture Methods (==) :: TextureViewDimension -> TextureViewDimension -> Bool # (/=) :: TextureViewDimension -> TextureViewDimension -> Bool #
Show TextureViewDimension
Instance details Defined in WGPU.Internal.Texture Methods showsPrec :: Int -> TextureViewDimension -> ShowS # show :: TextureViewDimension -> String # showList :: [TextureViewDimension] -> ShowS #
ToRaw TextureViewDimension WGPUTextureViewDimension
Instance details Defined in WGPU.Internal.Texture Methods raw :: TextureViewDimension -> ContT r IO WGPUTextureViewDimension #

data TextureFormat #

Texture data format.

Constructors

TextureFormatR8Unorm
TextureFormatR8Snorm
TextureFormatR8Uint
TextureFormatR8Sint
TextureFormatR16Uint
TextureFormatR16Sint
TextureFormatR16Float
TextureFormatRG8Unorm
TextureFormatRG8Snorm
TextureFormatRG8Uint
TextureFormatRG8Sint
TextureFormatR32Float
TextureFormatR32Uint
TextureFormatR32Sint
TextureFormatRG16Uint
TextureFormatRG16Sint
TextureFormatRG16Float
TextureFormatRGBA8Unorm
TextureFormatRGBA8UnormSrgb
TextureFormatRGBA8Snorm
TextureFormatRGBA8Uint
TextureFormatRGBA8Sint
TextureFormatBGRA8Unorm
TextureFormatBGRA8UnormSrgb
TextureFormatRGB10A2Unorm
TextureFormatRG11B10Ufloat
TextureFormatRGB9E5Ufloat
TextureFormatRG32Float
TextureFormatRG32Uint
TextureFormatRG32Sint
TextureFormatRGBA16Uint
TextureFormatRGBA16Sint
TextureFormatRGBA16Float
TextureFormatRGBA32Float
TextureFormatRGBA32Uint
TextureFormatRGBA32Sint
TextureFormatDepth32Float
TextureFormatDepth24Plus
TextureFormatDepth24PlusStencil8
TextureFormatStencil8
TextureFormatBC1RGBAUnorm
TextureFormatBC1RGBAUnormSrgb
TextureFormatBC2RGBAUnorm
TextureFormatBC2RGBAUnormSrgb
TextureFormatBC3RGBAUnorm
TextureFormatBC3RGBAUnormSrgb
TextureFormatBC4RUnorm
TextureFormatBC4RSnorm
TextureFormatBC5RGUnorm
TextureFormatBC5RGSnorm
TextureFormatBC6HRGBUfloat
TextureFormatBC6HRGBFloat
TextureFormatBC7RGBAUnorm
TextureFormatBC7RGBAUnormSrgb

Instances

Instances details

Eq TextureFormat
Instance details Defined in WGPU.Internal.Texture Methods (==) :: TextureFormat -> TextureFormat -> Bool # (/=) :: TextureFormat -> TextureFormat -> Bool #
Show TextureFormat
Instance details Defined in WGPU.Internal.Texture Methods showsPrec :: Int -> TextureFormat -> ShowS # show :: TextureFormat -> String # showList :: [TextureFormat] -> ShowS #
ToRaw TextureFormat WGPUTextureFormat
Instance details Defined in WGPU.Internal.Texture Methods raw :: TextureFormat -> ContT r IO WGPUTextureFormat #

data TextureUsage #

Different ways you can use a texture.

The usages determine from what kind of memory the texture is allocated, and in what actions the texture can partake.

Constructors

TextureUsage
Fields texCopySrc :: !Bool texCopyDst :: !Bool texSampled :: !Bool texStorage :: !Bool texRenderAttachment :: !Bool

Instances

Instances details

Eq TextureUsage
Instance details Defined in WGPU.Internal.Texture Methods (==) :: TextureUsage -> TextureUsage -> Bool # (/=) :: TextureUsage -> TextureUsage -> Bool #
Show TextureUsage
Instance details Defined in WGPU.Internal.Texture Methods showsPrec :: Int -> TextureUsage -> ShowS # show :: TextureUsage -> String # showList :: [TextureUsage] -> ShowS #
Default TextureUsage
Instance details Defined in WGPU.Internal.Texture Methods def :: TextureUsage #
ToRaw TextureUsage WGPUTextureUsageFlags
Instance details Defined in WGPU.Internal.Texture Methods raw :: TextureUsage -> ContT r IO WGPUTextureUsageFlags #

data Extent3D #

Extent of a texture or texture-related operation.

Constructors

Extent3D
Fields extentWidth :: !Word32 extentHeight :: !Word32 extentDepthOrArrayLayers :: !Word32

Instances

Instances details

Eq Extent3D
Instance details Defined in WGPU.Internal.Multipurpose Methods (==) :: Extent3D -> Extent3D -> Bool # (/=) :: Extent3D -> Extent3D -> Bool #
Show Extent3D
Instance details Defined in WGPU.Internal.Multipurpose Methods showsPrec :: Int -> Extent3D -> ShowS # show :: Extent3D -> String # showList :: [Extent3D] -> ShowS #
ToRaw Extent3D WGPUExtent3D
Instance details Defined in WGPU.Internal.Multipurpose Methods raw :: Extent3D -> ContT r IO WGPUExtent3D #

data TextureDimension #

Dimensionality of a texture.

Constructors

TextureDimension1D
TextureDimension2D
TextureDimension3D

Instances

Instances details

Eq TextureDimension
Instance details Defined in WGPU.Internal.Texture Methods (==) :: TextureDimension -> TextureDimension -> Bool # (/=) :: TextureDimension -> TextureDimension -> Bool #
Show TextureDimension
Instance details Defined in WGPU.Internal.Texture Methods showsPrec :: Int -> TextureDimension -> ShowS # show :: TextureDimension -> String # showList :: [TextureDimension] -> ShowS #
ToRaw TextureDimension WGPUTextureDimension
Instance details Defined in WGPU.Internal.Texture Methods raw :: TextureDimension -> ContT r IO WGPUTextureDimension #

data TextureDescriptor #

Describes a Texture.

Constructors

TextureDescriptor
Fields textureLabel :: !Text textureSize :: !Extent3D mipLevelCount :: !Word32 sampleCount :: !Word32 dimension :: !TextureDimension format :: !TextureFormat textureUsage :: !TextureUsage

Instances

Instances details

Eq TextureDescriptor
Instance details Defined in WGPU.Internal.Texture Methods (==) :: TextureDescriptor -> TextureDescriptor -> Bool # (/=) :: TextureDescriptor -> TextureDescriptor -> Bool #
Show TextureDescriptor
Instance details Defined in WGPU.Internal.Texture Methods showsPrec :: Int -> TextureDescriptor -> ShowS # show :: TextureDescriptor -> String # showList :: [TextureDescriptor] -> ShowS #
ToRaw TextureDescriptor WGPUTextureDescriptor
Instance details Defined in WGPU.Internal.Texture Methods raw :: TextureDescriptor -> ContT r IO WGPUTextureDescriptor #

data Origin3D #

Origin of a copy to/from a texture.

Constructors

Origin3D
Fields originX :: !Word32 originY :: !Word32 originZ :: !Word32

Instances

Instances details

Eq Origin3D
Instance details Defined in WGPU.Internal.Multipurpose Methods (==) :: Origin3D -> Origin3D -> Bool # (/=) :: Origin3D -> Origin3D -> Bool #
Show Origin3D
Instance details Defined in WGPU.Internal.Multipurpose Methods showsPrec :: Int -> Origin3D -> ShowS # show :: Origin3D -> String # showList :: [Origin3D] -> ShowS #
ToRaw Origin3D WGPUOrigin3D
Instance details Defined in WGPU.Internal.Multipurpose Methods raw :: Origin3D -> ContT r IO WGPUOrigin3D #

data TextureAspect #

Kind of data a texture holds.

Constructors

TextureAspectAll
TextureAspectStencilOnly
TextureAspectDepthOnly

Instances

Instances details

Eq TextureAspect
Instance details Defined in WGPU.Internal.Multipurpose Methods (==) :: TextureAspect -> TextureAspect -> Bool # (/=) :: TextureAspect -> TextureAspect -> Bool #
Show TextureAspect
Instance details Defined in WGPU.Internal.Multipurpose Methods showsPrec :: Int -> TextureAspect -> ShowS # show :: TextureAspect -> String # showList :: [TextureAspect] -> ShowS #
ToRaw TextureAspect WGPUTextureAspect
Instance details Defined in WGPU.Internal.Multipurpose Methods raw :: TextureAspect -> ContT r IO WGPUTextureAspect #

data ImageCopyTexture #

View of a texture which can be used to copy tofrom a buffertexture.

Constructors

ImageCopyTexture
Fields texture :: !Texture mipLevel :: !Word32 origin :: !Origin3D aspect :: !TextureAspect

Instances

Instances details

ToRaw ImageCopyTexture WGPUImageCopyTexture
Instance details Defined in WGPU.Internal.Multipurpose Methods raw :: ImageCopyTexture -> ContT r IO WGPUImageCopyTexture #

data TextureDataLayout #

Layout of a texture in a buffer's memory.

Constructors

TextureDataLayout
Fields textureOffset :: !Word64 Offset into the buffer that is the start of the texture. Must be a multiple of texture block size. For non-compressed textures, this is 1. bytesPerRow :: !Word32 Bytes per "row" in an image. rowsPerImage :: !Word32 Rows that make up a single image. Used if there are multiple images.

Instances

Instances details

Eq TextureDataLayout
Instance details Defined in WGPU.Internal.Multipurpose Methods (==) :: TextureDataLayout -> TextureDataLayout -> Bool # (/=) :: TextureDataLayout -> TextureDataLayout -> Bool #
Show TextureDataLayout
Instance details Defined in WGPU.Internal.Multipurpose Methods showsPrec :: Int -> TextureDataLayout -> ShowS # show :: TextureDataLayout -> String # showList :: [TextureDataLayout] -> ShowS #
ToRaw TextureDataLayout WGPUTextureDataLayout
Instance details Defined in WGPU.Internal.Multipurpose Methods raw :: TextureDataLayout -> ContT r IO WGPUTextureDataLayout #

data TextureViewDescriptor #

Describes a TextureView.

Constructors

TextureViewDescriptor
Fields textureViewLabel :: !Text textureViewFormat :: !TextureFormat textureViewDimension :: !TextureViewDimension textureViewBaseMipLevel :: !Word32 textureViewMipLevelCount :: !Word32 baseArrayLayer :: !Word32 arrayLayerCount :: !Word32 textureViewAspect :: !TextureAspect

Instances

Instances details

Eq TextureViewDescriptor
Instance details Defined in WGPU.Internal.Texture Methods (==) :: TextureViewDescriptor -> TextureViewDescriptor -> Bool # (/=) :: TextureViewDescriptor -> TextureViewDescriptor -> Bool #
Show TextureViewDescriptor
Instance details Defined in WGPU.Internal.Texture Methods showsPrec :: Int -> TextureViewDescriptor -> ShowS # show :: TextureViewDescriptor -> String # showList :: [TextureViewDescriptor] -> ShowS #
ToRaw TextureViewDescriptor WGPUTextureViewDescriptor
Instance details Defined in WGPU.Internal.Texture Methods raw :: TextureViewDescriptor -> ContT r IO WGPUTextureViewDescriptor #

createTexture #

Arguments

:: MonadIO m
=> Device	Device for which to create the texture.
-> TextureDescriptor	Description of the texture to create.
-> m Texture	Action to create the texture.

Create a texture.

createView #

Arguments

:: MonadIO m
=> Texture	Texture for which the view should be created.
-> TextureViewDescriptor	Description of the texture view.
-> m TextureView	Created texture view.

Create a view of a texture.

Swapchain

data SwapChain #

Instances

Instances details

Eq SwapChain
Instance details Defined in WGPU.Internal.SwapChain Methods (==) :: SwapChain -> SwapChain -> Bool # (/=) :: SwapChain -> SwapChain -> Bool #
Show SwapChain
Instance details Defined in WGPU.Internal.SwapChain Methods showsPrec :: Int -> SwapChain -> ShowS # show :: SwapChain -> String # showList :: [SwapChain] -> ShowS #
ToRaw SwapChain WGPUSwapChain
Instance details Defined in WGPU.Internal.SwapChain Methods raw :: SwapChain -> ContT r IO WGPUSwapChain #

data SwapChainDescriptor #

Describes a swapchain.

Constructors

SwapChainDescriptor

Fields

swapChainLabel :: !Text
Debugging label for the swap chain.
usage :: !TextureUsage
The usage of the swap chain. The only supported usage is TextureUsageRenderAttachment.
swapChainFormat :: !TextureFormat
Texture format of the swap chain. The only guaranteed formats are TextureFormatBgra8Unorm and TextureFormatBgra8UnormSrgb. To determine the preferred texture format for a surface, use the getSwapChainPreferredFormat function.
swapChainWidth :: !Word32
Width of the swap chain. Must be the same size as the surface.
swapChainHeight :: !Word32
Height of the swap chain. Must be the same size as the surface.
presentMode :: !PresentMode
Presentation mode of the swap chain.

Instances

Instances details

Eq SwapChainDescriptor
Instance details Defined in WGPU.Internal.SwapChain Methods (==) :: SwapChainDescriptor -> SwapChainDescriptor -> Bool # (/=) :: SwapChainDescriptor -> SwapChainDescriptor -> Bool #
Show SwapChainDescriptor
Instance details Defined in WGPU.Internal.SwapChain Methods showsPrec :: Int -> SwapChainDescriptor -> ShowS # show :: SwapChainDescriptor -> String # showList :: [SwapChainDescriptor] -> ShowS #
ToRaw SwapChainDescriptor WGPUSwapChainDescriptor
Instance details Defined in WGPU.Internal.SwapChain Methods raw :: SwapChainDescriptor -> ContT r IO WGPUSwapChainDescriptor #

data PresentMode #

Behaviour of the presentation engine based on frame rate.

Constructors

PresentModeImmediate	The presentation engine does not wait for a vertical blanking period and the request is presented immediately. This is a low-latency presentation mode, but visible tearing may be observed. Will fallback to `Fifo` if unavailable on the selected platform and backend. Not optimal for mobile.
PresentModeMailbox	The presentation engine waits for the next vertical blanking period to update the current image, but frames may be submitted without delay. This is a low-latency presentation mode and visible tearing will not be observed. Will fallback to Fifo if unavailable on the selected platform and backend. Not optimal for mobile.
PresentModeFifo	The presentation engine waits for the next vertical blanking period to update the current image. The framerate will be capped at the display refresh rate, corresponding to the VSync. Tearing cannot be observed. Optimal for mobile.

Instances

Instances details

Eq PresentMode
Instance details Defined in WGPU.Internal.SwapChain Methods (==) :: PresentMode -> PresentMode -> Bool # (/=) :: PresentMode -> PresentMode -> Bool #
Show PresentMode
Instance details Defined in WGPU.Internal.SwapChain Methods showsPrec :: Int -> PresentMode -> ShowS # show :: PresentMode -> String # showList :: [PresentMode] -> ShowS #
ToRaw PresentMode WGPUPresentMode
Instance details Defined in WGPU.Internal.SwapChain Methods raw :: PresentMode -> ContT r IO WGPUPresentMode #

getSwapChainPreferredFormat #

Arguments

:: MonadIO m
=> Surface	`Surface` for which to obtain an optimal texture format.
-> Adapter	`Adapter` for which to obtain an optimal texture format.
-> m TextureFormat	IO action which returns the optimal texture format.

Returns an optimal texture format to use for the swapchain with this adapter and surface.

createSwapChain #

Arguments

:: MonadIO m
=> Device	`Device` for which the `SwapChain` will be created.
-> Surface	`Surface` for which the `SwapChain` will be created.
-> SwapChainDescriptor	Description of the `SwapChain` to be created.
-> m SwapChain	IO action which creates the swap chain.

Createa a new SwapChain which targets a Surface.

To determine the preferred TextureFormat for the Surface, use the getSwapChainPreferredFormat function.

getSwapChainCurrentTextureView #

Arguments

:: MonadIO m
=> SwapChain	Swap chain from which to fetch the current texture view.
-> m TextureView	IO action which returns the current swap chain texture view.

Get the TextureView for the current swap chain frame.

swapChainPresent #

Arguments

:: MonadIO m
=> SwapChain	Swap chain to present.
-> m ()	IO action which presents the swap chain image.

Present the latest swap chain image.

Samplers

data Sampler #

Handle to a Sampler.

A Sampler defines how a pipeline will sample from a TextureView. Samplers define image filters (include anisotropy) and address (wrapping) modes, among other things.

Instances

Instances details

Eq Sampler
Instance details Defined in WGPU.Internal.Sampler Methods (==) :: Sampler -> Sampler -> Bool # (/=) :: Sampler -> Sampler -> Bool #
Show Sampler
Instance details Defined in WGPU.Internal.Sampler Methods showsPrec :: Int -> Sampler -> ShowS # show :: Sampler -> String # showList :: [Sampler] -> ShowS #
ToRaw Sampler WGPUSampler
Instance details Defined in WGPU.Internal.Sampler Methods raw :: Sampler -> ContT r IO WGPUSampler #

data AddressMode #

How edges should be handled in texture addressing.

Constructors

AddressModeClampToEdge
AddressModeRepeat
AddressModeMirrorRepeat

Instances

Instances details

Eq AddressMode
Instance details Defined in WGPU.Internal.Sampler Methods (==) :: AddressMode -> AddressMode -> Bool # (/=) :: AddressMode -> AddressMode -> Bool #
Show AddressMode
Instance details Defined in WGPU.Internal.Sampler Methods showsPrec :: Int -> AddressMode -> ShowS # show :: AddressMode -> String # showList :: [AddressMode] -> ShowS #
ToRaw AddressMode WGPUAddressMode
Instance details Defined in WGPU.Internal.Sampler Methods raw :: AddressMode -> ContT r IO WGPUAddressMode #

data FilterMode #

Texel mixing mode when sampling between texels.

Constructors

FilterModeNearest
FilterModeLinear

Instances

Instances details

Eq FilterMode
Instance details Defined in WGPU.Internal.Sampler Methods (==) :: FilterMode -> FilterMode -> Bool # (/=) :: FilterMode -> FilterMode -> Bool #
Show FilterMode
Instance details Defined in WGPU.Internal.Sampler Methods showsPrec :: Int -> FilterMode -> ShowS # show :: FilterMode -> String # showList :: [FilterMode] -> ShowS #
ToRaw FilterMode WGPUFilterMode
Instance details Defined in WGPU.Internal.Sampler Methods raw :: FilterMode -> ContT r IO WGPUFilterMode #

data SamplerDescriptor #

Describes a Sampler.

Constructors

SamplerDescriptor
Fields samplerLabel :: !Text addressModeU :: !AddressMode addressModeV :: !AddressMode addressModeW :: !AddressMode magFilter :: !FilterMode minFilter :: !FilterMode mipmapFilter :: !FilterMode lodMinClamp :: !Float lodMaxClamp :: !Float samplerCompare :: !CompareFunction maxAnisotropy :: !Word16

Instances

Instances details

Eq SamplerDescriptor
Instance details Defined in WGPU.Internal.Sampler Methods (==) :: SamplerDescriptor -> SamplerDescriptor -> Bool # (/=) :: SamplerDescriptor -> SamplerDescriptor -> Bool #
Show SamplerDescriptor
Instance details Defined in WGPU.Internal.Sampler Methods showsPrec :: Int -> SamplerDescriptor -> ShowS # show :: SamplerDescriptor -> String # showList :: [SamplerDescriptor] -> ShowS #
ToRaw SamplerDescriptor WGPUSamplerDescriptor
Instance details Defined in WGPU.Internal.Sampler Methods raw :: SamplerDescriptor -> ContT r IO WGPUSamplerDescriptor #

createSampler #

Arguments

:: MonadIO m
=> Device	Device for which to create the sampler.
-> SamplerDescriptor	Description of the sampler to create.
-> m Sampler	Action to create the sampler.

Create a Sampler.

Resource Binding

data BindGroup #

Binding group.

Represents the set of resources bound to the bindings described by a BindGroupLayout.

Instances

Instances details

Eq BindGroup
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BindGroup -> BindGroup -> Bool # (/=) :: BindGroup -> BindGroup -> Bool #
Show BindGroup
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BindGroup -> ShowS # show :: BindGroup -> String # showList :: [BindGroup] -> ShowS #
ToRaw BindGroup WGPUBindGroup
Instance details Defined in WGPU.Internal.Binding Methods raw :: BindGroup -> ContT r IO WGPUBindGroup #

data BindGroupLayout #

Handle to a binding group layout.

A BindGroupLayout is a handle to the GPU-side layout of a binding group.

Instances

Instances details

Eq BindGroupLayout
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BindGroupLayout -> BindGroupLayout -> Bool # (/=) :: BindGroupLayout -> BindGroupLayout -> Bool #
Show BindGroupLayout
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BindGroupLayout -> ShowS # show :: BindGroupLayout -> String # showList :: [BindGroupLayout] -> ShowS #
ToRaw BindGroupLayout WGPUBindGroupLayout
Instance details Defined in WGPU.Internal.Binding Methods raw :: BindGroupLayout -> ContT r IO WGPUBindGroupLayout #

data BindGroupDescriptor #

Describes a BindGroup.

Constructors

BindGroupDescriptor
Fields bindGroupLabel :: !Text bindGroupLayout :: !BindGroupLayout bindGroupEntries :: !(Vector BindGroupEntry)

Instances

Instances details

Eq BindGroupDescriptor
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BindGroupDescriptor -> BindGroupDescriptor -> Bool # (/=) :: BindGroupDescriptor -> BindGroupDescriptor -> Bool #
Show BindGroupDescriptor
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BindGroupDescriptor -> ShowS # show :: BindGroupDescriptor -> String # showList :: [BindGroupDescriptor] -> ShowS #
ToRaw BindGroupDescriptor WGPUBindGroupDescriptor
Instance details Defined in WGPU.Internal.Binding Methods raw :: BindGroupDescriptor -> ContT r IO WGPUBindGroupDescriptor #

data BindGroupEntry #

Entry in a bind group.

Constructors

BindGroupEntry
Fields binding :: !Binding resource :: !BindingResource

Instances

Instances details

Eq BindGroupEntry
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BindGroupEntry -> BindGroupEntry -> Bool # (/=) :: BindGroupEntry -> BindGroupEntry -> Bool #
Show BindGroupEntry
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BindGroupEntry -> ShowS # show :: BindGroupEntry -> String # showList :: [BindGroupEntry] -> ShowS #
ToRaw BindGroupEntry WGPUBindGroupEntry
Instance details Defined in WGPU.Internal.Binding Methods raw :: BindGroupEntry -> ContT r IO WGPUBindGroupEntry #

data BindGroupLayoutDescriptor #

Describes a BindGroupLayout.

Constructors

BindGroupLayoutDescriptor
Fields bindGroupLayoutLabel :: !Text Debug label of the bind group layout. layoutEntries :: !(Vector BindGroupLayoutEntry) Sequence of entries in this bind group layout.

Instances

Instances details

Eq BindGroupLayoutDescriptor
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BindGroupLayoutDescriptor -> BindGroupLayoutDescriptor -> Bool # (/=) :: BindGroupLayoutDescriptor -> BindGroupLayoutDescriptor -> Bool #
Show BindGroupLayoutDescriptor
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BindGroupLayoutDescriptor -> ShowS # show :: BindGroupLayoutDescriptor -> String # showList :: [BindGroupLayoutDescriptor] -> ShowS #
ToRaw BindGroupLayoutDescriptor WGPUBindGroupLayoutDescriptor
Instance details Defined in WGPU.Internal.Binding Methods raw :: BindGroupLayoutDescriptor -> ContT r IO WGPUBindGroupLayoutDescriptor #

data BindGroupLayoutEntry #

Describes a single binding inside a bind group.

Constructors

BindGroupLayoutEntry
Fields layoutBinding :: !Binding Binding index. Must match a shader index, and be unique inside a bind group layout. visibility :: !ShaderStage Which shader stages can see this binding. bindGroupLayoutEntryType :: !BindingType Type of the binding.

Instances

Instances details

Eq BindGroupLayoutEntry
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BindGroupLayoutEntry -> BindGroupLayoutEntry -> Bool # (/=) :: BindGroupLayoutEntry -> BindGroupLayoutEntry -> Bool #
Show BindGroupLayoutEntry
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BindGroupLayoutEntry -> ShowS # show :: BindGroupLayoutEntry -> String # showList :: [BindGroupLayoutEntry] -> ShowS #
ToRaw BindGroupLayoutEntry WGPUBindGroupLayoutEntry
Instance details Defined in WGPU.Internal.Binding Methods raw :: BindGroupLayoutEntry -> ContT r IO WGPUBindGroupLayoutEntry #

newtype Binding #

Binding index.

This must match a shader index, and be unique inside a binding group layout.

Constructors

Binding
Fields unBinding :: Word32

Instances

Instances details

Eq Binding
Instance details Defined in WGPU.Internal.Binding Methods (==) :: Binding -> Binding -> Bool # (/=) :: Binding -> Binding -> Bool #
Num Binding
Instance details Defined in WGPU.Internal.Binding Methods (+) :: Binding -> Binding -> Binding # (-) :: Binding -> Binding -> Binding # (*) :: Binding -> Binding -> Binding # negate :: Binding -> Binding # abs :: Binding -> Binding # signum :: Binding -> Binding # fromInteger :: Integer -> Binding #
Show Binding
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> Binding -> ShowS # show :: Binding -> String # showList :: [Binding] -> ShowS #
ToRaw Binding Word32
Instance details Defined in WGPU.Internal.Binding Methods raw :: Binding -> ContT r IO Word32 #

data ShaderStage #

Describes the shader stages from which a binding will be visible.

Constructors

ShaderStage
Fields stageVertex :: !Bool Binding is visible from the vertex shader of a render pipeline. stageFragment :: !Bool Binding is visible from the fragment shader of a render pipeline. stageCompute :: !Bool Binding is visible from the compute shader of a compute pipeline.

Instances

Instances details

Eq ShaderStage
Instance details Defined in WGPU.Internal.Binding Methods (==) :: ShaderStage -> ShaderStage -> Bool # (/=) :: ShaderStage -> ShaderStage -> Bool #
Show ShaderStage
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> ShaderStage -> ShowS # show :: ShaderStage -> String # showList :: [ShaderStage] -> ShowS #
Default ShaderStage
Instance details Defined in WGPU.Internal.Binding Methods def :: ShaderStage #
ToRaw ShaderStage WGPUShaderStageFlags
Instance details Defined in WGPU.Internal.Binding Methods raw :: ShaderStage -> ContT r IO WGPUShaderStageFlags #

data BindingType #

Specifies type of a binding.

Constructors

BindingTypeBuffer !BufferBindingLayout	A buffer binding.
BindingTypeSampler !SamplerBindingLayout	A sampler that can be used to sample a texture.
BindingTypeTexture !TextureBindingLayout	A texture binding.
BindingTypeStorageTexture !StorageTextureBindingLayout	A storage texture.

Instances

Instances details

Eq BindingType
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BindingType -> BindingType -> Bool # (/=) :: BindingType -> BindingType -> Bool #
Show BindingType
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BindingType -> ShowS # show :: BindingType -> String # showList :: [BindingType] -> ShowS #

data BufferBindingLayout #

A buffer binding.

Constructors

BufferBindingLayout
Fields bindingBufferLayoutType :: !BufferBindingType Sub-type of the buffer binding. hasDynamicOffset :: !Bool Indicates that the binding has a dynamic offset. One offset must be passed when setting the bind group in the render pass. minBindingSize :: !(SMaybe Word64) Minimum size of a corresponding buffer binding required to match this entry.

Instances

Instances details

Eq BufferBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BufferBindingLayout -> BufferBindingLayout -> Bool # (/=) :: BufferBindingLayout -> BufferBindingLayout -> Bool #
Show BufferBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BufferBindingLayout -> ShowS # show :: BufferBindingLayout -> String # showList :: [BufferBindingLayout] -> ShowS #
ToRaw BufferBindingLayout WGPUBufferBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods raw :: BufferBindingLayout -> ContT r IO WGPUBufferBindingLayout #

data SamplerBindingLayout #

A sampler binding that can be used to sample a texture.

Constructors

SamplerBindingLayoutFiltering
SamplerBindingLayoutNonFiltering
SamplerBindingLayoutComparison

Instances

Instances details

Eq SamplerBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods (==) :: SamplerBindingLayout -> SamplerBindingLayout -> Bool # (/=) :: SamplerBindingLayout -> SamplerBindingLayout -> Bool #
Show SamplerBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> SamplerBindingLayout -> ShowS # show :: SamplerBindingLayout -> String # showList :: [SamplerBindingLayout] -> ShowS #
ToRaw SamplerBindingLayout WGPUSamplerBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods raw :: SamplerBindingLayout -> ContT r IO WGPUSamplerBindingLayout #

data TextureBindingLayout #

A texture binding.

Constructors

TextureBindingLayout
Fields sampleType :: !TextureSampleType Sample type of the texture binding. textureBindingViewDimension :: !TextureViewDimension Dimension of the texture view that is going to be sampled. multiSampled :: !Bool True if the texture has a sample count greater than 1.

Instances

Instances details

Eq TextureBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods (==) :: TextureBindingLayout -> TextureBindingLayout -> Bool # (/=) :: TextureBindingLayout -> TextureBindingLayout -> Bool #
Show TextureBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> TextureBindingLayout -> ShowS # show :: TextureBindingLayout -> String # showList :: [TextureBindingLayout] -> ShowS #
ToRaw TextureBindingLayout WGPUTextureBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods raw :: TextureBindingLayout -> ContT r IO WGPUTextureBindingLayout #

data StorageTextureBindingLayout #

A storage texture binding.

Constructors

StorageTextureBindingLayout
Fields access :: !StorageTextureAccess Permitted access to this texture. storageTextureFormat :: !TextureFormat Format of the texture. storageTextureViewDimension :: !TextureViewDimension Dimension of the texture view that is going to be sampled.

Instances

Instances details

Eq StorageTextureBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods (==) :: StorageTextureBindingLayout -> StorageTextureBindingLayout -> Bool # (/=) :: StorageTextureBindingLayout -> StorageTextureBindingLayout -> Bool #
Show StorageTextureBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> StorageTextureBindingLayout -> ShowS # show :: StorageTextureBindingLayout -> String # showList :: [StorageTextureBindingLayout] -> ShowS #
ToRaw StorageTextureBindingLayout WGPUStorageTextureBindingLayout
Instance details Defined in WGPU.Internal.Binding Methods raw :: StorageTextureBindingLayout -> ContT r IO WGPUStorageTextureBindingLayout #

data StorageTextureAccess #

Specific method of allowed access to a storage texture.

Constructors

StorageTextureAccessReadOnly
StorageTextureAccessWriteOnly
StorageTextureAccessReadWrite

Instances

Instances details

Eq StorageTextureAccess
Instance details Defined in WGPU.Internal.Binding Methods (==) :: StorageTextureAccess -> StorageTextureAccess -> Bool # (/=) :: StorageTextureAccess -> StorageTextureAccess -> Bool #
Show StorageTextureAccess
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> StorageTextureAccess -> ShowS # show :: StorageTextureAccess -> String # showList :: [StorageTextureAccess] -> ShowS #
ToRaw StorageTextureAccess WGPUStorageTextureAccess
Instance details Defined in WGPU.Internal.Binding Methods raw :: StorageTextureAccess -> ContT r IO WGPUStorageTextureAccess #

data TextureSampleType #

Specific type of a sample in a texture binding.

Constructors

TextureSampleTypeFloat
Fields filterable :: !Bool
TextureSampleTypeDepth
TextureSampleTypeSignedInt
TextureSampleTypeUnsignedInt

Instances

Instances details

Eq TextureSampleType
Instance details Defined in WGPU.Internal.Binding Methods (==) :: TextureSampleType -> TextureSampleType -> Bool # (/=) :: TextureSampleType -> TextureSampleType -> Bool #
Show TextureSampleType
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> TextureSampleType -> ShowS # show :: TextureSampleType -> String # showList :: [TextureSampleType] -> ShowS #
ToRaw TextureSampleType WGPUTextureSampleType
Instance details Defined in WGPU.Internal.Binding Methods raw :: TextureSampleType -> ContT r IO WGPUTextureSampleType #

data BufferBindingType #

Specific type of a buffer binding.

Constructors

Uniform
Storage
Fields readOnly :: !Bool

Instances

Instances details

Eq BufferBindingType
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BufferBindingType -> BufferBindingType -> Bool # (/=) :: BufferBindingType -> BufferBindingType -> Bool #
Show BufferBindingType
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BufferBindingType -> ShowS # show :: BufferBindingType -> String # showList :: [BufferBindingType] -> ShowS #
ToRaw BufferBindingType WGPUBufferBindingType
Instance details Defined in WGPU.Internal.Binding Methods raw :: BufferBindingType -> ContT r IO WGPUBufferBindingType #

data BindingResource #

Resource that can be bound to a pipeline.

Constructors

BindingResourceBuffer !BufferBinding
BindingResourceSampler !Sampler
BindingResourceTextureView !TextureView

Instances

Instances details

Eq BindingResource
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BindingResource -> BindingResource -> Bool # (/=) :: BindingResource -> BindingResource -> Bool #
Show BindingResource
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BindingResource -> ShowS # show :: BindingResource -> String # showList :: [BindingResource] -> ShowS #

data BufferBinding #

A buffer binding.

Constructors

BufferBinding
Fields bindingBuffer :: !Buffer bindingBufferOffset :: !Word64 bindingBufferSize :: !Word64

Instances

Instances details

Eq BufferBinding
Instance details Defined in WGPU.Internal.Binding Methods (==) :: BufferBinding -> BufferBinding -> Bool # (/=) :: BufferBinding -> BufferBinding -> Bool #
Show BufferBinding
Instance details Defined in WGPU.Internal.Binding Methods showsPrec :: Int -> BufferBinding -> ShowS # show :: BufferBinding -> String # showList :: [BufferBinding] -> ShowS #

createBindGroup #

Arguments

:: MonadIO m
=> Device	Device for which to create the bind group.
-> BindGroupDescriptor	Description of the bind group.
-> m BindGroup	Action to create the bind group.

Create a bind group.

createBindGroupLayout #

Arguments

:: MonadIO m
=> Device	The device for which the bind group layout will be created.
-> BindGroupLayoutDescriptor	Description of the bind group layout.
-> m BindGroupLayout	MonadIO action that creates a bind group layout.

Creates a BindGroupLayout.

Shader Modules

data ShaderModule #

Handle to a compiled shader module.

Instances

Instances details

Eq ShaderModule
Instance details Defined in WGPU.Internal.Shader Methods (==) :: ShaderModule -> ShaderModule -> Bool # (/=) :: ShaderModule -> ShaderModule -> Bool #
Show ShaderModule
Instance details Defined in WGPU.Internal.Shader Methods showsPrec :: Int -> ShaderModule -> ShowS # show :: ShaderModule -> String # showList :: [ShaderModule] -> ShowS #
ToRaw ShaderModule WGPUShaderModule
Instance details Defined in WGPU.Internal.Shader Methods raw :: ShaderModule -> ContT r IO WGPUShaderModule #

data ShaderModuleDescriptor #

Descriptor for a shader module.

Constructors

ShaderModuleDescriptor
Fields shaderLabel :: !Text Debug label of the shader module. source :: !ShaderSource Source code for the shader.

Instances

Instances details

Eq ShaderModuleDescriptor
Instance details Defined in WGPU.Internal.Shader Methods (==) :: ShaderModuleDescriptor -> ShaderModuleDescriptor -> Bool # (/=) :: ShaderModuleDescriptor -> ShaderModuleDescriptor -> Bool #
Show ShaderModuleDescriptor
Instance details Defined in WGPU.Internal.Shader Methods showsPrec :: Int -> ShaderModuleDescriptor -> ShowS # show :: ShaderModuleDescriptor -> String # showList :: [ShaderModuleDescriptor] -> ShowS #
ToRaw ShaderModuleDescriptor WGPUShaderModuleDescriptor
Instance details Defined in WGPU.Internal.Shader Methods raw :: ShaderModuleDescriptor -> ContT r IO WGPUShaderModuleDescriptor #

data ShaderSource #

Source for a shader module.

Constructors

ShaderSourceSPIRV !SPIRV	Use shader source from a SPIRV module (pre-compiled).
ShaderSourceWGSL !WGSL	Use shader source from WGSL string.

Instances

Instances details

Eq ShaderSource
Instance details Defined in WGPU.Internal.Shader Methods (==) :: ShaderSource -> ShaderSource -> Bool # (/=) :: ShaderSource -> ShaderSource -> Bool #
Show ShaderSource
Instance details Defined in WGPU.Internal.Shader Methods showsPrec :: Int -> ShaderSource -> ShowS # show :: ShaderSource -> String # showList :: [ShaderSource] -> ShowS #

newtype SPIRV #

Pre-compiled SPIRV module bytes.

Constructors

SPIRV ByteString

Instances

Instances details

Eq SPIRV
Instance details Defined in WGPU.Internal.Shader Methods (==) :: SPIRV -> SPIRV -> Bool # (/=) :: SPIRV -> SPIRV -> Bool #
Show SPIRV
Instance details Defined in WGPU.Internal.Shader Methods showsPrec :: Int -> SPIRV -> ShowS # show :: SPIRV -> String # showList :: [SPIRV] -> ShowS #
ToRaw SPIRV WGPUShaderModuleSPIRVDescriptor
Instance details Defined in WGPU.Internal.Shader Methods raw :: SPIRV -> ContT r IO WGPUShaderModuleSPIRVDescriptor #

newtype WGSL #

WGSL shader source code.

Constructors

WGSL Text

Instances

Instances details

Eq WGSL
Instance details Defined in WGPU.Internal.Shader Methods (==) :: WGSL -> WGSL -> Bool # (/=) :: WGSL -> WGSL -> Bool #
Show WGSL
Instance details Defined in WGPU.Internal.Shader Methods showsPrec :: Int -> WGSL -> ShowS # show :: WGSL -> String # showList :: [WGSL] -> ShowS #
ToRaw WGSL WGPUShaderModuleWGSLDescriptor
Instance details Defined in WGPU.Internal.Shader Methods raw :: WGSL -> ContT r IO WGPUShaderModuleWGSLDescriptor #

newtype ShaderEntryPoint #

Name of a shader entry point.

Constructors

ShaderEntryPoint
Fields unShaderEntryPoint :: Text

Instances

Instances details

Eq ShaderEntryPoint
Instance details Defined in WGPU.Internal.Shader Methods (==) :: ShaderEntryPoint -> ShaderEntryPoint -> Bool # (/=) :: ShaderEntryPoint -> ShaderEntryPoint -> Bool #
Show ShaderEntryPoint
Instance details Defined in WGPU.Internal.Shader Methods showsPrec :: Int -> ShaderEntryPoint -> ShowS # show :: ShaderEntryPoint -> String # showList :: [ShaderEntryPoint] -> ShowS #
IsString ShaderEntryPoint
Instance details Defined in WGPU.Internal.Shader Methods fromString :: String -> ShaderEntryPoint #
ToRawPtr ShaderEntryPoint CChar
Instance details Defined in WGPU.Internal.Shader Methods rawPtr :: ShaderEntryPoint -> ContT r IO (Ptr CChar) #

createShaderModule #

Arguments

:: MonadIO m
=> Device	Device for the shader.
-> ShaderModuleDescriptor	Descriptor of the shader module.
-> m ShaderModule	IO action producing the shader module.

Create a shader module from either SPIR-V or WGSL source code.

createShaderModuleSPIRV #

Arguments

:: MonadIO m
=> Device	Device for which the shader should be created.
-> Text	Debugging label for the shader.
-> SPIRV	Shader source code (SPIR-V bytestring).
-> m ShaderModule	IO action creating the shader module.

Create a shader module from SPIR-V source code.

createShaderModuleWGSL #

Arguments

:: MonadIO m
=> Device	Device for which the shader should be created.
-> Text	Debugging label for the shader.
-> WGSL	Shader source code (WGSL source string).
-> m ShaderModule	IO action creating the shader module.

Create a shader module from WGSL source code.

Pipelines

Compute

Render

data PipelineLayout #

Instances

Instances details

Eq PipelineLayout
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: PipelineLayout -> PipelineLayout -> Bool # (/=) :: PipelineLayout -> PipelineLayout -> Bool #
Show PipelineLayout
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> PipelineLayout -> ShowS # show :: PipelineLayout -> String # showList :: [PipelineLayout] -> ShowS #
ToRaw PipelineLayout WGPUPipelineLayout
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: PipelineLayout -> ContT r IO WGPUPipelineLayout #

data RenderPipeline #

Instances

Instances details

Eq RenderPipeline
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: RenderPipeline -> RenderPipeline -> Bool # (/=) :: RenderPipeline -> RenderPipeline -> Bool #
Show RenderPipeline
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> RenderPipeline -> ShowS # show :: RenderPipeline -> String # showList :: [RenderPipeline] -> ShowS #
ToRaw RenderPipeline WGPURenderPipeline
Instance details Defined in WGPU.Internal.RenderPass Methods raw :: RenderPipeline -> ContT r IO WGPURenderPipeline #

data PipelineLayoutDescriptor #

Describes a pipeline layout.

Constructors

PipelineLayoutDescriptor
Fields pipelineLabel :: !Text Debug label of the pipeline layout. bindGroupLayouts :: !(Vector BindGroupLayout) Bind groups that this pipeline uses.

Instances

Instances details

Eq PipelineLayoutDescriptor
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: PipelineLayoutDescriptor -> PipelineLayoutDescriptor -> Bool # (/=) :: PipelineLayoutDescriptor -> PipelineLayoutDescriptor -> Bool #
Show PipelineLayoutDescriptor
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> PipelineLayoutDescriptor -> ShowS # show :: PipelineLayoutDescriptor -> String # showList :: [PipelineLayoutDescriptor] -> ShowS #
ToRaw PipelineLayoutDescriptor WGPUPipelineLayoutDescriptor
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: PipelineLayoutDescriptor -> ContT r IO WGPUPipelineLayoutDescriptor #

data RenderPipelineDescriptor #

Describes a render (graphics) pipeline.

Constructors

RenderPipelineDescriptor
Fields renderPipelineLabel :: !Text Debug label of the pipeline. layout :: !(SMaybe PipelineLayout) The layout of bind groups for this pipeline. vertex :: !VertexState Vertex state. primitive :: !PrimitiveState Primitive state. depthStencil :: !(SMaybe DepthStencilState) Depth stencil state. multisample :: !MultisampleState Multisample state. fragment :: !(SMaybe FragmentState) Fragment state.

Instances

Instances details

Eq RenderPipelineDescriptor
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: RenderPipelineDescriptor -> RenderPipelineDescriptor -> Bool # (/=) :: RenderPipelineDescriptor -> RenderPipelineDescriptor -> Bool #
Show RenderPipelineDescriptor
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> RenderPipelineDescriptor -> ShowS # show :: RenderPipelineDescriptor -> String # showList :: [RenderPipelineDescriptor] -> ShowS #
ToRaw RenderPipelineDescriptor WGPURenderPipelineDescriptor
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: RenderPipelineDescriptor -> ContT r IO WGPURenderPipelineDescriptor #

data VertexFormat #

Vertex format for a vertex attribute.

Instances

Instances details

Eq VertexFormat
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: VertexFormat -> VertexFormat -> Bool # (/=) :: VertexFormat -> VertexFormat -> Bool #
Show VertexFormat
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> VertexFormat -> ShowS # show :: VertexFormat -> String # showList :: [VertexFormat] -> ShowS #
ToRaw VertexFormat WGPUVertexFormat	Convert a `VertexFormat` to its raw representation.
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: VertexFormat -> ContT r IO WGPUVertexFormat #

data VertexAttribute #

Vertex inputs (attributes) to shaders.

Constructors

VertexAttribute
Fields vertexFormat :: !VertexFormat Format of the input. vertexOffset :: !Word64 Byte offset of the start of the input. shaderLocation :: !Word32 Location for this input. Must match the location in the shader.

Instances

Instances details

Eq VertexAttribute
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: VertexAttribute -> VertexAttribute -> Bool # (/=) :: VertexAttribute -> VertexAttribute -> Bool #
Show VertexAttribute
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> VertexAttribute -> ShowS # show :: VertexAttribute -> String # showList :: [VertexAttribute] -> ShowS #
ToRaw VertexAttribute WGPUVertexAttribute
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: VertexAttribute -> ContT r IO WGPUVertexAttribute #

data InputStepMode #

Determines when vertex data is advanced.

Constructors

InputStepModeVertex	Input data is advanced every vertex.
InputStepModeInstance	Input data is advanced every instance.

Instances

Instances details

Eq InputStepMode
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: InputStepMode -> InputStepMode -> Bool # (/=) :: InputStepMode -> InputStepMode -> Bool #
Show InputStepMode
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> InputStepMode -> ShowS # show :: InputStepMode -> String # showList :: [InputStepMode] -> ShowS #
ToRaw InputStepMode WGPUInputStepMode	Convert an `InputStepMode` to its raw value.
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: InputStepMode -> ContT r IO WGPUInputStepMode #

data VertexBufferLayout #

Describes how a vertex buffer is interpreted.

Constructors

VertexBufferLayout
Fields arrayStride :: !Word64 The stride, in bytes, between elements of the buffer. stepMode :: !InputStepMode How often the vertex buffer is stepped forward (per vertex or per instance). attributes :: !(Vector VertexAttribute) List of attributes that comprise a single vertex.

Instances

Instances details

Eq VertexBufferLayout
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: VertexBufferLayout -> VertexBufferLayout -> Bool # (/=) :: VertexBufferLayout -> VertexBufferLayout -> Bool #
Show VertexBufferLayout
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> VertexBufferLayout -> ShowS # show :: VertexBufferLayout -> String # showList :: [VertexBufferLayout] -> ShowS #
ToRaw VertexBufferLayout WGPUVertexBufferLayout
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: VertexBufferLayout -> ContT r IO WGPUVertexBufferLayout #

data VertexState #

Describes the vertex process in a render pipeline.

Constructors

VertexState
Fields vertexShaderModule :: !ShaderModule The compiled shader module for this stage. vertexEntryPoint :: !ShaderEntryPoint The name of the entry point in the compiled shader. There must be a function that returns `void` with this name in the shader. buffers :: !(Vector VertexBufferLayout) The format of any vertex buffers used with this pipeline.

Instances

Instances details

Eq VertexState
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: VertexState -> VertexState -> Bool # (/=) :: VertexState -> VertexState -> Bool #
Show VertexState
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> VertexState -> ShowS # show :: VertexState -> String # showList :: [VertexState] -> ShowS #
ToRaw VertexState WGPUVertexState
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: VertexState -> ContT r IO WGPUVertexState #

data PrimitiveTopology #

Primitive type out of which an input mesh is composed.

Constructors

PrimitiveTopologyPointList
PrimitiveTopologyLineList
PrimitiveTopologyLineStrip
PrimitiveTopologyTriangleList
PrimitiveTopologyTriangleStrip

Instances

Instances details

Eq PrimitiveTopology
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: PrimitiveTopology -> PrimitiveTopology -> Bool # (/=) :: PrimitiveTopology -> PrimitiveTopology -> Bool #
Show PrimitiveTopology
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> PrimitiveTopology -> ShowS # show :: PrimitiveTopology -> String # showList :: [PrimitiveTopology] -> ShowS #
Default PrimitiveTopology
Instance details Defined in WGPU.Internal.Pipeline Methods def :: PrimitiveTopology #
ToRaw PrimitiveTopology WGPUPrimitiveTopology	Convert a `PrimitiveTopology` to its raw value.
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: PrimitiveTopology -> ContT r IO WGPUPrimitiveTopology #

data IndexFormat #

Format of indices used within a pipeline.

Constructors

IndexFormatUint16	Indices are 16-bit unsigned integers (`Word16`)
IndexFormatUint32	Indices are 32-bit unsigned integers (`Word32`)

Instances

Instances details

Eq IndexFormat
Instance details Defined in WGPU.Internal.Multipurpose Methods (==) :: IndexFormat -> IndexFormat -> Bool # (/=) :: IndexFormat -> IndexFormat -> Bool #
Show IndexFormat
Instance details Defined in WGPU.Internal.Multipurpose Methods showsPrec :: Int -> IndexFormat -> ShowS # show :: IndexFormat -> String # showList :: [IndexFormat] -> ShowS #
ToRaw IndexFormat WGPUIndexFormat	Convert an `IndexFormat` to its raw value.
Instance details Defined in WGPU.Internal.Multipurpose Methods raw :: IndexFormat -> ContT r IO WGPUIndexFormat #

data FrontFace #

Winding order which classifies the "front" face.

Constructors

FrontFaceCCW	Triangles with counter-clockwise vertices are the front face.
FrontFaceCW	Triangles with clockwise vertices are the front face.

Instances

Instances details

Eq FrontFace
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: FrontFace -> FrontFace -> Bool # (/=) :: FrontFace -> FrontFace -> Bool #
Show FrontFace
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> FrontFace -> ShowS # show :: FrontFace -> String # showList :: [FrontFace] -> ShowS #
Default FrontFace
Instance details Defined in WGPU.Internal.Pipeline Methods def :: FrontFace #
ToRaw FrontFace WGPUFrontFace	Convert a `FrontFace` to its raw value.
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: FrontFace -> ContT r IO WGPUFrontFace #

data CullMode #

Whether to cull the face of a vertex.

Constructors

CullModeFront	Cull the front face.
CullModeBack	Cull the back face.
CullModeNone	Do not cull either face.

Instances

Instances details

Eq CullMode
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: CullMode -> CullMode -> Bool # (/=) :: CullMode -> CullMode -> Bool #
Show CullMode
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> CullMode -> ShowS # show :: CullMode -> String # showList :: [CullMode] -> ShowS #
Default CullMode
Instance details Defined in WGPU.Internal.Pipeline Methods def :: CullMode #
ToRaw CullMode WGPUCullMode	Convert a `CullMode` to its raw value.
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: CullMode -> ContT r IO WGPUCullMode #

data PrimitiveState #

Describes the state of primitive assembly and rasterization in a render pipeline.

Differences between this and the Rust API: - no clamp_depth member - no polygon_mode member - no conservative member

Constructors

PrimitiveState

Fields

topology :: !PrimitiveTopology
The primitive topology used to interpret vertices.
stripIndexFormat :: !(SMaybe IndexFormat)
When drawing strip topologies with indices, this is the required format for the index buffer. This has no effect for non-indexed or non-strip draws.
frontFace :: !FrontFace
The face to consider the front for the purpose of culling and stencil operations.
cullMode :: !CullMode
The face culling mode.

Instances

Instances details

Eq PrimitiveState
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: PrimitiveState -> PrimitiveState -> Bool # (/=) :: PrimitiveState -> PrimitiveState -> Bool #
Show PrimitiveState
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> PrimitiveState -> ShowS # show :: PrimitiveState -> String # showList :: [PrimitiveState] -> ShowS #
Default PrimitiveState
Instance details Defined in WGPU.Internal.Pipeline Methods def :: PrimitiveState #
ToRaw PrimitiveState WGPUPrimitiveState
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: PrimitiveState -> ContT r IO WGPUPrimitiveState #

data StencilOperation #

Operation to perform on a stencil value.

Constructors

StencilOperationKeep
StencilOperationZero
StencilOperationReplace
StencilOperationInvert
StencilOperationIncrementClamp
StencilOperationDecrementClamp
StencilOperationIncrementWrap
StencilOperationDecrementWrap

Instances

Instances details

Eq StencilOperation
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: StencilOperation -> StencilOperation -> Bool # (/=) :: StencilOperation -> StencilOperation -> Bool #
Show StencilOperation
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> StencilOperation -> ShowS # show :: StencilOperation -> String # showList :: [StencilOperation] -> ShowS #
ToRaw StencilOperation WGPUStencilOperation	Convert a `StencilOperation` to its raw value.
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: StencilOperation -> ContT r IO WGPUStencilOperation #

data StencilState #

State of the stencil operation (fixed pipeline stage).

Constructors

StencilState
Fields front :: !StencilFaceState Front face mode. back :: !StencilFaceState Back face mode. readMask :: !Word8 Stencil values are AND-ed with this mask when reading and writing from the stencil buffer. writeMask :: !Word8 Stencil values are AND-ed with this mask when writing to the stencil buffer.

Instances

Instances details

Eq StencilState
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: StencilState -> StencilState -> Bool # (/=) :: StencilState -> StencilState -> Bool #
Show StencilState
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> StencilState -> ShowS # show :: StencilState -> String # showList :: [StencilState] -> ShowS #

data DepthBiasState #

Describes the biasing setting for the depth target.

Constructors

DepthBiasState
Fields constant :: !Int32 slopeScale :: !Float Slope depth biasing factor. clamp :: !Float Depth bias clamp value (absolute).

Instances

Instances details

Eq DepthBiasState
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: DepthBiasState -> DepthBiasState -> Bool # (/=) :: DepthBiasState -> DepthBiasState -> Bool #
Show DepthBiasState
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> DepthBiasState -> ShowS # show :: DepthBiasState -> String # showList :: [DepthBiasState] -> ShowS #

data DepthStencilState #

Describes the depth / stencil state of a render pipeline.

Constructors

DepthStencilState

Fields

depthStencilTextureFormat :: !TextureFormat
Format of the depth/stencil buffer. This must be a special depth format, and must match the format of the depth/stencil attachment in the command encoder.
depthWriteEnabled :: !Bool
If disabled, depth will not be written to.
depthCompare :: !CompareFunction
Comparison function used to compare depth values in the depth test.
stencil :: !StencilState
Stencil state.
bias :: !DepthBiasState
Depth bias state.

Instances

Instances details

Eq DepthStencilState
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: DepthStencilState -> DepthStencilState -> Bool # (/=) :: DepthStencilState -> DepthStencilState -> Bool #
Show DepthStencilState
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> DepthStencilState -> ShowS # show :: DepthStencilState -> String # showList :: [DepthStencilState] -> ShowS #
ToRaw DepthStencilState WGPUDepthStencilState
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: DepthStencilState -> ContT r IO WGPUDepthStencilState #

data MultisampleState #

Describes the multi-sampling state of a render pipeline.

Constructors

MultisampleState

Fields

count :: Word32
Number of samples calculated per pixel (for MSAA). For non-multisampled textures, this should be 1.
mask :: Word32
Bitmask that restricts the samples of a pixel modified by this pipeline. All samples can be enabled by using 0XFFFFFFFF (ie. zero complement).
alphaToCoverageEnabled :: Bool
When enabled, produces another sample mask per pixel based on the alpha output value, and that is AND-ed with the sample mask and the primitive coverage to restrict the set of samples affected by a primitive.

Instances

Instances details

Eq MultisampleState
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: MultisampleState -> MultisampleState -> Bool # (/=) :: MultisampleState -> MultisampleState -> Bool #
Show MultisampleState
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> MultisampleState -> ShowS # show :: MultisampleState -> String # showList :: [MultisampleState] -> ShowS #
ToRaw MultisampleState WGPUMultisampleState
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: MultisampleState -> ContT r IO WGPUMultisampleState #

data BlendFactor #

Alpha blend factor.

Constructors

BlendFactorZero
BlendFactorOne
BlendFactorSrc
BlendFactorOneMinusSrc
BlendFactorSrcAlpha
BlendFactorOneMinusSrcAlpha
BlendFactorDst
BlendFactorOneMinusDst
BlendFactorDstAlpha
BlendFactorOneMinusDstAlpha
BlendFactorSrcAlphaSaturated
BlendFactorConstant
BlendFactorOneMinusConstant

Instances

Instances details

Eq BlendFactor
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: BlendFactor -> BlendFactor -> Bool # (/=) :: BlendFactor -> BlendFactor -> Bool #
Show BlendFactor
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> BlendFactor -> ShowS # show :: BlendFactor -> String # showList :: [BlendFactor] -> ShowS #
ToRaw BlendFactor WGPUBlendFactor	Convert a `BlendFactor` to its raw value.
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: BlendFactor -> ContT r IO WGPUBlendFactor #

data BlendOperation #

Alpha blending operation.

Constructors

BlendOperationAdd
BlendOperationSubtract
BlendOperationReverseSubtract
BlendOperationMin
BlendOperationMax

Instances

Instances details

Eq BlendOperation
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: BlendOperation -> BlendOperation -> Bool # (/=) :: BlendOperation -> BlendOperation -> Bool #
Show BlendOperation
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> BlendOperation -> ShowS # show :: BlendOperation -> String # showList :: [BlendOperation] -> ShowS #
ToRaw BlendOperation WGPUBlendOperation	Convert a `BlendOperation` to its raw value.
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: BlendOperation -> ContT r IO WGPUBlendOperation #

data BlendComponent #

Describes the blend component of a pipeline.

Constructors

BlendComponent
Fields srcFactor :: !BlendFactor Multiplier for the source, which is produced by the fragment shader. dstFactor :: !BlendFactor Multiplier for the destination, which is stored in the target. operation :: !BlendOperation Binary operation applied to the source and destination, multiplied by their respective factors.

Instances

Instances details

Eq BlendComponent
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: BlendComponent -> BlendComponent -> Bool # (/=) :: BlendComponent -> BlendComponent -> Bool #
Show BlendComponent
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> BlendComponent -> ShowS # show :: BlendComponent -> String # showList :: [BlendComponent] -> ShowS #
Default BlendComponent
Instance details Defined in WGPU.Internal.Pipeline Methods def :: BlendComponent #
ToRaw BlendComponent WGPUBlendComponent
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: BlendComponent -> ContT r IO WGPUBlendComponent #

data BlendState #

Describes the blend state of a render pipeline.

Constructors

BlendState
Fields blendColor :: !BlendComponent Color equation. blendAlpha :: !BlendComponent Alpha equation.

Instances

Instances details

Eq BlendState
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: BlendState -> BlendState -> Bool # (/=) :: BlendState -> BlendState -> Bool #
Show BlendState
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> BlendState -> ShowS # show :: BlendState -> String # showList :: [BlendState] -> ShowS #
ToRaw BlendState WGPUBlendState
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: BlendState -> ContT r IO WGPUBlendState #

data ColorWriteMask #

Describes which color channels are written.

Constructors

ColorWriteMask
Fields maskRed :: !Bool maskGreen :: !Bool maskBlue :: !Bool maskAlpha :: !Bool

Instances

Instances details

Eq ColorWriteMask
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: ColorWriteMask -> ColorWriteMask -> Bool # (/=) :: ColorWriteMask -> ColorWriteMask -> Bool #
Show ColorWriteMask
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> ColorWriteMask -> ShowS # show :: ColorWriteMask -> String # showList :: [ColorWriteMask] -> ShowS #
ToRaw ColorWriteMask WGPUColorWriteMask
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: ColorWriteMask -> ContT r IO WGPUColorWriteMask #

data ColorTargetState #

Describes the color state of a render pipeline.

Constructors

ColorTargetState
Fields colorTextureFormat :: !TextureFormat The texture format of the image that this pipeline will render to. Must match the format of the corresponding color attachment in the command encoder. blend :: !(SMaybe BlendState) The blending that is used for this pipeline. colorWriteMask :: !ColorWriteMask Mask which enables or disables writes to different color/alpha channels.

Instances

Instances details

Eq ColorTargetState
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: ColorTargetState -> ColorTargetState -> Bool # (/=) :: ColorTargetState -> ColorTargetState -> Bool #
Show ColorTargetState
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> ColorTargetState -> ShowS # show :: ColorTargetState -> String # showList :: [ColorTargetState] -> ShowS #
ToRaw ColorTargetState WGPUColorTargetState
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: ColorTargetState -> ContT r IO WGPUColorTargetState #

data FragmentState #

Describes the fragment processing in a render pipeline.

Constructors

FragmentState
Fields fragmentShaderModule :: !ShaderModule The compiled shader module for this stage. fragmentEntryPoint :: !ShaderEntryPoint The entry point in the compiled shader. There must be a function that returns `void` with this name in the shader. targets :: !(Vector ColorTargetState) The color state of the render targets.

Instances

Instances details

Eq FragmentState
Instance details Defined in WGPU.Internal.Pipeline Methods (==) :: FragmentState -> FragmentState -> Bool # (/=) :: FragmentState -> FragmentState -> Bool #
Show FragmentState
Instance details Defined in WGPU.Internal.Pipeline Methods showsPrec :: Int -> FragmentState -> ShowS # show :: FragmentState -> String # showList :: [FragmentState] -> ShowS #
ToRaw FragmentState WGPUFragmentState
Instance details Defined in WGPU.Internal.Pipeline Methods raw :: FragmentState -> ContT r IO WGPUFragmentState #

createPipelineLayout #

Arguments

:: MonadIO m
=> Device	The device for which the pipeline layout will be created.
-> PipelineLayoutDescriptor	Descriptor of the pipeline.
-> m PipelineLayout

Create a pipeline layout.

createRenderPipeline :: MonadIO m => Device -> RenderPipelineDescriptor -> m RenderPipeline #

colorWriteMaskAll :: ColorWriteMask #

A ColorWriteMask that writes all colors and the alpha value.

Command Buffers

data CommandBuffer #

Instances

Instances details

Eq CommandBuffer
Instance details Defined in WGPU.Internal.CommandBuffer Methods (==) :: CommandBuffer -> CommandBuffer -> Bool # (/=) :: CommandBuffer -> CommandBuffer -> Bool #
Show CommandBuffer
Instance details Defined in WGPU.Internal.CommandBuffer Methods showsPrec :: Int -> CommandBuffer -> ShowS # show :: CommandBuffer -> String # showList :: [CommandBuffer] -> ShowS #
ToRaw CommandBuffer WGPUCommandBuffer
Instance details Defined in WGPU.Internal.CommandBuffer Methods raw :: CommandBuffer -> ContT r IO WGPUCommandBuffer #

Command Encoding

data CommandEncoder #

Handle to an encoder for a series of GPU operations.

A command encoder can record render passes, compute passes, and transfer operations between driver-managed resources like buffers and textures.

Instances

Instances details

Eq CommandEncoder
Instance details Defined in WGPU.Internal.CommandEncoder Methods (==) :: CommandEncoder -> CommandEncoder -> Bool # (/=) :: CommandEncoder -> CommandEncoder -> Bool #
Show CommandEncoder
Instance details Defined in WGPU.Internal.CommandEncoder Methods showsPrec :: Int -> CommandEncoder -> ShowS # show :: CommandEncoder -> String # showList :: [CommandEncoder] -> ShowS #
ToRaw CommandEncoder WGPUCommandEncoder
Instance details Defined in WGPU.Internal.CommandEncoder Methods raw :: CommandEncoder -> ContT r IO WGPUCommandEncoder #

data RenderPassEncoder #

Instances

Instances details

Eq RenderPassEncoder
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: RenderPassEncoder -> RenderPassEncoder -> Bool # (/=) :: RenderPassEncoder -> RenderPassEncoder -> Bool #
Show RenderPassEncoder
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> RenderPassEncoder -> ShowS # show :: RenderPassEncoder -> String # showList :: [RenderPassEncoder] -> ShowS #
ToRaw RenderPassEncoder WGPURenderPassEncoder
Instance details Defined in WGPU.Internal.RenderPass Methods raw :: RenderPassEncoder -> ContT r IO WGPURenderPassEncoder #

data Color #

RGBA double-precision color.

Constructors

Color
Fields red :: !Double green :: !Double blue :: !Double alpha :: !Double

Instances

Instances details

Eq Color
Instance details Defined in WGPU.Internal.Color Methods (==) :: Color -> Color -> Bool # (/=) :: Color -> Color -> Bool #
Show Color
Instance details Defined in WGPU.Internal.Color Methods showsPrec :: Int -> Color -> ShowS # show :: Color -> String # showList :: [Color] -> ShowS #
ToRaw Color WGPUColor
Instance details Defined in WGPU.Internal.Color Methods raw :: Color -> ContT r IO WGPUColor #

data LoadOp a #

Operation to perform to the output attachment at the start of a render pass.

Constructors

LoadOpClear !a	Clear with the specified color value.
LoadOpLoad	Load from memory.

Instances

Instances details

Eq a => Eq (LoadOp a)
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: LoadOp a -> LoadOp a -> Bool # (/=) :: LoadOp a -> LoadOp a -> Bool #
Show a => Show (LoadOp a)
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> LoadOp a -> ShowS # show :: LoadOp a -> String # showList :: [LoadOp a] -> ShowS #

data StoreOp #

Operation to perform to the output attachment at the end of the render pass.

Constructors

StoreOpStore	Store the result.
StoreOpClear	Discard the result.

Instances

Instances details

Eq StoreOp
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: StoreOp -> StoreOp -> Bool # (/=) :: StoreOp -> StoreOp -> Bool #
Show StoreOp
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> StoreOp -> ShowS # show :: StoreOp -> String # showList :: [StoreOp] -> ShowS #
ToRaw StoreOp WGPUStoreOp
Instance details Defined in WGPU.Internal.RenderPass Methods raw :: StoreOp -> ContT r IO WGPUStoreOp #

data Operations a #

Constructors

Operations
Fields load :: !(LoadOp a) store :: !StoreOp

Instances

Instances details

Eq a => Eq (Operations a)
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: Operations a -> Operations a -> Bool # (/=) :: Operations a -> Operations a -> Bool #
Show a => Show (Operations a)
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> Operations a -> ShowS # show :: Operations a -> String # showList :: [Operations a] -> ShowS #

data RenderPassColorAttachment #

Describes a color attachment to a render pass.

Constructors

RenderPassColorAttachment
Fields colorView :: !TextureView The view to use as an attachment. resolveTarget :: !(SMaybe TextureView) The view that will receive output if multisampling is used. operations :: !(Operations Color) What operations will be performed on this color attachment.

Instances

Instances details

Eq RenderPassColorAttachment
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: RenderPassColorAttachment -> RenderPassColorAttachment -> Bool # (/=) :: RenderPassColorAttachment -> RenderPassColorAttachment -> Bool #
Show RenderPassColorAttachment
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> RenderPassColorAttachment -> ShowS # show :: RenderPassColorAttachment -> String # showList :: [RenderPassColorAttachment] -> ShowS #
ToRaw RenderPassColorAttachment WGPURenderPassColorAttachment
Instance details Defined in WGPU.Internal.RenderPass Methods raw :: RenderPassColorAttachment -> ContT r IO WGPURenderPassColorAttachment #

data RenderPassDepthStencilAttachment #

Describes a depth/stencil attachment to a render pass.

Constructors

RenderPassDepthStencilAttachment
Fields depthStencilView :: !TextureView The view to use as an attachment. depthOps :: !(SMaybe (Operations Float)) What operations will be performed on the depth part. stencilOps :: !(SMaybe (Operations Word32)) What operations will be performed on the stencil part.

Instances

Instances details

Eq RenderPassDepthStencilAttachment
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: RenderPassDepthStencilAttachment -> RenderPassDepthStencilAttachment -> Bool # (/=) :: RenderPassDepthStencilAttachment -> RenderPassDepthStencilAttachment -> Bool #
Show RenderPassDepthStencilAttachment
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> RenderPassDepthStencilAttachment -> ShowS # show :: RenderPassDepthStencilAttachment -> String # showList :: [RenderPassDepthStencilAttachment] -> ShowS #
ToRaw RenderPassDepthStencilAttachment WGPURenderPassDepthStencilAttachment
Instance details Defined in WGPU.Internal.RenderPass Methods raw :: RenderPassDepthStencilAttachment -> ContT r IO WGPURenderPassDepthStencilAttachment #

data RenderPassDescriptor #

Describes the attachments of a render pass.

Constructors

RenderPassDescriptor
Fields renderPassLabel :: !Text Debugging label for the render pass. colorAttachments :: !(Vector RenderPassColorAttachment) Color attachments of the render pass. depthStencilAttachment :: !(SMaybe RenderPassDepthStencilAttachment) Depth and stencil attachments of the render pass.

Instances

Instances details

Eq RenderPassDescriptor
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: RenderPassDescriptor -> RenderPassDescriptor -> Bool # (/=) :: RenderPassDescriptor -> RenderPassDescriptor -> Bool #
Show RenderPassDescriptor
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> RenderPassDescriptor -> ShowS # show :: RenderPassDescriptor -> String # showList :: [RenderPassDescriptor] -> ShowS #
ToRaw RenderPassDescriptor WGPURenderPassDescriptor
Instance details Defined in WGPU.Internal.RenderPass Methods raw :: RenderPassDescriptor -> ContT r IO WGPURenderPassDescriptor #

data Range a #

Half open range. It includes the start value but not the end value.

Constructors

Range
Fields rangeStart :: !a rangeLength :: !a

Instances

Instances details

Eq a => Eq (Range a)
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: Range a -> Range a -> Bool # (/=) :: Range a -> Range a -> Bool #
Show a => Show (Range a)
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> Range a -> ShowS # show :: Range a -> String # showList :: [Range a] -> ShowS #

createCommandEncoder #

Arguments

:: MonadIO m
=> Device	Device for which to create the command encoder.
-> Text	Debug label for the command encoder.
-> m CommandEncoder	IO action that returns the command encoder.

Create an empty command encoder.

commandEncoderFinish #

Arguments

:: MonadIO m
=> CommandEncoder	Command encoder to finish.
-> Text	Debugging label for the command buffer.
-> m CommandBuffer	IO action which returns the command buffer.

Finish encoding commands, returning a command buffer.

beginRenderPass #

Arguments

:: MonadIO m
=> CommandEncoder	`CommandEncoder` to contain the render pass.
-> RenderPassDescriptor	Description of the render pass.
-> m RenderPassEncoder	IO action which returns the render pass encoder.

Begins recording of a render pass.

renderPassSetPipeline #

Arguments

:: MonadIO m
=> RenderPassEncoder	Render pass encoder on which to act.
-> RenderPipeline	Render pipeline to set active.
-> m ()	IO action which sets the active render pipeline.

Sets the active render pipeline.

Subsequent draw calls will exhibit the behaviour defined by the pipeline.

renderPassSetBindGroup :: MonadIO m => RenderPassEncoder -> Word32 -> BindGroup -> Vector Word32 -> m () #

Sets the active bind group for a given bind group index.

renderPassSetIndexBuffer :: MonadIO m => RenderPassEncoder -> Buffer -> IndexFormat -> Word64 -> Word64 -> m () #

Sets the active index buffer.

renderPassSetVertexBuffer :: MonadIO m => RenderPassEncoder -> Word32 -> Buffer -> Word64 -> Word64 -> m () #

Assign a vertex buffer to a slot.

renderPassDraw #

Arguments

:: MonadIO m
=> RenderPassEncoder	Render pass encoder on which to act.
-> Range Word32	Range of vertices to draw.
-> Range Word32	Range of instances to draw.
-> m ()	IO action which stores the draw command.

Draws primitives from the active vertex buffers.

renderPassDrawIndexed :: MonadIO m => RenderPassEncoder -> Range Word32 -> Int32 -> Range Word32 -> m () #

endRenderPass #

Arguments

:: MonadIO m
=> RenderPassEncoder	Render pass encoder on which to finish recording.
-> m ()	IO action that finishes recording.

Finish recording of a render pass.

Queue

data Queue #

Instances

Instances details

Eq Queue
Instance details Defined in WGPU.Internal.Queue Methods (==) :: Queue -> Queue -> Bool # (/=) :: Queue -> Queue -> Bool #
Show Queue
Instance details Defined in WGPU.Internal.Queue Methods showsPrec :: Int -> Queue -> ShowS # show :: Queue -> String # showList :: [Queue] -> ShowS #
Has Queue Resources Source #
Instance details Defined in WGPU.BoneYard.SimpleSDL Methods getter :: Resources -> Queue # modifier :: (Queue -> Queue) -> Resources -> Resources # hasLens :: Lens Resources Queue #
ToRaw Queue WGPUQueue
Instance details Defined in WGPU.Internal.Queue Methods raw :: Queue -> ContT r IO WGPUQueue #

getQueue :: MonadIO m => Device -> m Queue #

Get the queue for a device.

queueSubmit :: MonadIO m => Queue -> Vector CommandBuffer -> m () #

Submit a list of command buffers to a device queue.

queueWriteTexture #

Arguments

:: (MonadIO m, ReadableMemoryBuffer a)
=> Queue	Queue to which the texture write will be submitted.
-> ImageCopyTexture	View of a texture which will be copied.
-> TextureDataLayout	Layout of the texture in a buffer's memory.
-> Extent3D	Extent of the texture operation.
-> a	A `ReadableMemoryBuffer` from which to copy. All of the buffer is copied (as determined by its `readableMemoryBufferSize`).
-> m ()	Action to copy the texture

Schedule a data write into a texture.

queueWriteBuffer #

Arguments

:: (MonadIO m, ReadableMemoryBuffer a)
=> Queue	Queue to which the buffer write will be submitted.
-> Buffer	Buffer in which to write.
-> a	A `ReadableMemoryBuffer` from which to copy. All of the buffer is copied (as determined by its `readableMemoryBufferSize`).
-> m ()	Action which copies the buffer data.

Schedule a data write into a buffer.

Version

data Version #

Version of WGPU native.

Constructors

Version
Fields major :: !Word8 minor :: !Word8 patch :: !Word8 subPatch :: !Word8

Instances

Instances details

Eq Version
Instance details Defined in WGPU.Internal.Instance Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Show Version
Instance details Defined in WGPU.Internal.Instance Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #

getVersion :: MonadIO m => Instance -> m Version #

Return the exact version of the WGPU native instance.

versionToText :: Version -> Text #

Convert a Version value to a text string.

>>> versionToText (Version 0 9 2 2) "v0.9.2.2"

Logging

data LogLevel #

Logging level.

Constructors

Trace
Debug
Info
Warn
Error

Instances

Instances details

Eq LogLevel
Instance details Defined in WGPU.Internal.Instance Methods (==) :: LogLevel -> LogLevel -> Bool # (/=) :: LogLevel -> LogLevel -> Bool #
Show LogLevel
Instance details Defined in WGPU.Internal.Instance Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #

connectLog :: MonadIO m => Instance -> m () #

Connect a stdout logger to the instance.

disconnectLog :: MonadIO m => Instance -> m () #

Disconnect a stdout logger from the instance.

setLogLevel :: MonadIO m => Instance -> LogLevel -> m () #

Set the current logging level for the instance.

Multipurpose

data CompareFunction #

Comparison function used for depth and stencil operations.

Constructors

CompareFunctionNever
CompareFunctionLess
CompareFunctionEqual
CompareFunctionLessEqual
CompareFunctionGreater
CompareFunctionNotEqual
CompareFunctionGreaterEqual
CompareFunctionAlways

Instances

Instances details

Eq CompareFunction
Instance details Defined in WGPU.Internal.Multipurpose Methods (==) :: CompareFunction -> CompareFunction -> Bool # (/=) :: CompareFunction -> CompareFunction -> Bool #
Show CompareFunction
Instance details Defined in WGPU.Internal.Multipurpose Methods showsPrec :: Int -> CompareFunction -> ShowS # show :: CompareFunction -> String # showList :: [CompareFunction] -> ShowS #
ToRaw CompareFunction WGPUCompareFunction	Convert a `CompareFunction` to its raw value.
Instance details Defined in WGPU.Internal.Multipurpose Methods raw :: CompareFunction -> ContT r IO WGPUCompareFunction #

Extras

Strict Maybe

data SMaybe a #

Strict version of the Maybe type.

Constructors

SNothing
SJust !a

Instances

Instances details

Eq a => Eq (SMaybe a)
Instance details Defined in WGPU.Internal.SMaybe Methods (==) :: SMaybe a -> SMaybe a -> Bool # (/=) :: SMaybe a -> SMaybe a -> Bool #
Show a => Show (SMaybe a)
Instance details Defined in WGPU.Internal.SMaybe Methods showsPrec :: Int -> SMaybe a -> ShowS # show :: SMaybe a -> String # showList :: [SMaybe a] -> ShowS #

fromSMaybe #

Arguments

:: a	Default value.
-> SMaybe a	`SMaybe` from which to return the `SJust` value if possible.
-> a	`SJust` value, if present, or the default value, if not.

Return a value from an SMaybe with a default.

This function returns the SJust value from an SMaybe, or the default value if the SMaybe is SNothing.

Additional Classes

class ReadableMemoryBuffer a where #

Region of memory that is read-only for WGPU.

A ReadableMemoryBuffer represents a contiguous region of memory that WGPU may read from, but not write to. It has a pointer to the start of the region, and a size in bytes.

When the caller of WGPU supplies a ReadableMemoryBuffer, it commits to keeping the buffer alive for the period of the call to withReadablePtr. WGPU commits to not mutating the data.

If it is necessary to refer to slices within a buffer, it is up to the type a to store those offsets and account for them in the two functions required by the API. (For example, Vector does this.)

Methods

withReadablePtr :: a -> (Ptr () -> IO b) -> IO b #

Perform an action with the memory buffer.

readableMemoryBufferSize :: a -> ByteSize #

The size of the buffer, in number of bytes.

Instances

Instances details

Storable a => ReadableMemoryBuffer a
Instance details Defined in WGPU.Internal.Memory Methods withReadablePtr :: a -> (Ptr () -> IO b) -> IO b # readableMemoryBufferSize :: a -> ByteSize #
Storable a => ReadableMemoryBuffer (Vector a)
Instance details Defined in WGPU.Internal.Memory Methods withReadablePtr :: Vector a -> (Ptr () -> IO b) -> IO b # readableMemoryBufferSize :: Vector a -> ByteSize #

Additional Types

newtype ByteSize #

Size, in number of bytes.

Constructors

ByteSize
Fields unByteSize :: Word64

Instances

Instances details

Enum ByteSize
Instance details Defined in WGPU.Internal.Memory Methods succ :: ByteSize -> ByteSize # pred :: ByteSize -> ByteSize # toEnum :: Int -> ByteSize # fromEnum :: ByteSize -> Int # enumFrom :: ByteSize -> [ByteSize] # enumFromThen :: ByteSize -> ByteSize -> [ByteSize] # enumFromTo :: ByteSize -> ByteSize -> [ByteSize] # enumFromThenTo :: ByteSize -> ByteSize -> ByteSize -> [ByteSize] #
Eq ByteSize
Instance details Defined in WGPU.Internal.Memory Methods (==) :: ByteSize -> ByteSize -> Bool # (/=) :: ByteSize -> ByteSize -> Bool #
Integral ByteSize
Instance details Defined in WGPU.Internal.Memory Methods quot :: ByteSize -> ByteSize -> ByteSize # rem :: ByteSize -> ByteSize -> ByteSize # div :: ByteSize -> ByteSize -> ByteSize # mod :: ByteSize -> ByteSize -> ByteSize # quotRem :: ByteSize -> ByteSize -> (ByteSize, ByteSize) # divMod :: ByteSize -> ByteSize -> (ByteSize, ByteSize) # toInteger :: ByteSize -> Integer #
Num ByteSize
Instance details Defined in WGPU.Internal.Memory Methods (+) :: ByteSize -> ByteSize -> ByteSize # (-) :: ByteSize -> ByteSize -> ByteSize # (*) :: ByteSize -> ByteSize -> ByteSize # negate :: ByteSize -> ByteSize # abs :: ByteSize -> ByteSize # signum :: ByteSize -> ByteSize # fromInteger :: Integer -> ByteSize #
Ord ByteSize
Instance details Defined in WGPU.Internal.Memory Methods compare :: ByteSize -> ByteSize -> Ordering # (<) :: ByteSize -> ByteSize -> Bool # (<=) :: ByteSize -> ByteSize -> Bool # (>) :: ByteSize -> ByteSize -> Bool # (>=) :: ByteSize -> ByteSize -> Bool # max :: ByteSize -> ByteSize -> ByteSize # min :: ByteSize -> ByteSize -> ByteSize #
Real ByteSize
Instance details Defined in WGPU.Internal.Memory Methods toRational :: ByteSize -> Rational #
Show ByteSize
Instance details Defined in WGPU.Internal.Memory Methods showsPrec :: Int -> ByteSize -> ShowS # show :: ByteSize -> String # showList :: [ByteSize] -> ShowS #
ToRaw ByteSize CSize
Instance details Defined in WGPU.Internal.Memory Methods raw :: ByteSize -> ContT r IO CSize #

VertexFormatUint8x2
VertexFormatUint8x4
VertexFormatSint8x2
VertexFormatSint8x4
VertexFormatUnorm8x2
VertexFormatUnorm8x4
VertexFormatSnorm8x2
VertexFormatSnorm8x4
VertexFormatUint16x2
VertexFormatUint16x4
VertexFormatSint16x2
VertexFormatSint16x4
VertexFormatUnorm16x2
VertexFormatUnorm16x4
VertexFormatSnorm16x2
VertexFormatSnorm16x4
VertexFormatFloat16x2
VertexFormatFloat16x4
VertexFormatFloat32
VertexFormatFloat32x2
VertexFormatFloat32x3
VertexFormatFloat32x4
VertexFormatUint32
VertexFormatUint32x2
VertexFormatUint32x3
VertexFormatUint32x4
VertexFormatSint32
VertexFormatSint32x2
VertexFormatSint32x3
VertexFormatSint32x4