→ index of namespace default
 
→ index of project tksdl
 
→ index of module tksdl

Class tksdl.Mouse

Synopsis: Static wrapper class for the Mouse device

  Base classes:
  Methods:
Method getButtons
Get current button mask
Signature
getButtons():int
Returns
int–

 
→ top of page
Method getChangedButtons
Query changed button mask
Signature
getChangedButtons()

 
→ top of page
Method getDx
Get relative horizontal mouse position
Signature
getDx():int
Returns
int–

 
→ top of page
Method getDy
Get relative vertical mouse position
Signature
getDy()

 
→ top of page
Method getPointerMode
Query current mouse pointer autohide mode.
Signature
getPointerMode():int
Returns
int–

 
→ top of page
Method getX
Get absolute horizontal mouse position
Signature
getX():int
Returns
int–

 
→ top of page
Method getY
Get absolute vertical mouse position
Signature
getY():int
Returns
int–

 
→ top of page
Method grab
Grab mouse
Signature
grab()

 
→ top of page
Method isGrabbed
Query whether the mouse is currently grabbed
Signature
isGrabbed():boolean
Returns
boolean–

 
→ top of page
Method setPointerMode
Set autohide pointer mode.
Signature
setPointerMode(intmode)
Arguments
intmode–One of MOUSE_POINTER_ENTER, MOUSE_POINTER_MOVE or MOUSE_POINTER_MANUAL

 
→ top of page
Method showPointer
Show/hide the mouse pointer
Signature
showPointer(booleanbVisible)
Arguments
booleanbVisible–

 
→ top of page
Method toggleGrab
Toggle mouse grab
Signature
toggleGrab()

 
→ top of page
Method ungrab
Ungrab mouse
Signature
ungrab()

 
→ top of page
Method unproject
Unproject mouse position and return near/far vectors
Signature
unproject(ObjectnearRet,
  ObjectfarRet 
  )  
Arguments
ObjectnearRet–Receives the near vector. Must be able to hold at least 3 array elements.
ObjectfarRet–Receives the far vector. Must be able to hold at least 3 array elements.

 
→ top of page
Method warpTo
Move mouse cursor to specified window coordinates
Signature
warpTo(intx,
  inty 
  )  
Arguments
intx–
inty–

 
→ top of page
 
Project Modules:tksdl 
Project Classes:AudioDevice , AudioSample , Cursor , FPS , Joystick , Key , Mouse , SamplePlayer , SDL , Viewport 
Project Functions:MIDINoteToFrequency 
All Namespaces:default , graph , ui 
All Projects:core , eqxmms , ShaderVG , ShaderVG_Text , tkanalogrytm , tkchipmunk , tkclap , tkfileutils , tkfreeglut , tkfreetype2 , tkfreeverb , tkmath , tkmidi , tkmidipipe , tkminnie , tkoldmath , tkopengl , tkportaudio , tkradiastools , tksamplechain , tksampleedit , tksampler , tksdl , tksdl_net , tksidplay2 , tkspeexdsp , tksqlite , tktriangulate , tkui , tkvst2 , tkzip , ui , yingtest 

auto-generated by "DOG", the TkScript document generator. Thu, 11/Dec/2025 13:42:00