~ubuntu-branches/ubuntu/trusty/psychtoolbox-3/trusty-proposed

#include "Screen.h"

 

// If you change the useString then also change the corresponding synopsis string in ScreenSynopsis.c

static char synopsisString[] = 

        "Get local rect of window or screen. This has its top-left corner always at (0,0) "

        "and encodes the useable size of the window or screen. E.g., in certain stereo "

        "stimulus drawing may be much smaller than the real area occupied by the window. "

        "Example: In interleaved stereo modes, the effective useable height of a window "

        "is only half the real height of the window. Use this function to get the actual "

 

PsychError SCREENRect(void)  

{

        PsychWindowRecordType *windowRecord;

        int screenNumber;

        PsychRectType rect; 

    

        //all sub functions should have these two lines

        PsychPushHelp(useString, synopsisString,seeAlsoString);

        if(PsychIsGiveHelp()){PsychGiveHelp();return(PsychError_none);};

        

        //check for superfluous arguments

        PsychErrorExit(PsychRequireNumInputArgs(1));    //Insist that the argument be present.   

        PsychErrorExit(PsychCapNumOutputArgs(1));               //The maximum number of outputs

 

        if(PsychIsScreenNumberArg(1)){

                PsychCopyInScreenNumberArg(1, TRUE, &screenNumber);

                PsychGetScreenRect(screenNumber, rect);

        }else if(PsychIsWindowIndexArg(1)){

        PsychAllocInWindowRecordArg(1, TRUE, &windowRecord);

        PsychOSProcessEvents(windowRecord, 0);          

        }else

                PsychErrorExitMsg(PsychError_user, "Argument was recognized as neither a window index nor a screen pointer");