Browse Source

Document that PoolRealArray stores 32-bit floats

This closes #45230.
Hugo Locurcio 4 years ago
parent
commit
e2c13c00f7
1 changed files with 2 additions and 1 deletions
  1. 2 1
      doc/classes/PoolRealArray.xml

+ 2 - 1
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>