GetInertiaParameterInteractionContext function

Gets the inertia behavior of a manipulation (translation, rotation, scaling).

Syntax


HRESULT WINAPI GetInertiaParameterInteractionContext(
  _In_   HINTERACTIONCONTEXT interactionContext,
  _In_   INERTIA_PARAMETER inertiaParameter,
  _Out_  float *value
);

Parameters

interactionContext [in]

The handle of the interaction context.

inertiaParameter [in]

One of the constants from INERTIA_PARAMETER.

value [out]

The value of inertiaParameter. This value is one of the following:

  • The rate of deceleration, in radians/ms2.
  • For translation, the relative change in screen location, in HIMETRIC units.
  • For rotation, the relative change in angle of rotation, in radians
  • For scaling, the relative change in size, in HIMETRIC units.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Interactioncontext.h

Library

Ninput.lib

DLL

Ninput.dll

See also

Interaction Context Functions
HINTERACTIONCONTEXT
SetInertiaParameterInteractionContext

 

 

Community Additions

ADD
Show:
© 2014 Microsoft