BitmapFrame BitmapFrame BitmapFrame BitmapFrame BitmapFrame Class

Definition

Provides read access to data within a single frame.

public : sealed class BitmapFrame : IBitmapFrame, IBitmapFrameWithSoftwareBitmap
struct winrt::Windows::Graphics::Imaging::BitmapFrame : IBitmapFrame, IBitmapFrameWithSoftwareBitmap
public sealed class BitmapFrame : IBitmapFrame, IBitmapFrameWithSoftwareBitmap
Public NotInheritable Class BitmapFrame Implements IBitmapFrame, IBitmapFrameWithSoftwareBitmap
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

BitmapAlphaMode BitmapAlphaMode BitmapAlphaMode BitmapAlphaMode BitmapAlphaMode

The default alpha mode of the frame.

BitmapPixelFormat BitmapPixelFormat BitmapPixelFormat BitmapPixelFormat BitmapPixelFormat

The pixel format that best fits the frame.

BitmapProperties BitmapProperties BitmapProperties BitmapProperties BitmapProperties

A read-only view of the metadata within the frame.

DpiX DpiX DpiX DpiX DpiX

The horizontal resolution of the frame in dots per inch.

DpiY DpiY DpiY DpiY DpiY

The vertical resolution of the frame in dots per inch.

OrientedPixelHeight OrientedPixelHeight OrientedPixelHeight OrientedPixelHeight OrientedPixelHeight

The height of the frame in pixels, after any EXIF orientation has been applied to the bitmap.

OrientedPixelWidth OrientedPixelWidth OrientedPixelWidth OrientedPixelWidth OrientedPixelWidth

The width of the frame in pixels, after any EXIF orientation has been applied to the bitmap.

PixelHeight PixelHeight PixelHeight PixelHeight PixelHeight

The height of the frame in pixels.

PixelWidth PixelWidth PixelWidth PixelWidth PixelWidth

The width of the frame in pixels.

Methods

GetPixelDataAsync() GetPixelDataAsync() GetPixelDataAsync() GetPixelDataAsync() GetPixelDataAsync()

Asynchronously requests the pixel data for the frame. The resulting pixel data array will use the bitmap pixel format and alpha mode specified in the BitmapPixelFormat and BitmapAlphaMode properties. It will also have color management and EXIF orientation applied (see the Remarks section for more information).

GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode) GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode) GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode) GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode) GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)

Asynchronously requests the pixel data for the frame using the specified parameters.

GetSoftwareBitmapAsync() GetSoftwareBitmapAsync() GetSoftwareBitmapAsync() GetSoftwareBitmapAsync() GetSoftwareBitmapAsync()

Asynchronously gets a SoftwareBitmap representation of the bitmap frame.

GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode) GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode) GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode) GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode) GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)

Asynchronously gets a SoftwareBitmap representation of the bitmap frame.

GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode) GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode) GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode) GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode) GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)

Asynchronously gets a SoftwareBitmap representation of the bitmap frame.

GetThumbnailAsync() GetThumbnailAsync() GetThumbnailAsync() GetThumbnailAsync() GetThumbnailAsync()

Asynchronously returns a stream containing the thumbnail image.