SKCodec.GetPixels Method

Definition

Overloads

GetPixels(SKImageInfo, IntPtr, Int32, SKCodecOptions, IntPtr, Int32)

Decode the bitmap into the specified memory block.

GetPixels(SKImageInfo, IntPtr, Int32, SKCodecOptions, SKColorTable, Int32)

Decode the bitmap into the specified memory block.

GetPixels(SKImageInfo, IntPtr, SKCodecOptions, IntPtr, Int32)

Decode the bitmap into the specified memory block.

GetPixels(SKImageInfo, IntPtr, IntPtr, Int32)

Decode the bitmap into the specified memory block.

GetPixels(SKImageInfo, IntPtr, Int32, SKCodecOptions)

Decode the bitmap into the specified memory block.

GetPixels(SKImageInfo, IntPtr, SKCodecOptions, SKColorTable, Int32)

Decode the bitmap into the specified memory block.

GetPixels(SKImageInfo, IntPtr, SKCodecOptions)

Decode the bitmap into the specified memory block.

GetPixels(SKImageInfo, IntPtr)

Decode the bitmap into the specified memory block.

GetPixels(SKImageInfo, IntPtr, SKColorTable, Int32)

Developers should not use this obsolete method.

GetPixels(SKImageInfo, Byte[])

Decode the bitmap into the specified memory block.

GetPixels(SKImageInfo, Byte[])

Decode the bitmap into the specified memory block.

GetPixels(Byte[])

Decode the bitmap into the specified memory block.

GetPixels(SKImageInfo, IntPtr, Int32, SKCodecOptions, IntPtr, Int32)

Warning

This API is now obsolete.

Decode the bitmap into the specified memory block.

[System.Obsolete("The Index8 color type and color table is no longer supported. Use GetPixels(SKImageInfo, IntPtr, int, SKCodecOptions) instead.")]
public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, IntPtr pixels, int rowBytes, SkiaSharp.SKCodecOptions options, IntPtr colorTable, ref int colorTableCount);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
IntPtr

The memory block to hold the decoded bitmap, with a total size of at least BytesSize.

rowBytes
Int32

The number of bytes in a row, typically RowBytes.

options
SKCodecOptions

The bitmap decoding options.

colorTable
IntPtr

The pointer to the color table to hold the color entries, with a length of at least MaxLength (256).

colorTableCount
Int32

The logical number of color table entries.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(SKImageInfo, IntPtr, Int32, SKCodecOptions, SKColorTable, Int32)

Warning

This API is now obsolete.

Decode the bitmap into the specified memory block.

[System.Obsolete("The Index8 color type and color table is no longer supported. Use GetPixels(SKImageInfo, IntPtr, int, SKCodecOptions) instead.")]
public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, IntPtr pixels, int rowBytes, SkiaSharp.SKCodecOptions options, SkiaSharp.SKColorTable colorTable, ref int colorTableCount);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
IntPtr

The memory block to hold the decoded bitmap, with a total size of at least BytesSize.

rowBytes
Int32

The number of bytes in a row, typically RowBytes.

options
SKCodecOptions

The bitmap decoding options.

colorTable
SKColorTable

The color table to hold the color entries.

colorTableCount
Int32

The logical number of color table entries.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(SKImageInfo, IntPtr, SKCodecOptions, IntPtr, Int32)

Warning

This API is now obsolete.

Decode the bitmap into the specified memory block.

[System.Obsolete("The Index8 color type and color table is no longer supported. Use GetPixels(SKImageInfo, IntPtr, SKCodecOptions) instead.")]
public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, IntPtr pixels, SkiaSharp.SKCodecOptions options, IntPtr colorTable, ref int colorTableCount);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
IntPtr

The memory block to hold the decoded bitmap, with a total size of at least BytesSize.

options
SKCodecOptions

The bitmap decoding options.

colorTable
IntPtr

The pointer to the color table to hold the color entries, with a length of at least MaxLength (256).

colorTableCount
Int32

The logical number of color table entries.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(SKImageInfo, IntPtr, IntPtr, Int32)

