Wiki Page Content

Differences between revisions 1 and 4 (spanning 3 versions)
Revision 1 as of 2010-03-23 16:47:47
Size: 1456
Editor: SheenaSmith
Comment: in progress
Revision 4 as of 2010-07-28 04:52:32
Size: 2943
Editor: SheenaSmith
Comment: update content - changeset 4568
Deletions are marked like this. Additions are marked like this.
Line 11: Line 11:
||Uint8||'''type'''||SDL_MOUSEMOTION|| ||Uint32||'''type'''||SDL_MOUSEMOTION||
Line 13: Line 13:
||Uint8||'''which'''||the mouse device index||
Line 15: Line 14:
||int||'''x'''||x coordinate, relative to window||
||int||'''y'''||y coordinate, relative to window||
||int||'''z'''||z coordinate, for future use||
||Uint8||'''padding1'''||||
||Uint8||'''padding2'''||||
||Uint8||'''padding3'''||||
||int||'''x'''||X coordinate, relative to window||
||int||'''y'''||Y coordinate, relative to window||
||int||'''xrel'''||the relative motion in the X direction||
||int||'''yrel'''||the relative motion in the Y direction||

<<Color2(green,I think the remainder of these are to be deleted but want to be sure first.)>>

||<style="color: #808080;">int||<style="color: #808080;">'''z'''||<style="color: #808080;">z coordinate, for future use||
Line 21: Line 28:
||int||'''rotation'''||for future use||
||int||'''tilt_x'''||for future use||
||int||'''tilt_y'''||for future use||
||int||'''field'''||description||
||int||'''field'''||description||
||int||'''field'''||description||
||<style="color: #808080;">int||<style="color: #808080;">'''rotation'''||<style="color: #808080;">for future use||
||<style="color: #808080;">int||<style="color: #808080;">'''tilt_x'''||<style="color: #808080;">for future use||
||<style="color: #808080;">int||<style="color: #808080;">'''tilt_y'''||<style="color: #808080;">for future use||
||int||'''cursor'''||the cursor being used in the event||
Line 35: Line 39:
''You can add useful comments here'' <<Color2(green,The following was taken from the old 1.2 wiki and may not be applicable to 1.3.)>>
Line 37: Line 41:
== Related Enumerations ==
 .[[SDL_EnumerationRemoveSectionIfEmpty]]
[[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]]()).
Line 40: Line 44:
== Related Structures ==
 .[[SDL_StructureRemoveSectionIfEmpty]]
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.

<<Color2(green,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?)>>
Line 44: Line 49:
 .[[SDL_FunctionLeaveSectionIfEmpty]]  .[[SDL_MouseButtonEvent]]

DRAFT

SDL_MouseMotionEvent

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

Data Fields

Uint32

type

SDL_MOUSEMOTION

Uint32

windowID

the window with mouse focus, if any

Uint8

state

the current button state

Uint8

padding1

Uint8

padding2

Uint8

padding3

int

x

X coordinate, relative to window

int

y

Y coordinate, relative to window

int

xrel

the relative motion in the X direction

int

yrel

the relative motion in the Y direction

green

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

Code Examples

You can add your code example here

Remarks

green

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.

green


CategoryStruct

None: SDL_MouseMotionEvent (last edited 2013-09-05 20:20:21 by PhilippWiesemann)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit