BitmapDecoder class

Expand
0 out of 1 rated this helpful - Rate this topic

BitmapDecoder class

[This documentation is preliminary and is subject to change.]

Applies to: Metro style apps only

Provides read access to bitmap container data as well as data from the first frame.

Syntax


var bitmapDecoder = Windows.Graphics.Imaging.BitmapDecoder;

Attributes

MarshalingBehaviorAttribute(Agile)
StaticAttribute(Windows.Graphics.Imaging.IBitmapDecoderStatics, NTDDI_WIN8)
VersionAttribute(NTDDI_WIN8)

Members

The BitmapDecoder class has these types of members:

Methods

The BitmapDecoder class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
CreateAsync(Guid, IRandomAccessStream) Asynchronously creates a new BitmapDecoder using a specific bitmap codec and initializes it using a stream.
CreateAsync(IRandomAccessStream) Asynchronously creates a new BitmapDecoder and initializes it using a stream.
GetDecoderInformationEnumerator Enumerates the bitmap decoders installed on the system and provides information about them.
GetFrameAsync Asynchronously retrieves a frame from the image file.
GetPixelDataAsync() Asynchronously requests the pixel data for the frame.
GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode) Asynchronously requests the pixel data for the frame using the specified parameters.
GetPreviewAsync Asynchronously retrieves the container preview.
GetThumbnailAsync Asynchronously retrieves the thumbnail for the frame.

 

Properties

The BitmapDecoder class has these properties.

PropertyAccess typeDescription

BitmapAlphaMode

Read-onlyReturns the default alpha mode of the first frame.

BitmapContainerProperties

Read-onlyProvides access to the container bitmap properties.

BitmapPixelFormat

Read-onlyReturns the default pixel format of the first frame.

BitmapProperties

Read-onlyReturns a read-only view of the metadata within the first frame.

BmpDecoderId

Read-onlyReturns the CLSID of the built-in BMP decoder.

DecoderInformation

Read-onlyReturns information about the bitmap decoder.

DpiX

Read-onlyReturns the horizontal resolution of the first frame in dots per inch.

DpiY

Read-onlyReturns the vertical resolution of the first frame in dots per inch.

FrameCount

Read-onlyReturns the number of frames within the image file.

GifDecoderId

Read-onlyReturns the CLSID of the built-in GIF decoder.

IcoDecoderId

Read-onlyReturns the CLSID of the built-in ICO decoder.

JpegDecoderId

Read-onlyReturns the CLSID of the built-in JPEG decoder.

JpegXRDecoderId

Read-onlyReturns the CLSID of the built-in JPEG-XR decoder.

OrientedPixelHeight

Read-onlyReturns the height of the first frame in pixels, after any EXIF orientation has been applied to the bitmap.

OrientedPixelWidth

Read-onlyReturns the width of the first frame in pixels, after any EXIF orientation has been applied to the bitmap.

PixelHeight

Read-onlyReturns the height of the first frame in pixels.

PixelWidth

Read-onlyReturns the width of the first frame in pixels.

PngDecoderId

Read-onlyReturns the CLSID of the built-in PNG decoder.

TiffDecoderId

Read-onlyReturns the CLSID of the built-in TIFF decoder.

 

Remarks

The BitmapDecoder class implements IBitmapFrame. It provides access to container data as well as data from the first frame. This allows applications to accomplish most common scenarios without needing to instantiate a separate BitmapFrame.

Requirements

Minimum supported client

Windows 8 Release Preview

Minimum supported server

Windows Server 2012

Namespace

Windows.Graphics.Imaging
Windows::Graphics::Imaging [C++]

Metadata

Windows.winmd

 

 

Build date: 5/22/2012

Did you find this helpful?
(1500 characters remaining)
Community Additions ADD