InkSynchronizer.BeginDry Method

Definition

Namespace:

Windows.UI.Input.Inking

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.

See also

• Pen and stylus interactions
• Get started: Support ink in your UWP app
• Ink analysis sample (basic) (C#)
• Ink handwriting recognition sample (C#)
• Save and load ink strokes from an Ink Serialized Format (ISF) file
• Save and load ink strokes from the clipboard
• Ink toolbar location and orientation sample (basic)
• Ink toolbar location and orientation sample (dynamic)
• Coloring book sample
• Family notes sample
• Inking sample (JavaScript)
• Simple inking sample (C#/C++)
• Complex inking sample (C++)
• Ink analysis sample