File: HideCursor.m

package info (click to toggle)
psychtoolbox-3 3.0.19.14.dfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 86,796 kB
  • sloc: ansic: 176,245; cpp: 20,103; objc: 5,393; sh: 2,753; python: 1,397; php: 384; makefile: 193; java: 113
file content (47 lines) | stat: -rw-r--r-- 1,848 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
function HideCursor(screenid, mouseid)
% HideCursor([screenidOrWindow=0][, mouseid])
% 
% HideCursor hides the mouse cursor associated with 'screenidOrWindow'.
%
% 'screenidOrWindow' allows to specify the screen or onscreen window to which
% the function should apply.
%
% By default, the cursor on screen zero on Linux/X11, and on all screens on
% Windows and Mac OS/X is hidden. Although optional, it is strongly recommended
% to provide this parameter for cross-platform compatibility across operating
% systems.
%
% Note that this function may not have any effect if the cursor location is not
% on top of an open onscreen window, as cursor visibility or shape may not be
% under Psychtoolbox control while the cursor interacts with other applications
% windows. It may also do nothing if you call the function while no onscreen
% window is open at all. For this reason, you should place calls to HideCursor
% after the calls to Screen('OpenWindow') or PsychImaging('OpenWindow'), not
% before them.
%
% 'mouseid' defines which of multiple cursors shall be hidden on Linux/X11. The
% parameter is silently ignored on other systems.
% _________________________________________________________________________
%
% See ShowCursor, SetMouse

% 7/23/97  dgp Added wish.
% 8/15/97  dgp Explain hide/show counter.
% 3/27/99  dgp Mention Backgrounding.
% 3/28/99  dgp Show how to turn off backgrounding. 
% 1/22/00  dgp Cosmetic.
% 4/25/02  dgp Mention conflict with QuickDEX.
% 4/14/03  awi ****** OS X-specific fork from the OS 9 version *******
%               Added call to Screen('HideCursor'...) for OS X.
% 7/12/04  awi Cosmetic and uses IsMac.
% 11/16/04 awi Renamed "HideCursor" to "HideCursorHelper"

if (nargin < 1) || isempty(screenid)
  screenid = 0;
end

if nargin < 2
  mouseid = [];
end

Screen('HideCursorHelper', screenid, mouseid);