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 48 49 50 51 52 53 54 55 56 57
|
/*
SCREENHideCursorHelper.c
AUTHORS:
Allen.Ingling@nyu.edu awi
mario.kleiner@tuebingen.mpg.de mk
PLATFORMS:
All.
HISTORY:
12/14/02 awi Created.
10/12/04 awi Changed "SCREEN" to "Screen" in useString.
11/16/04 awi Added "Helper" suffix.
DESCRIPTION:
Hides the mouse pointer
TO DO:
*/
#include "Screen.h"
// If you change the useString then also change the corresponding synopsis string in ScreenSynopsis.c
static char useString[] = "Screen('HideCursorHelper', windowPntr [, mouseIndex]);";
// 1 2
static char synopsisString[] =
"This is a helper function called by HideCursor. Do not call Screen(\'HideCursorHelper\'), use "
"HideCursor instead.\n"
"Hides the mouse pointer";
static char seeAlsoString[] = "ShowCursorHelper";
PsychError SCREENHideCursorHelper(void)
{
int screenNumber, mouseIdx;
//all subfunctions should have these two lines.
PsychPushHelp(useString, synopsisString, seeAlsoString);
if(PsychIsGiveHelp()){PsychGiveHelp();return(PsychError_none);};
PsychErrorExit(PsychCapNumInputArgs(2)); //The maximum number of inputs
PsychErrorExit(PsychCapNumOutputArgs(0)); //The maximum number of outputs
//get the screen number from the window record or screen number
PsychCopyInScreenNumberArg(1, TRUE, &screenNumber);
mouseIdx = -1;
PsychCopyInIntegerArg(2, FALSE, &mouseIdx);
PsychHideCursor(screenNumber, mouseIdx);
return(PsychError_none);
}
|