InkSynchronizer.BeginDry Method

Reference

Definition

Namespace:: Windows.UI.Input.Inking

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

Initiates a custom "dry" of ink input to the Direct2D device context of your app, instead of the default InkCanvas control. This requires an IInkD2DRenderer object to manage the ink input (see the Complex ink sample).

By default, ink input is processed on a low-latency background thread and rendered "wet" as it is drawn. When the stroke is completed (pen or finger lifted, or mouse button released), the stroke is processed on the UI thread and rendered "dry" to the InkCanvas layer (above the application content and replacing the wet ink).

By calling ActivateCustomDrying (before the InkCanvas is loaded), an app creates an InkSynchronizer object to customize how an ink stroke is rendered dry to a SurfaceImageSource or VirtualSurfaceImageSource. For example, an ink stroke could be rasterized and integrated into application content instead of as a separate InkCanvas layer.

public:
 virtual IVectorView<InkStroke ^> ^ BeginDry() = BeginDry;

IVectorView<InkStroke> BeginDry();

public IReadOnlyList<InkStroke> BeginDry();

function beginDry()

Public Function BeginDry () As IReadOnlyList(Of InkStroke)

Returns

IVectorView<InkStroke>

IReadOnlyList<InkStroke>

The collection of "wet" ink strokes to pass to the IInkD2DRenderer object .

Remarks

Error codes

E_ILLEGAL_METHOD_CALL (0x8000000E)

Thrown if BeginDry is called again, before EndDry is called.

Applies to

Jaa