Table of Contents

Class BitmapFrameDecode

Namespace
SharpDX.WIC
Assembly
SharpDX.Direct2D1.dll
[Guid("3B16811B-6A43-4ec9-A813-3D930C13B940")]
public class BitmapFrameDecode : BitmapSource
Inheritance
BitmapFrameDecode
Derived
Inherited Members

Constructors

BitmapFrameDecode(nint) 

public BitmapFrameDecode(nint nativePtr)

Parameters

nativePtr nint

Properties

ColorContexts 

[Obsolete("Use TryGetColorContexts instead")]
public ColorContext[] ColorContexts { get; }

Property Value

ColorContext[]

MetadataQueryReader

Retrieves a metadata query reader for the frame.

public MetadataQueryReader MetadataQueryReader { get; }

Property Value

MetadataQueryReader

Remarks

For image formats with one frame (JPG, PNG, JPEG-XR), the frame-level query reader of the first frame is used to access all image metadata, and the decoder-level query reader isn?t used. For formats with more than one frame (GIF, TIFF), the frame-level query reader for a given frame is used to access metadata specific to that frame, and in the case of GIF a decoder-level metadata reader will be present. If the decoder doesn?t support metadata (BMP, ICO), this will return .

Thumbnail

Retrieves a small preview of the frame, if supported by the codec.

public BitmapSource Thumbnail { get; }

Property Value

BitmapSource

Remarks

Not all formats support thumbnails. Joint Photographic Experts Group (JPEG), Tagged Image File Format (TIFF), and Microsoft?Windows Digital Photo (WDP) support thumbnails.

Methods

TryGetColorContexts(ImagingFactory)

Get the ColorContext of the image (if any)

public ColorContext[] TryGetColorContexts(ImagingFactory imagingFactory)

Parameters

imagingFactory ImagingFactory

Returns

ColorContext[]

null if the decoder does not support color contexts; otherwise an array of zero or more ColorContext objects

TryGetColorContexts(ImagingFactory, out ColorContext[])

Get the ColorContext of the image (if any)

public Result TryGetColorContexts(ImagingFactory imagingFactory, out ColorContext[] colorContexts)

Parameters

imagingFactory ImagingFactory

The factory for creating new color contexts

colorContexts ColorContext[]

The color context array, or null

Returns

Result

Remarks

When the image format does not support color contexts, UnsupportedOperation is returned.

Operators

explicit operator BitmapFrameDecode(nint) 

public static explicit operator BitmapFrameDecode(nint nativePtr)

Parameters

nativePtr nint

Returns

BitmapFrameDecode