Merge pull request #45231 from Calinou/doc-poolrealarray-32-bit

Document that PoolRealArray stores 32-bit floats
godotengine · Jan 16, 2021 · 99fdf25 · 99fdf25
2 parents 51bcc87 + e2c13c0
commit 99fdf25
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml
@@ -4,8 +4,9 @@
 		A pooled [Array] of reals ([float]).
 	</brief_description>
 	<description>
-		An [Array] specifically designed to hold floating-point values ([float]). Optimized for memory usage, does not fragment the memory.
+		An [Array] specifically designed to hold floating-point values. Optimized for memory usage, does not fragment the memory.
 		[b]Note:[/b] This type is passed by value and not by reference.
+		[b]Note:[/b] Unlike primitive [float]s which are 64-bit, numbers stored in [PoolRealArray] are 32-bit floats. This means values stored in [PoolRealArray] have lower precision compared to primitive [float]s.
 	</description>
 	<tutorials>
 	</tutorials>