DRAFT

SDL_MouseMotionEvent

A structure that contains mouse motion event structure information (event.motion.*).

Data Fields

Uint8

type

SDL_MOUSEMOTION

Uint32

windowID

the window with mouse focus, if any

Uint8

which

the mouse device index

Uint8

state

the current button state

int

x

x coordinate, relative to window

int

y

y coordinate, relative to window

int

z

z coordinate, for future use

int

pressure

pressure reported by tablets

int

pressure_max

maximum value of the pressure reported by the device

int

pressure_min

minimum value of the pressure reported by the device

int

rotation

for future use

int

tilt_x

for future use

int

tilt_y

for future use

int

cursor

the cursor being used in the event

int

xrel

the relative motion in the X direction

int

yrel

the relative motion in the Y direction

Code Examples

You can add your code example here

Remarks

The following was taken from the old 1.2 wiki and may not be applicable to 1.3.

SDL_MouseMotionEvent() is a member of the SDL_Event union and is used when an event of type SDL_MOUSEMOTION is reported.

  • Simply put, a SDL_MOUSEMOTION type event occurs when a user moves the mouse within the application window or when SDL_WarpMouse^InWindow^???() is called. Both the absolute (x and y) and relative (xrel and yrel) coordinates are reported along with the current button states (state). The button state can be interpreted using the SDL_BUTTON macro (see SDL_GetMouseState()).

If the cursor is hidden (SDL_ShowCursor(0)) and the input is grabbed (SDL_WM_GrabInput(SDL_GRAB_ON)), then the mouse will give relative motion events even when the cursor reaches the edge of the screen. This is currently only implemented on Windows and Linux/Unix-alikes.

There are currently no pages for SDL_WarpMouse or SDL_WM_GrabInput. Do they still exist in 1.3? Is SDL_WarpMouseInWindow the appropriate replacement for SDL_WarpMouse? If it is should it be listed in RFs also?


CategoryStruct

SDL_MouseMotionEvent (last edited 2010-06-29 06:21:57 by SheenaSmith)