Browse Source

Added warning that we serialize a binary string

See #1647
Jorrit Rouwe 2 months ago
parent
commit
d1d7d228e3
1 changed files with 1 additions and 0 deletions
  1. 1 0
      Docs/Architecture.md

+ 1 - 0
Docs/Architecture.md

@@ -160,6 +160,7 @@ An example of saving a shape in binary format:
 	JPH::Ref<Shape> sphere = new JPH::SphereShape(1.0f);
 	JPH::Ref<Shape> sphere = new JPH::SphereShape(1.0f);
 
 
 	// For this example we'll be saving the shape in a STL string stream, but if you implement StreamOut you don't have to use STL.
 	// For this example we'll be saving the shape in a STL string stream, but if you implement StreamOut you don't have to use STL.
+	// Note that this will be storing a binary string of bytes that can contain 0-bytes, it is not an ASCII string!
 	stringstream data;
 	stringstream data;
 	JPH::StreamOutWrapper stream_out(data);
 	JPH::StreamOutWrapper stream_out(data);