Safe Haskell	None
Language	GHC2021

Box2D.Base

Contents

Version
Allocator
Assert / log hooks
Timing

Description

Low-level bindings to box2d/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 = CSize -> CInt -> IO (Ptr ())
type FreeFcn = Ptr () -> CSize -> IO ()
setAllocator :: FunPtr AllocFcn -> FunPtr FreeFcn -> IO ()
getByteCount :: IO Int64
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 ()
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 Box2D.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 Box2D.Base Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
Eq Version Source #
Instance details Defined in Box2D.Base Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #

getVersion :: IO Version Source #

Get the current version of Box2D.

isDoublePrecision :: IO Bool Source #

Allocator

type AllocFcn = CSize -> CInt -> IO (Ptr ()) Source #

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

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

User free function: void (void* mem, size_t size).

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

Total bytes allocated by Box2D.