Documentation

Get the current number of worlds

Binds b3GetWorldCount.

Get the maximum number of simultaneous worlds that have been created

Binds b3GetMaxWorldCount.

Save the recording buffer to a file. Returns true on success.

Binds b3SaveRecordingToFile.

Load a recording from a file. Returns NULL on failure (file not found, wrong magic). The caller owns the returned recording and must destroy it with b3DestroyRecording.

Binds b3LoadRecordingFromFile.

Replay a recording from memory and verify it reproduces the same world-state hashes. Stands up a fresh world, restores the seed snapshot, replays every op, and checks each embedded StateHash record. Returns true if replay completed without id mismatches or hash divergences.

Binds b3ValidateReplay.

Deep clone a hull.

Binds b3CloneHull.

Clone and transform a hull. Supports non-uniform and mirroring scale.

Binds b3CloneAndTransformHull.

Make a cube as a hull. Do not call b3DestroyHull on this.

Binds b3MakeCubeHull.

Make a box as a hull. Do not call b3DestroyHull on this.

Binds b3MakeBoxHull.

Make an offset box as a hull. Do not call b3DestroyHull on this.

Binds b3MakeOffsetBoxHull.

Make a transformed box as a hull. Do not call b3DestroyHull on this.

Binds b3MakeTransformedBoxHull.

This makes a transformed box hull with post scaling. This is useful for boxes that are scaled in a level editor. Such scaling can have reflection and shear. In the case of shear the result may be approximate. If you need to support shear consider using b3CreateHull. Do not call b3DestroyHull on this.

Binds b3MakeScaledBoxHull.

This takes a box with a transform and post scale and converts it into a box with the post scale resolved with new half-widths and transform. This accepts non-uniform and negative scale. This is approximate if there is shear.

Binds b3ScaleBox.

Get the height of the mesh BVH.

Binds b3GetHeight.

Save input height data to a file

Binds b3DumpHeightData.

Create a height field by loading a previously saved height data

Binds b3LoadHeightField.

Get a child shape of a compound.

Binds b3GetCompoundChild.

Query a compound shape for children that overlap an AABB.

Binds b3QueryCompound.

Access a child capsule by index.

Binds b3GetCompoundCapsule.

Access a child hull by index.

Binds b3GetCompoundHull.

Access a child mesh by index.

Binds b3GetCompoundMesh.

Access a child sphere by index.

Binds b3GetCompoundSphere.

Access the compound material array.

Binds b3GetCompoundMaterials.

If bytes is null then this returns the number of required bytes. This clones all the data into the bytes buffer. This is expected to run offline or asynchronously. This mutates the compound to nullify pointers, leaving the compound in an unusable state.

Binds b3ConvertCompoundToBytes.

Convert bytes to compound. This does not clone. The bytes must remain in scope while the compound is used. This is done to improve run-time performance and allow for instancing. The bytes are mutated to fixup pointers.

Binds b3ConvertBytesToCompound.

Compute mass properties of a sphere

Binds b3ComputeSphereMass.

Compute mass properties of a capsule

Binds b3ComputeCapsuleMass.

Compute mass properties of a hull

Binds b3ComputeHullMass.

Like computeHullMass, but the result is written into a caller-supplied buffer.

Compute the bounding box of a transformed sphere

Binds b3ComputeSphereAABB.

Compute the bounding box of a transformed capsule

Binds b3ComputeCapsuleAABB.

Compute the bounding box of a transformed hull

Binds b3ComputeHullAABB.

Compute the bounding box of a transformed mesh. Scale may be non-uniform and have negative components.

Binds b3ComputeMeshAABB.

Compute the bounding box of a transformed height-field

Binds b3ComputeHeightFieldAABB.

Compute the bounding box of a compound

Binds b3ComputeCompoundAABB.

Use this to ensure your ray cast input is valid and avoid internal assertions.

Binds b3IsValidRay.

Overlap shape versus capsule

Binds b3OverlapCapsule.

Overlap shape versus compound

Binds b3OverlapCompound.

Overlap shape versus height field

Binds b3OverlapHeightField.

Overlap shape versus hull

Binds b3OverlapHull.

Overlap shape versus mesh

Binds b3OverlapMesh.

Overlap shape versus sphere

