WGPU.Internal.Instance

Instance of the WGPU API Haskell bindings.

Instance

The Haskell bindings to WGPU use a value of type Instance as a handle to the rest of the API. An Instance value is obtained by loading a dynamic library at runtime, using the withInstance function. A typical invocation might look like this:

withInstance "libwgpu_native.dylib" (Just logStdOut) $ inst -> do
  -- set the logging level for the instance
  setLogLevel inst Warn
  -- run the rest of the program ...

The dynamic library libwgpu_native.dylib is obtained by compiling the Rust project wgpu-native. Care should be take to compile a version of libwgpu_native.dylib which is compatible with the API in these bindings.

newtype Instance

Instance of the WGPU API.

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

Constructors

Instance

Fields

• wgpuHsInstance :: WGPUHsInstance

Instances

Show Instance

Defined in WGPU.Internal.Instance

Methods

showsPrec :: Int -> Instance -> ShowS

show :: Instance -> String

showList :: [Instance] -> ShowS

ToRaw Instance WGPUHsInstance

Defined in WGPU.Internal.Instance

Methods

raw :: Instance -> ContT c IO WGPUHsInstance

withInstance

Arguments

:: FilePath

Name of the wgpu-native dynamic library, or a complete path to it.

-> Maybe LogCallback

Optional logging callback. Just logStdout can be supplied here to print log messages to stdout for debugging purposes.

-> (Instance -> IO a)

The Program. A function which takes an Instance and returns an IO action that uses the instance.

-> IO a

IO action which loads the WGPU Instance, passes it to the program, and returns the result of running the program.

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

Logging

type LogCallback = LogLevel -> Text -> IO ()

Logging callback function.

data LogLevel

Logging level.

Constructors

Trace

Debug

Info

Warn

Error

Instances

Eq LogLevel

Defined in WGPU.Internal.Instance

Methods

(==) :: LogLevel -> LogLevel -> Bool

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

Show LogLevel

Defined in WGPU.Internal.Instance

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

setLogLevel :: Instance -> LogLevel -> IO ()

Set the current logging level for the instance.

logLevelToText :: LogLevel -> Text

Convert a LogLevel to a text string.

logStdout :: LogLevel -> Text -> IO ()

A logging function which prints to stdout.

This logging function can be supplied to withInstance to print logging messages to stdout for debugging purposes.

Version

data Version

Version of WGPU native.

Constructors

Version

Fields

• major :: !Word8
• minor :: !Word8
• patch :: !Word8
• subPatch :: !Word8

Instances

Eq Version

Defined in WGPU.Internal.Instance

Methods

(==) :: Version -> Version -> Bool

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

Show Version

Defined in WGPU.Internal.Instance

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

getVersion :: Instance -> IO 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"