Safe Haskell	None
Language	GHC2021

Box2D.Id

Description

Low-level bindings to box2d/id.h: opaque handles to Box2D objects.

The C API passes these as integer-only structs of at most 8 bytes by value. On the 64-bit ABIs this package supports (x86-64 SysV and Win64, AArch64) such a struct travels in a general-purpose register exactly like a uint32_t/uint64_t, so the handles are newtypes over words and cross the FFI directly, with no shim. The payload is the raw struct bytes and carries no stable meaning; the constructors are exported only so foreign imports can see through the newtypes. A zero word is the null id, which is also what zero-initialisation produces on the C side. Struct sizes are pinned by _Static_asserts in cbits/box2d_shim.c.

ContactId is 12 bytes and does not fit a word, so it keeps a struct-shaped representation; nothing passes it by value yet.

Synopsis

newtype WorldId = WorldId Word32
newtype BodyId = BodyId Word64
newtype ShapeId = ShapeId Word64
newtype ChainId = ChainId Word64
newtype JointId = JointId Word64
data ContactId = ContactId Int32 Word16 Word32
nullWorldId :: WorldId
nullBodyId :: BodyId
nullShapeId :: ShapeId
nullChainId :: ChainId
nullJointId :: JointId
nullContactId :: ContactId

Documentation

newtype WorldId Source #

Handle to a world instance.

Constructors

WorldId Word32

Instances

Instances details

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

newtype BodyId Source #

Handle to a body instance.

Constructors

BodyId Word64

Instances

Instances details

HasUserData BodyId Source #
Instance details Defined in Box2D.UserData Methods setUserData :: BodyId -> Ptr () -> IO () Source # getUserData :: BodyId -> IO (Ptr ()) Source #
Storable BodyId Source #
Instance details Defined in Box2D.Id Methods sizeOf :: BodyId -> Int # alignment :: BodyId -> Int # peekElemOff :: Ptr BodyId -> Int -> IO BodyId # pokeElemOff :: Ptr BodyId -> Int -> BodyId -> IO () # peekByteOff :: Ptr b -> Int -> IO BodyId # pokeByteOff :: Ptr b -> Int -> BodyId -> IO () # peek :: Ptr BodyId -> IO BodyId # poke :: Ptr BodyId -> BodyId -> IO () #
Show BodyId Source #
Instance details Defined in Box2D.Id Methods showsPrec :: Int -> BodyId -> ShowS # show :: BodyId -> String # showList :: [BodyId] -> ShowS #
Eq BodyId Source #
Instance details Defined in Box2D.Id Methods (==) :: BodyId -> BodyId -> Bool # (/=) :: BodyId -> BodyId -> Bool #

newtype ShapeId Source #

Handle to a shape instance.

Constructors

ShapeId Word64

Instances

Instances details

HasUserData ShapeId Source #
Instance details Defined in Box2D.UserData Methods setUserData :: ShapeId -> Ptr () -> IO () Source # getUserData :: ShapeId -> IO (Ptr ()) Source #
Storable ShapeId Source #
Instance details Defined in Box2D.Id Methods sizeOf :: ShapeId -> Int # alignment :: ShapeId -> Int # peekElemOff :: Ptr ShapeId -> Int -> IO ShapeId # pokeElemOff :: Ptr ShapeId -> Int -> ShapeId -> IO () # peekByteOff :: Ptr b -> Int -> IO ShapeId # pokeByteOff :: Ptr b -> Int -> ShapeId -> IO () # peek :: Ptr ShapeId -> IO ShapeId # poke :: Ptr ShapeId -> ShapeId -> IO () #
Show ShapeId Source #
Instance details Defined in Box2D.Id Methods showsPrec :: Int -> ShapeId -> ShowS # show :: ShapeId -> String # showList :: [ShapeId] -> ShowS #
Eq ShapeId Source #
Instance details Defined in Box2D.Id Methods (==) :: ShapeId -> ShapeId -> Bool # (/=) :: ShapeId -> ShapeId -> Bool #

newtype ChainId Source #

Handle to a chain instance.

Constructors

ChainId Word64

Instances

Instances details

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

newtype JointId Source #

Handle to a joint instance.

Constructors

JointId Word64

Instances

Instances details

HasUserData JointId Source #
Instance details Defined in Box2D.UserData Methods setUserData :: JointId -> Ptr () -> IO () Source # getUserData :: JointId -> IO (Ptr ()) Source #
Storable JointId Source #
Instance details Defined in Box2D.Id Methods sizeOf :: JointId -> Int # alignment :: JointId -> Int # peekElemOff :: Ptr JointId -> Int -> IO JointId # pokeElemOff :: Ptr JointId -> Int -> JointId -> IO () # peekByteOff :: Ptr b -> Int -> IO JointId # pokeByteOff :: Ptr b -> Int -> JointId -> IO () # peek :: Ptr JointId -> IO JointId # poke :: Ptr JointId -> JointId -> IO () #
Show JointId Source #
Instance details Defined in Box2D.Id Methods showsPrec :: Int -> JointId -> ShowS # show :: JointId -> String # showList :: [JointId] -> ShowS #
Eq JointId Source #
Instance details Defined in Box2D.Id Methods (==) :: JointId -> JointId -> Bool # (/=) :: JointId -> JointId -> Bool #

data ContactId Source #

Handle to a contact instance.

Constructors

ContactId Int32 Word16 Word32

Instances

Instances details

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

nullWorldId :: WorldId Source #

nullBodyId :: BodyId Source #

nullShapeId :: ShapeId Source #

nullChainId :: ChainId Source #

nullJointId :: JointId Source #

nullContactId :: ContactId Source #