WGPU.Internal.SwapChain

Types

data SwapChain

Instances

Eq SwapChain

Defined in WGPU.Internal.SwapChain

Methods

(==) :: SwapChain -> SwapChain -> Bool

(/=) :: SwapChain -> SwapChain -> Bool

Show SwapChain

Defined in WGPU.Internal.SwapChain

Methods

showsPrec :: Int -> SwapChain -> ShowS

show :: SwapChain -> String

showList :: [SwapChain] -> ShowS

ToRaw SwapChain WGPUSwapChain

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

Eq SwapChainDescriptor

Defined in WGPU.Internal.SwapChain

Methods

(==) :: SwapChainDescriptor -> SwapChainDescriptor -> Bool

(/=) :: SwapChainDescriptor -> SwapChainDescriptor -> Bool

Show SwapChainDescriptor

Defined in WGPU.Internal.SwapChain

Methods

showsPrec :: Int -> SwapChainDescriptor -> ShowS

show :: SwapChainDescriptor -> String

showList :: [SwapChainDescriptor] -> ShowS

ToRaw SwapChainDescriptor WGPUSwapChainDescriptor

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

Eq PresentMode

Defined in WGPU.Internal.SwapChain

Methods

(==) :: PresentMode -> PresentMode -> Bool

(/=) :: PresentMode -> PresentMode -> Bool

Show PresentMode

Defined in WGPU.Internal.SwapChain

Methods

showsPrec :: Int -> PresentMode -> ShowS

show :: PresentMode -> String

showList :: [PresentMode] -> ShowS

ToRaw PresentMode WGPUPresentMode

Defined in WGPU.Internal.SwapChain

Methods

raw :: PresentMode -> ContT r IO WGPUPresentMode

Functions

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.