Click or drag to resize
CanvasImageSaveAsync Method (ICanvasImage, Rect, Single, ICanvasResourceCreator, IRandomAccessStream, CanvasBitmapFileFormat, Single)
Saves an ICanvasImage to the given stream.

Namespace:  Microsoft.Graphics.Canvas
Assembly:  Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0
Syntax
C#
Copy
public static IAsyncAction SaveAsync(
	ICanvasImage image,
	Rect sourceRectangle,
	float dpi,
	ICanvasResourceCreator resourceCreator,
	IRandomAccessStream stream,
	CanvasBitmapFileFormat fileFormat,
	float quality
)

Parameters

image
Type: Microsoft.Graphics.CanvasICanvasImage
sourceRectangle
Type: Windows.FoundationRect
dpi
Type: SystemSingle
resourceCreator
Type: Microsoft.Graphics.CanvasICanvasResourceCreator
stream
Type: Windows.Storage.StreamsIRandomAccessStream
fileFormat
Type: Microsoft.Graphics.CanvasCanvasBitmapFileFormat
quality
Type: SystemSingle

Return Value

Type: IAsyncAction
Remarks

This method saves the given image. The image can be any size, memory or output file format permitting, and is not restricted by the value of CanvasDevice.MaximumBitmapSizeInPixels.

The ICanvasImage may need to be drawn to a render target before it can be saved - for example, it may be an effect or a command list. SaveAsync will take care of this automatically and create whatever temporary render targets are required.

The quality parameter defaults to 0.9, and only applies to the Jpeg and JpegXR formats.

To save an image using a high dynamic range (HDR) pixel format, use SaveAsync(ICanvasImage, Rect, Single, ICanvasResourceCreator, IRandomAccessStream, CanvasBitmapFileFormat, Single, CanvasBufferPrecision) with JpegXR format and a suitable CanvasBufferPrecision.

See Also