DXUTSetCallbackMouse

Sets the mouse event callback function.

VOID DXUTSetCallbackMouse(
  LPDXUTCALLBACKMOUSE pCallbackMouse,
  BOOL bIncludeMouseMove,
  void* pUserContext
);

Parameters

pCallbackMouse

[in] Pointer to an LPDXUTCALLBACKMOUSE mouse event callback function. If supplied, the callback function will be called for mouse events. If NULL, DXUT will not notify the application about mouse events.

bIncludeMouseMove

[in] If TRUE, the Windows WM_MOUSEMOVE message is passed to the pCallbackMouse callback function. Default value is FALSE.

pUserContext

[in] Pointer to a user-defined value which is passed to the callback function. Typically used by an application to pass a pointer to a data structure that provides context information for the callback function. The default value is NULL

Return Values

No return value.

Remarks

The pCallbackMouse mouse event callback function will be called when any one of the following mouse events occurs:

• WM_LBUTTONDBLCLK
• WM_LBUTTONDOWN
• WM_LBUTTONUP
• WM_MBUTTONDBLCLK
• WM_MBUTTONDOWN
• WM_MBUTTONUP
• WM_MOUSEWHEEL
• WM_RBUTTONDBLCLK
• WM_RBUTTONDOWN
• WM_RBUTTONUP
• WM_XBUTTONDBLCLK
• WM_XBUTTONDOWN
• WM_XBUTTONUP

This callback mechanism is provided to simplify handling mouse messages through the Windows message pump, but does not preclude the application from handling those messages directly through the Windows WindowProc callback function.

Requirements

Header: Declared in Dxut.h.

See Also

LPDXUTCALLBACKMOUSE, LPDXUTCALLBACKKEYBOARD, LPDXUTCALLBACKMSGPROC, DXUTSetCallbackKeyboard, DXUTSetCallbackMsgProc, WindowProc