IDirectManipulationViewport::SetUpdateMode method

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

Syntax


HRESULT SetUpdateMode(
  [in]  DIRECTMANIPULATION_INPUT_MODE mode
);

Parameters

mode [in]

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, has the same effect as calling SetViewportOptions(DIRECTMANIPULATION_VIEWPORT_OPTIONS_INPUT).

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

DirectManipulation.h

IDL

DirectManipulation.idl

IID

IID_IDirectManipulationViewport is defined as 28b85a3d-60a0-48bd-9ba1-5ce8d9ea3a6d

See also

IDirectManipulationViewport

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.