Safe Haskell	None
Language	GHC2021

Box3D.Base

Contents

Version
Allocator
Assert / log hooks
Timing

Description

Low-level bindings to box3d/base.h: version info, global allocator / assert / log hooks, and timing helpers.

Synopsis

data Version = Version {
- versionMajor :: CInt
- versionMinor :: CInt
- versionRevision :: CInt
}
getVersion :: IO Version
isDoublePrecision :: IO Bool
type AllocFcn = Int32 -> Int32 -> IO (Ptr ())
type FreeFcn = Ptr () -> IO ()
setAllocator :: FunPtr AllocFcn -> FunPtr FreeFcn -> IO ()
getByteCount :: IO Int32
type AssertFcn = CString -> CString -> CInt -> IO CInt
type LogFcn = CString -> IO ()
setAssertFcn :: FunPtr AssertFcn -> IO ()
setLogFcn :: FunPtr LogFcn -> IO ()
getTicks :: IO Word64
getMilliseconds :: Word64 -> IO CFloat
getMillisecondsAndReset :: Ptr Word64 -> IO CFloat
yield :: IO ()
sleep :: CInt -> IO ()
hash :: Word32 -> Ptr Word8 -> CInt -> IO Word32

Version

data Version Source #

Version numbering scheme, see https://semver.org/.

Constructors

Version
Fields versionMajor :: CInt versionMinor :: CInt versionRevision :: CInt

Instances

Instances details

Storable Version Source #
Instance details Defined in Box3D.Base Methods sizeOf :: Version -> Int # alignment :: Version -> Int # peekElemOff :: Ptr Version -> Int -> IO Version # pokeElemOff :: Ptr Version -> Int -> Version -> IO () # peekByteOff :: Ptr b -> Int -> IO Version # pokeByteOff :: Ptr b -> Int -> Version -> IO () # peek :: Ptr Version -> IO Version # poke :: Ptr Version -> Version -> IO () #
Show Version Source #
Instance details Defined in Box3D.Base Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
Eq Version Source #
Instance details Defined in Box3D.Base Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #

getVersion :: IO Version Source #

Get the current version of Box3D.

isDoublePrecision :: IO Bool Source #

Allocator

type AllocFcn = Int32 -> Int32 -> IO (Ptr ()) Source #

User allocation function: void* (int32 size, int32 alignment).

type FreeFcn = Ptr () -> IO () Source #

User free function: void (void* mem).

setAllocator :: FunPtr AllocFcn -> FunPtr FreeFcn -> IO () Source #

Override the default allocation functions. Set during application startup.

The FunPtrs must point to C functions: the engine calls the hooks from inside unsafe FFI calls, where re-entering Haskell is undefined behaviour, so wrapping Haskell functions is not supported yet.

getByteCount :: IO Int32 Source #

Total bytes allocated by Box3D.

Assert / log hooks

type AssertFcn = CString -> CString -> CInt -> IO CInt Source #

Assert callback: int (const char* condition, const char* file, int line). Return 0 to skip the debugger break.

type LogFcn = CString -> IO () Source #

Log callback: void (const char* message).

setAssertFcn :: FunPtr AssertFcn -> IO () Source #

Override the default assert callback. Must point to a C function, see setAllocator.

setLogFcn :: FunPtr LogFcn -> IO () Source #

Override the default logging callback. Must point to a C function, see setAllocator.

Timing

getTicks :: IO Word64 Source #

Absolute number of system ticks. The value is platform specific.

getMilliseconds :: Word64 -> IO CFloat Source #

Milliseconds passed from an initial tick value.

getMillisecondsAndReset :: Ptr Word64 -> IO CFloat Source #

Milliseconds passed from an initial tick value, resetting it to now.

yield :: IO () Source #

Yield to be used in a busy loop.

sleep :: CInt -> IO () Source #

Sleep the current thread for a number of milliseconds. Imported as a safe call so the blocked thread releases its capability instead of stalling the RTS for the whole duration.

hash :: Word32 -> Ptr Word8 -> CInt -> IO Word32 Source #

Simple djb2 hash function for determinism testing.