Safe Haskell	None
Language	Haskell2010

WGPU.Internal.RenderPass

Contents

Types
Functions

Description

Synopsis

newtype RenderPipeline = RenderPipeline {
- wgpuRenderPipeline :: WGPURenderPipeline
}
data RenderPassEncoder
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
}
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 ()

Types

newtype RenderPipeline Source #

Constructors

RenderPipeline
Fields wgpuRenderPipeline :: WGPURenderPipeline

Instances

Instances details

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

data RenderPassEncoder Source #

Instances

Instances details

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

data LoadOp a Source #

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) Source #
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: LoadOp a -> LoadOp a -> Bool # (/=) :: LoadOp a -> LoadOp a -> Bool #
Show a => Show (LoadOp a) Source #
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> LoadOp a -> ShowS # show :: LoadOp a -> String # showList :: [LoadOp a] -> ShowS #

data StoreOp Source #

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

data Operations a Source #

Constructors

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

Instances

Instances details

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

data RenderPassColorAttachment Source #

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

data RenderPassDepthStencilAttachment Source #

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

data RenderPassDescriptor Source #

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

data Range a Source #

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) Source #
Instance details Defined in WGPU.Internal.RenderPass Methods (==) :: Range a -> Range a -> Bool # (/=) :: Range a -> Range a -> Bool #
Show a => Show (Range a) Source #
Instance details Defined in WGPU.Internal.RenderPass Methods showsPrec :: Int -> Range a -> ShowS # show :: Range a -> String # showList :: [Range a] -> ShowS #

Functions

beginRenderPass Source #

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 Source #

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 () Source #

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

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

Sets the active index buffer.

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

Assign a vertex buffer to a slot.

renderPassDraw Source #

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 () Source #

endRenderPass Source #

Arguments

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

Finish recording of a render pass.