From e83db97a2fb11a0951e9b6257e38b71aaa60e390 Mon Sep 17 00:00:00 2001
From: Dipesh Kumar <85861525+dipeshmsft@users.noreply.github.com>
Date: Thu, 23 Dec 2021 20:47:42 +0530
Subject: [PATCH] Updated sourceBufferStride's documentation (#5863)

---
 .../Windows/Media/Imaging/WriteableBitmap.cs      | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/src/Microsoft.DotNet.Wpf/src/PresentationCore/System/Windows/Media/Imaging/WriteableBitmap.cs b/src/Microsoft.DotNet.Wpf/src/PresentationCore/System/Windows/Media/Imaging/WriteableBitmap.cs
index 3bc0e4ff4..7f8416ceb 100644
--- a/src/Microsoft.DotNet.Wpf/src/PresentationCore/System/Windows/Media/Imaging/WriteableBitmap.cs
+++ b/src/Microsoft.DotNet.Wpf/src/PresentationCore/System/Windows/Media/Imaging/WriteableBitmap.cs
@@ -352,7 +352,10 @@ public void Unlock()
         /// <param name="sourceRect">The rect to copy from the input buffer.</param>
         /// <param name="sourceBuffer">The input buffer used to update the bitmap.</param>
         /// <param name="sourceBufferSize">The size of the input buffer in bytes.</param>
-        /// <param name="sourceBufferStride">The stride of the input buffer in bytes.</param>
+        /// <param name="sourceBufferStride">
+        ///     The stride of the input buffer in bytes.
+        ///     It indicates where the next row starts in the input buffer.
+        /// </param>
         /// <param name="destinationX">The destination x-coordinate of the left-most pixel to copy.</param>
         /// <param name="destinationY">The destination y-coordinate of the top-most pixel to copy.</param>
         public void WritePixels(
@@ -380,7 +383,10 @@ int       destinationY
         /// </summary>
         /// <param name="sourceRect">The rect to copy from the input buffer.</param>
         /// <param name="sourceBuffer">The input buffer used to update the bitmap.</param>
-        /// <param name="sourceBufferStride">The stride of the input buffer in bytes.</param>
+        /// <param name="sourceBufferStride">
+        ///     The stride of the input buffer in bytes.
+        ///     It indicates where the next row starts in the input buffer.
+        /// </param>
         /// <param name="destinationX">The destination x-coordinate of the left-most pixel to copy.</param>
         /// <param name="destinationY">The destination y-coordinate of the top-most pixel to copy.</param>
         public void WritePixels(
@@ -436,7 +442,7 @@ int       destinationY
         /// <param name="sourceRect">Area to update</param>
         /// <param name="buffer">Input buffer</param>
         /// <param name="bufferSize">Size of the buffer</param>
-        /// <param name="stride">Stride</param>
+        /// <param name="stride">Stride of the input buffer</param>
         public unsafe void WritePixels(
             Int32Rect sourceRect,
             IntPtr buffer,
@@ -488,7 +494,7 @@ int stride
         /// </summary>
         /// <param name="sourceRect">Area to update</param>
         /// <param name="pixels">Input buffer</param>
-        /// <param name="stride">Stride</param>
+        /// <param name="stride">Stride of the input buffer</param>
         /// <param name="offset">Input buffer offset</param>
         public void WritePixels(
             Int32Rect sourceRect,
@@ -814,6 +820,7 @@ out _pDoubleBufferedBitmap
         /// </param>
         /// <param name="sourceBufferStride">
         ///     The stride of the input buffer in bytes.
+        ///     It indicates where the next row starts in the input buffer.
         /// </param>
         /// <param name="destX">
         ///     The destination x-coordinate of the left-most pixel to copy.
-- 
GitLab