SKImage.ReadPixels Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ReadPixels(SKImageInfo, IntPtr, Int32, Int32, Int32, SKImageCachingHint) |
Copies the pixels from the image into the specified buffer. |
| ReadPixels(SKPixmap, Int32, Int32, SKImageCachingHint) |
Copies the pixels from the image into the specified buffer. |
| ReadPixels(SKPixmap, Int32, Int32) |
Copies the pixels from the image into the specified buffer. |
| ReadPixels(SKImageInfo, IntPtr, Int32, Int32, Int32) |
Copies the pixels from the image into the specified buffer. |
| ReadPixels(SKImageInfo, IntPtr) | |
| ReadPixels(SKPixmap) | |
| ReadPixels(SKImageInfo, IntPtr, Int32) |
ReadPixels(SKImageInfo, IntPtr, Int32, Int32, Int32, SKImageCachingHint)
Copies the pixels from the image into the specified buffer.
public bool ReadPixels (SkiaSharp.SKImageInfo dstInfo, IntPtr dstPixels, int dstRowBytes, int srcX, int srcY, SkiaSharp.SKImageCachingHint cachingHint);Parameters
- dstInfo
- SKImageInfo
The image information describing the destination pixel buffer.
- dstPixels
- IntPtr
The pixel buffer to read the pixel data into.
- dstRowBytes
- Int32
The number of bytes in each row of in the destination buffer.
- srcX
- Int32
The source x-coordinate to start reading from.
- srcY
- Int32
The source y-coordinate to start reading from.
- cachingHint
- SKImageCachingHint
Whether or not to cache intermediate results.
Returns
Returns true if the pixels were read, or false if there was an error.
Remarks
This method may return false if the source rectangle [srcX, srcY, dstInfo.Width, dstInfo.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types.
Applies to
ReadPixels(SKPixmap, Int32, Int32, SKImageCachingHint)
Copies the pixels from the image into the specified buffer.
public bool ReadPixels (SkiaSharp.SKPixmap pixmap, int srcX, int srcY, SkiaSharp.SKImageCachingHint cachingHint);Parameters
- pixmap
- SKPixmap
The pixmap to read the pixel data into.
- srcX
- Int32
The source x-coordinate to start reading from.
- srcY
- Int32
The source y-coordinate to start reading from.
- cachingHint
- SKImageCachingHint
Whether or not to cache intermediate results.
Returns
Returns true if the pixels were read, or false if there was an error.
Remarks
This method may return false if the source rectangle [srcX, srcY, dst.Info.Width, dst.Info.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types.
Applies to
ReadPixels(SKPixmap, Int32, Int32)
Copies the pixels from the image into the specified buffer.
public bool ReadPixels (SkiaSharp.SKPixmap pixmap, int srcX, int srcY);Parameters
- pixmap
- SKPixmap
The pixmap to read the pixel data into.
- srcX
- Int32
The source x-coordinate to start reading from.
- srcY
- Int32
The source y-coordinate to start reading from.
Returns
Returns true if the pixels were read, or false if there was an error.
Remarks
This method may return false if the source rectangle [srcX, srcY, dst.Info.Width, dst.Info.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types.
Applies to
ReadPixels(SKImageInfo, IntPtr, Int32, Int32, Int32)
Copies the pixels from the image into the specified buffer.
public bool ReadPixels (SkiaSharp.SKImageInfo dstInfo, IntPtr dstPixels, int dstRowBytes, int srcX, int srcY);Parameters
- dstInfo
- SKImageInfo
The image information describing the destination pixel buffer.
- dstPixels
- IntPtr
The pixel buffer to read the pixel data into.
- dstRowBytes
- Int32
The number of bytes in each row of in the destination buffer.
- srcX
- Int32
The source x-coordinate to start reading from.
- srcY
- Int32
The source y-coordinate to start reading from.
Returns
Returns true if the pixels were read, or false if there was an error.
Remarks
This method may return false if the source rectangle [srcX, srcY, dstInfo.Width, dstInfo.Height] does not intersect the image, or if the color type/alpha type could not be converted to the destination types.
Applies to
ReadPixels(SKImageInfo, IntPtr)
public bool ReadPixels (SkiaSharp.SKImageInfo dstInfo, IntPtr dstPixels);Parameters
- dstInfo
- SKImageInfo
- dstPixels
- IntPtr
Returns
Applies to
ReadPixels(SKPixmap)
ReadPixels(SKImageInfo, IntPtr, Int32)
public bool ReadPixels (SkiaSharp.SKImageInfo dstInfo, IntPtr dstPixels, int dstRowBytes);Parameters
- dstInfo
- SKImageInfo
- dstPixels
- IntPtr
- dstRowBytes
- Int32
Returns
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for