Browse Source

Updated docs on DangerousGetPinnableReferenceToPixelBuffer()

af/merge-core
Anton Firsov 9 years ago
committed by GitHub
parent
commit
356b8c3897
  1. 10
      src/ImageSharp/Advanced/ImageExtensions.cs

10
src/ImageSharp/Advanced/ImageExtensions.cs

@ -13,8 +13,9 @@ namespace SixLabors.ImageSharp.Advanced
public static class ImageExtensions public static class ImageExtensions
{ {
/// <summary> /// <summary>
/// Returns a reference to the 0th element of the Pixel buffer. /// Returns a reference to the 0th element of the Pixel buffer,
/// Such a reference can be used for pinning but must never be dereferenced. /// 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.
/// </summary> /// </summary>
/// <typeparam name="TPixel">The Pixel format.</typeparam> /// <typeparam name="TPixel">The Pixel format.</typeparam>
/// <param name="source">The source image frame</param> /// <param name="source">The source image frame</param>
@ -24,8 +25,9 @@ namespace SixLabors.ImageSharp.Advanced
=> ref DangerousGetPinnableReferenceToPixelBuffer((IPixelSource<TPixel>)source); => ref DangerousGetPinnableReferenceToPixelBuffer((IPixelSource<TPixel>)source);
/// <summary> /// <summary>
/// Returns a reference to the 0th element of the Pixel buffer. /// Returns a reference to the 0th element of the Pixel buffer,
/// Such a reference can be used for pinning but must never be dereferenced. /// 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.
/// </summary> /// </summary>
/// <typeparam name="TPixel">The Pixel format.</typeparam> /// <typeparam name="TPixel">The Pixel format.</typeparam>
/// <param name="source">The source image</param> /// <param name="source">The source image</param>

Loading…
Cancel
Save