Binds b3OverlapSphere.

Ray cast versus sphere in local space. A zero length ray is a point query. Initial overlap reports a hit at the ray origin with zero fraction and zero normal.

Binds b3RayCastSphere.

Ray cast versus a hollow sphere shell in local space. Unlike the solid sphere a ray starting inside is not an overlap: it passes through and hits the far wall.

Binds b3RayCastHollowSphere.

Ray cast versus capsule in local space. A zero length ray is a point query. Initial overlap reports a hit at the ray origin with zero fraction and zero normal.

Binds b3RayCastCapsule.

Ray cast versus compound in local space. A zero length ray is a point query. Initial overlap with a child reports a hit at the ray origin with zero fraction and zero normal.

Binds b3RayCastCompound.

Ray cast versus hull shape in local space. A zero length ray is a point query. Initial overlap reports a hit at the ray origin with zero fraction and zero normal.

Binds b3RayCastHull.

Ray cast versus mesh in local space. A thin surface with no interior, so there is no overlap case.

Binds b3RayCastMesh.

Ray cast versus height field in local space. A thin surface with no interior, so there is no overlap case.

Binds b3RayCastHeightField.

Shape cast versus a sphere. Initial overlap is treated as a miss.

Binds b3ShapeCastSphere.

Shape cast versus a capsule. Initial overlap is treated as a miss.

Binds b3ShapeCastCapsule.

Shape cast versus compound. Initial overlap is treated as a miss.

Binds b3ShapeCastCompound.

Like shapeCastCompound, but the result is written into a caller-supplied buffer.

Shape cast versus a hull. Initial overlap is treated as a miss.

Binds b3ShapeCastHull.

Like shapeCastHull, but the result is written into a caller-supplied buffer.

Shape cast versus a mesh. Initial overlap is treated as a miss.

Binds b3ShapeCastMesh.

Like shapeCastMesh, but the result is written into a caller-supplied buffer.

Shape cast versus a height field. Initial overlap is treated as a miss.

Binds b3ShapeCastHeightField.

Like shapeCastHeightField, but the result is written into a caller-supplied buffer.

Query a mesh for triangles overlapping a bounding box in local space. May have false positives. Useful for debug draw.

Binds b3QueryMesh.

Query a height field for triangles overlapping a bounding box in local space. May have false positives. Useful for debug draw.

Binds b3QueryHeightField.

Compute the closest points between two shapes represented as point clouds. b3SimplexCache cache is input/output. On the first call set b3SimplexCache.count to zero. The query runs in frame A, so the witness points and normal are returned in frame A. The underlying GJK algorithm may be debugged by passing in debug simplexes and capacity. You may pass in NULL and 0 for these.

Binds b3ShapeDistance.

Perform a linear shape cast of shape B moving and shape A fixed. Determines the hit point, normal, and translation fraction. The query runs in frame A, so the hit point and normal are returned in frame A. Initially touching shapes are a miss.

Binds b3ShapeCast.

Like shapeCast, but the result is written into a caller-supplied buffer.

Evaluate the transform sweep at a specific time.

Binds b3GetSweepTransform.

Compute the upper bound on time before two shapes penetrate. Time is represented as a fraction between \[0,tMax\]. This uses a swept separating axis and may miss some intermediate, non-tunneling collisions. If you change the time interval, you should call this function again.

Binds b3TimeOfImpact.

Collide two spheres.

Binds b3CollideSpheres.

Collide a capsule and a sphere.

Binds b3CollideCapsuleAndSphere.

Collide a hull and a sphere.

Binds b3CollideHullAndSphere.

Collide two capsules.

Binds b3CollideCapsules.

Collide a hull and a capsule.

Binds b3CollideHullAndCapsule.

Collide two hulls.

Binds b3CollideHulls.

Collide a capsule and a triangle.

Binds b3CollideCapsuleAndTriangle.

Collide a hull and a triangle.

Binds b3CollideHullAndTriangle.

Collide a sphere and a triangle.

Binds b3CollideSphereAndTriangle.

Solves the position of a mover that satisfies the given collision planes.

Binds b3SolvePlanes.

Clips the velocity against the given collision planes. Planes with zero push or clipVelocity set to false are skipped.

Binds b3ClipVector.