Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

Snapshot

struct in Unity.U2D.Physics

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

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.

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.

Public Methods

Method Description
Dispose Release the native memory held by this snapshot.