Edit

Share via

GetInertiaParameterInteractionContext function (interactioncontext.h)

  • Article

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

Syntax

HRESULT GetInertiaParameterInteractionContext(
  [in]  HINTERACTIONCONTEXT interactionContext,
  [in]  INERTIA_PARAMETER   inertiaParameter,
  [out] float               *value
);

Parameters

[in] interactionContext

The handle of the interaction context.

[in] inertiaParameter

One of the constants from INERTIA_PARAMETER enumeration.

[out] value

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

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header interactioncontext.h
Library Ninput.lib
DLL Ninput.dll

See also

SetInertiaParameterInteractionContext function