IDirectManipulationViewport::SetUpdateMode method (directmanipulation.h)

Specifies whether a viewport updates content manually instead of during an input event.

Syntax

HRESULT SetUpdateMode(
  [in] DIRECTMANIPULATION_INPUT_MODE mode
);

Parameters

[in] mode

One of the values from DIRECTMANIPULATION_INPUT_MODE.

Return value

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

DIRECTMANIPULATION_INPUT_MODE_AUTOMATIC is the default mode for Direct Manipulation. In this mode, visual updates are pushed to compositor driven by input. This is the expected mode of operation if the application is using system-provided implementation of IDirectManipulationCompositor.

If the application provides its own implementation of IDirectManipulationCompositor, it should switch viewport update mode to manual by setting DIRECTMANIPULATION_INPUT_MODE_MANUAL. When in manual mode, the compositor pulls visual updates whenever it calls Update on Direct Manipulation.

Calling this method with DIRECTMANIPULATION_INPUT_MODE_MANUAL set is similar to calling SetViewportOptions(DIRECTMANIPULATION_VIEWPORT_OPTIONS_INPUT). However, calling SetViewportOptions also overrides all other settings.

Requirements

See also

IDirectManipulationViewport