SKCodec.GetPixels Method

Definition

Namespace:: SkiaSharp

Assembly:: SkiaSharp.dll

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

Name	Description
GetPixels(SKImageInfo, IntPtr, Int32, SKCodecOptions)	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, Byte[])	Decode the bitmap into the specified memory block.
GetPixels(Byte[])	Decode the bitmap into the specified memory block.
GetPixels(SKImageInfo, Byte[])	Decode the bitmap into the specified memory block.

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

SKCodecResult

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.

Applies to

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

SKCodecResult

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.

Applies to

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

SKCodecResult

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.

Applies to

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

SKCodecResult

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.

Applies to

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

SKCodecResult

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

Applies to

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

SKCodecResult

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.

Applies to

Feedback

Was this page helpful?