pages/SDL-Mouse.html-inc

   1 <div class="pod">
   2 <!-- INDEX START -->
   3 <h3 id="TOP">Index</h3>
   4
   5 <ul><li><a href="#NAME">NAME</a></li>
   6 <li><a href="#CATEGORY">CATEGORY</a></li>
   7 <li><a href="#METHODS">METHODS</a>
   8 <ul><li><a href="#warp_mouse">warp_mouse</a></li>
   9 <li><a href="#set_cursor">set_cursor</a></li>
  10 <li><a href="#get_cursor">get_cursor</a></li>
  11 <li><a href="#show_cursor">show_cursor</a>
  12 </li>
  13 </ul>
  14 </li>
  15 </ul><hr />
  16 <!-- INDEX END --><a href="assets/Mouse.png" target="_blank"><img src="assets/Mouse.png" style="height: 160px" alt="Mouse.png"/></a><hr />
  17
  18 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
  19 <div id="NAME_CONTENT">
  20 <p>SDL::Mouse -- SDL Bindings for the Mouse device</p>
  21
  22 </div>
  23 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
  24 <div id="CATEGORY_CONTENT">
  25 <p>Core, Mouse</p>
  26
  27 </div>
  28 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  29 <div id="METHODS_CONTENT">
  30
  31 </div>
  32 <h2 id="warp_mouse">warp_mouse</h2>
  33 <div id="warp_mouse_CONTENT">
  34 <pre> void warp_mouse( int $x, int $y );
  35
  36 </pre>
  37 <p>Set the position of the mouse cursor (generates a mouse motion event).</p>
  38
  39 </div>
  40 <h2 id="set_cursor">set_cursor</h2>
  41 <div id="set_cursor_CONTENT">
  42 <pre> void set_cursor( object );
  43
  44 </pre>
  45 <p>Sets the currently active cursor to the specified one. If the cursor is currently visible, the change will be immediately represented
  46 on the display. <code>set_cursor()</code> can be used to force cursor redraw, if this is desired for any reason. </p>
  47
  48 </div>
  49 <h2 id="get_cursor">get_cursor</h2>
  50 <div id="get_cursor_CONTENT">
  51 <pre> object get_cursor();
  52
  53 </pre>
  54 <p>Gets the currently active mouse cursor.</p>
  55
  56 </div>
  57 <h2 id="show_cursor">show_cursor</h2>
  58 <div id="show_cursor_CONTENT">
  59 <pre> int show_cursor( int toggle );
  60
  61 </pre>
  62 <p>Toggle whether or not the cursor is shown on the screen. Passing <code>SDL_ENABLE</code> displays the cursor and passing <code>SDL_DISABLE</code> hides it.
  63 The current state of the mouse cursor can be queried by passing <code>SDL_QUERY</code>, either <code>SDL_DISABLE</code> or <code>SDL_ENABLE</code> will be returned.</p>
  64 <pre> use SDL;
  65  use SDL::Mouse;
  66  use SDL::Video;
  67
  68  SDL::init(SDL_INIT_VIDEO);
  69  SDL::Video::set_video_mode( 640, 480, 16, SDL_SWSURFACE);
  70
  71  printf(&quot;Cursor is %s\n&quot;, SDL::Mouse::show_cursor(SDL_QUERY) ? 'visible' : 'not visible');
  72
  73  sleep(3);
  74
  75  SDL::Mouse::show_cursor(SDL_DISABLE);
  76  printf(&quot;Cursor is %s\n&quot;, SDL::Mouse::show_cursor(SDL_QUERY) ? 'visible' : 'not visible');
  77
  78  sleep(3);
  79
  80  SDL::Mouse::show_cursor(SDL_ENABLE);
  81  printf(&quot;Cursor is %s\n&quot;, SDL::Mouse::show_cursor(SDL_QUERY) ? 'visible' : 'not visible');
  82
  83  sleep(3);
  84
  85 </pre>
  86
  87 </div>
  88 </div>