Warning

This API is now obsolete.

Decode the bitmap into the specified memory block.

[System.Obsolete("The Index8 color type and color table is no longer supported. Use GetPixels(SKImageInfo, IntPtr) instead.")]
public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, IntPtr pixels, IntPtr colorTable, ref int colorTableCount);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
IntPtr

The memory block to hold the decoded bitmap, with a total size of at least BytesSize.

colorTable
IntPtr

The pointer to the color table to hold the color entries, with a length of at least MaxLength (256).

colorTableCount
Int32

The logical number of color table entries.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(SKImageInfo, IntPtr, Int32, SKCodecOptions)

Decode the bitmap into the specified memory block.

public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, IntPtr pixels, int rowBytes, SkiaSharp.SKCodecOptions options);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
IntPtr

The memory block to hold the decoded bitmap, with a total size of at least BytesSize.

rowBytes
Int32

The number of bytes in a row, typically RowBytes.

options
SKCodecOptions

The bitmap decoding options.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(SKImageInfo, IntPtr, SKCodecOptions, SKColorTable, Int32)

Warning

This API is now obsolete.

Decode the bitmap into the specified memory block.

[System.Obsolete("The Index8 color type and color table is no longer supported. Use GetPixels(SKImageInfo, IntPtr, SKCodecOptions) instead.")]
public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, IntPtr pixels, SkiaSharp.SKCodecOptions options, SkiaSharp.SKColorTable colorTable, ref int colorTableCount);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
IntPtr

The memory block to hold the decoded bitmap, with a total size of at least BytesSize.

options
SKCodecOptions

The bitmap decoding options.

colorTable
SKColorTable

The color table to hold the color entries.

colorTableCount
Int32

The logical number of color table entries.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(SKImageInfo, IntPtr, SKCodecOptions)

Decode the bitmap into the specified memory block.

public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, IntPtr pixels, SkiaSharp.SKCodecOptions options);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
IntPtr

The memory block to hold the decoded bitmap, with a total size of at least BytesSize.

options
SKCodecOptions

The bitmap decoding options.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(SKImageInfo, IntPtr)

Decode the bitmap into the specified memory block.

public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, IntPtr pixels);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
IntPtr

The memory block to hold the decoded bitmap, with a total size of at least BytesSize.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(SKImageInfo, IntPtr, SKColorTable, Int32)

Warning

This API is now obsolete.

Developers should not use this obsolete method.

[System.Obsolete("The Index8 color type and color table is no longer supported. Use GetPixels(SKImageInfo, IntPtr) instead.")]
public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, IntPtr pixels, SkiaSharp.SKColorTable colorTable, ref int colorTableCount);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
IntPtr

The memory block to hold the decoded bitmap, with a total size of at least BytesSize.

colorTable
SKColorTable

The color table to hold the color entries.

colorTableCount
Int32

The logical number of color table entries.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(SKImageInfo, Byte[])

Decode the bitmap into the specified memory block.

public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, out byte[] pixels);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
Byte[]

The memory block with the decoded bitmap.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(SKImageInfo, Byte[])

Decode the bitmap into the specified memory block.

public SkiaSharp.SKCodecResult GetPixels (SkiaSharp.SKImageInfo info, byte[] pixels);

Parameters

info
SKImageInfo

The description of the desired output format expected by the caller.

pixels
Byte[]

The memory block to hold the decoded bitmap, with a length of at least BytesSize.

Returns

Returns Success on success, or another value explaining the type of failure.

Remarks

The specified SKImageInfo, can either be Info, or a new instance with a different configuration - which the codec may choose to ignore.

If the specified size is different from the size from Info, then the codec will attempt to scale the resulting bitmap. If the codec cannot perform this scale, this method will return InvalidScale.

GetPixels(Byte[])

Decode the bitmap into the specified memory block.

public SkiaSharp.SKCodecResult GetPixels (out byte[] pixels);

Parameters

pixels
Byte[]

The memory block with the decoded bitmap.

Returns

Returns Success on success, or another value explaining the type of failure.

Applies to