IBitmapFrame.GetPixelDataAsync Method
Definition
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
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. |
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).
public:
IAsyncOperation<PixelDataProvider ^> ^ GetPixelDataAsync();
/// [Windows.Foundation.Metadata.Overload("GetPixelDataAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<PixelDataProvider> GetPixelDataAsync();
[Windows.Foundation.Metadata.Overload("GetPixelDataAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<PixelDataProvider> GetPixelDataAsync();
function getPixelDataAsync()
Public Function GetPixelDataAsync () As IAsyncOperation(Of PixelDataProvider)
Returns
Object that manages the asynchronous retrieval of the pixel data.
- Attributes
Remarks
An application should not assume that pixel data returned by this method uses any particular pixel format or alpha mode (i.e. Rgba8 with premultiplied alpha). Instead, it should always check the BitmapPixelFormat and BitmapAlphaMode properties and handle the data accordingly.
As a convenience, this method performs color management from the frame’s embedded color space (if it exists) to the sRGB color space. If there is no embedded color profile data, then no color management is performed. This method also attempts to read the EXIF orientation flag on the frame, and if it exists, will perform the necessary transformation to correctly orient the pixel data.
In order to retrieve the correct bitmap pixel width and height, the application should read the OrientedPixelWidth and OrientedPixelHeight properties, instead of the PixelWidth and PixelHeight properties.
This method is equivalent to calling the GetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode) method with the following arguments:
Argument | Value |
---|---|
*pixelFormat* | The value of the
See alsoApplies toGetPixelDataAsync(BitmapPixelFormat, BitmapAlphaMode, BitmapTransform, ExifOrientationMode, ColorManagementMode)Asynchronously requests the pixel data for the frame using the specified parameters.
Parameters
The specified pixel format.
The specified alpha mode.
The set of transformations to be applied to the frame.
Indicates whether the EXIF orientation flag should be ignored or respected.
Indicates whether the pixel data should be color managed to the sRGB color space. ReturnsObject that manages the asynchronous retrieval of the pixel data.
RemarksThis method should be used instead of GetPixelDataAsync if the application needs finer grained control over the pixel data array. See alsoApplies to |