PhysicsWorld.Snapshot
An opaque, point-in-time capture of a PhysicsWorld simulation state, produced by PhysicsWorld.CreateSnapshot. Restore it into the same world with PhysicsWorld.ApplySnapshot, or create a new world from it with PhysicsWorld.Create.
Read time 1 minuteLast updated 10 days ago
Definition
- Type: Struct
- Namespace: Unity.U2D.Physics
- Assembly: UnityEngine.PhysicsCore2DModule
- Implements: IDisposable
public struct PhysicsWorld.Snapshot : IDisposable
Remarks
A snapshot owns native memory and must be disposed after use. A snapshot is only valid for the same Unity build that produced it and is not a portable on-disk format.
Properties
Property | Description |
|---|---|
| IsCreated | Whether this snapshot holds a valid captured image. |
| Length | The size of the snapshot image in bytes. |
Methods
Method | Description |
|---|---|
| Dispose | Release the native memory held by this snapshot. |