BitmapFrame Class

Reference

Definition

Namespace:: Windows.Graphics.Imaging

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.

Edit

Provides read access to data within a single frame.

public ref class BitmapFrame sealed : IBitmapFrameWithSoftwareBitmap

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class BitmapFrame final : IBitmapFrameWithSoftwareBitmap

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class BitmapFrame : IBitmapFrameWithSoftwareBitmap

Public NotInheritable Class BitmapFrame
Implements IBitmapFrameWithSoftwareBitmap

Inheritance: Object Platform::Object IInspectable BitmapFrame

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Implements: IBitmapFrame IBitmapFrameWithSoftwareBitmap

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Properties

BitmapAlphaMode	The default alpha mode of the frame.
BitmapPixelFormat	The pixel format that best fits the frame.
BitmapProperties	A read-only view of the metadata within the frame.
DpiX	The horizontal resolution of the frame in dots per inch.
DpiY	The vertical resolution of the frame in dots per inch.
OrientedPixelHeight	The height of the frame in pixels, after any EXIF orientation has been applied to the bitmap.
OrientedPixelWidth	The width of the frame in pixels, after any EXIF orientation has been applied to the bitmap.
PixelHeight	The height of the frame in pixels.
PixelWidth	The width of the frame in pixels.

Methods

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)	Asynchronously requests the pixel data for the frame using the specified parameters.
GetSoftwareBitmapAsync()	Asynchronously gets a SoftwareBitmap representation of the bitmap frame.
GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)	Asynchronously gets a SoftwareBitmap representation of the bitmap frame.
GetSoftwareBitmapAsync(BitmapPixelFormat, BitmapAlphaMode)	Asynchronously gets a SoftwareBitmap representation of the bitmap frame.
GetThumbnailAsync()	Asynchronously returns a stream containing the thumbnail image.

Applies to

Share via