Share via

QueryPhysicsEngine (Compact 2013)

  • Article

3/28/2014

This function returns the state of the physics engine. If the engine mode is the default mode, the engine state is based on the current time indicated by the system clock. If the engine mode is PHYSICSENGINE_FLAG_USERTIME, then the engine state is based on the time specified in the most recent call to SetPhysicsEngineUserTime.

Syntax

HRESULT QueryPhysicsEngine(
    HPHYSICSENGINE hEngine,
   __out PHYSICSENGINESTATE* pState
);

Parameters

  • hEngine
    [in] A handle to a physics engine object.
  • pState
    [out] A pointer to a PHYSICSENGINESTATE structure that indicates the state of the physics engine.

Return Value

  • S_OK
    Indicates that the physics engine state is successfully returned.
  • E_INVALIDARG
    Indicates that a parameter is invalid.
  • E_UNEXPECTED
    Indicates that the physics engine object is not initialized.

Requirements

Header

physicsengine.h,
winuser.h

sysgen

SYSGEN_PHYSICSENGINE

See Also

Reference

Physics Engine Functions
PHYSICSENGINESTATE
Touch Gestures Physics Engine Reference