Make it more clear in the documentation how the default value for Res…

…ourceLimits.Memory is set.
dlemstra · Oct 3, 2023 · 9485e3c · 9485e3c
1 parent f4db801
commit 9485e3c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/src/Magick.NET.Core/IResourceLimits.cs b/src/Magick.NET.Core/IResourceLimits.cs
@@ -37,7 +37,8 @@ public interface IResourceLimits
 
     /// <summary>
     /// Gets or sets the pixel cache limit in bytes. Once this memory limit is exceeded, all subsequent pixels cache
-    /// operations are to/from disk.
+    /// operations are to/from disk. The default value of this is 50% of the available memory on the machine in 64-bit mode.
+    /// When running in 32-bit mode this is 50% of the limit of the operating system.
     /// </summary>
     ulong Memory { get; set; }
 

diff --git a/src/Magick.NET/ResourceLimits.cs b/src/Magick.NET/ResourceLimits.cs
@@ -57,7 +57,8 @@ public static ulong MaxMemoryRequest
 
     /// <summary>
     /// Gets or sets the pixel cache limit in bytes. Once this memory limit is exceeded, all subsequent pixels cache
-    /// operations are to/from disk.
+    /// operations are to/from disk. The default value of this is 50% of the available memory on the machine in 64-bit mode.
+    /// When running in 32-bit mode this is 50% of the limit of the operating system.
     /// </summary>
     public static ulong Memory
     {
@@ -141,7 +142,8 @@ ulong IResourceLimits.MaxMemoryRequest
 
     /// <summary>
     /// Gets or sets the pixel cache limit in bytes. Once this memory limit is exceeded, all subsequent pixels cache
-    /// operations are to/from disk.
+    /// operations are to/from disk. The default value of this is 50% of the available memory on the machine in 64-bit mode.
+    /// When running in 32-bit mode this is 50% of the limit of the operating system.
     /// </summary>
     ulong IResourceLimits.Memory
     {