CanvasImage.SaveAsync Method (ICanvasImage, Rect, Single, ICanvasResourceCreator, IRandomAccessStream, CanvasBitmapFileFormat, Single, CanvasBufferPrecision)

CanvasImageSaveAsync Method (ICanvasImage, Rect, Single, ICanvasResourceCreator, IRandomAccessStream, CanvasBitmapFileFormat, Single, CanvasBufferPrecision)

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

Copy

public static IAsyncAction SaveAsync(
	ICanvasImage image,
	Rect sourceRectangle,
	float dpi,
	ICanvasResourceCreator resourceCreator,
	IRandomAccessStream stream,
	CanvasBitmapFileFormat fileFormat,
	float quality,
	CanvasBufferPrecision bufferPrecision
)

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
bufferPrecision: Type: Microsoft.Graphics.CanvasCanvasBufferPrecision

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.

The buffer precision defaults to Precision8UIntNormalized.

To save an image using a high dynamic range (HDR) pixel format, use JpegXR format and specify one of the buffer precisions:

Reference

CanvasImage Class

SaveAsync Overload

Microsoft.Graphics.Canvas Namespace