XGetMotionEvents

Syntax

XTimeCoord *XGetMotionEvents(display, w, start, stop, nevents_return)
      Display *display;
      Window w;
      Time start, stop;	
      int *nevents_return;

Arguments

display Specifies the connection to the X server.
w Specifies the window.
start
stop 		Specify the time interval in which the events are returned from the motion history buffer. You can pass a timestamp or CurrentTime.
nevents_return Returns the number of events from the motion history buffer.

Description

The XGetMotionEvents() function returns all events in the motion history buffer that fall between the specified start and stop times, inclusive, and that have coordinates that lie within the specified window (including its borders) at its present placement. If the server does not support motion history, if the start time is later than the stop time, or if the start time is in the future, no events are returned; XGetMotionEvents() returns NULL. If the stop time is in the future, it is equivalent to specifying CurrentTime . The return type for this function is a structure defined as follows: 


typedef struct {
	Time time;
	short x, y;
} XTimeCoord;

The time member is set to the time, in milliseconds. The x and y members are set to the coordinates of the pointer and are reported relative to the origin of the specified window. To free the data returned from this call, use XFree().

XGetMotionEvents() can generate a BadWindow error.

Diagnostics

BadWindow A value for a Window argument does not name a defined Window.

See also

XDisplayMotionBufferSize(), XIfEvent(), XNextEvent(), XPutBackEvent(), XSendEvent(), "Getting Pointer Motion History".
Christophe Tronche, ch@tronche.com