From 356b8c389722524bd72cbc4059415dbd70a04462 Mon Sep 17 00:00:00 2001 From: Anton Firsov Date: Sat, 16 Sep 2017 00:15:39 +0200 Subject: [PATCH] Updated docs on DangerousGetPinnableReferenceToPixelBuffer() --- src/ImageSharp/Advanced/ImageExtensions.cs | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/ImageSharp/Advanced/ImageExtensions.cs b/src/ImageSharp/Advanced/ImageExtensions.cs index aaff683123..8ab245aee7 100644 --- a/src/ImageSharp/Advanced/ImageExtensions.cs +++ b/src/ImageSharp/Advanced/ImageExtensions.cs @@ -13,8 +13,9 @@ namespace SixLabors.ImageSharp.Advanced public static class ImageExtensions { /// - /// Returns a reference to the 0th element of the Pixel buffer. - /// Such a reference can be used for pinning but must never be dereferenced. + /// Returns a reference to the 0th element of the Pixel buffer, + /// allowing direct manipulation of pixel data through unsafe operations. + /// The pixel buffer is a contigous memory area containing Width*Height TPixel elements layed out in row-major order. /// /// The Pixel format. /// The source image frame @@ -24,8 +25,9 @@ namespace SixLabors.ImageSharp.Advanced => ref DangerousGetPinnableReferenceToPixelBuffer((IPixelSource)source); /// - /// Returns a reference to the 0th element of the Pixel buffer. - /// Such a reference can be used for pinning but must never be dereferenced. + /// Returns a reference to the 0th element of the Pixel buffer, + /// allowing direct manipulation of pixel data through unsafe operations. + /// The pixel buffer is a contigous memory area containing Width*Height TPixel elements layed out in row-major order. /// /// The Pixel format. /// The source image