\doxysection{pygaze.\+\_\+display.\+basedisplay.\+Base\+Display Class Reference}
\hypertarget{classpygaze_1_1__display_1_1basedisplay_1_1_base_display}{}\label{classpygaze_1_1__display_1_1basedisplay_1_1_base_display}\index{pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}}
Inheritance diagram for pygaze.\+\_\+display.\+basedisplay.\+Base\+Display\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=1.274175cm]{classpygaze_1_1__display_1_1basedisplay_1_1_base_display}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_aec48dad0bf4bb5c7d2cb2aca5c0c6bea}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a6d768e7259aa38114cd1ecfb182a3ffd}{show}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a3010174c2b606510ea34c1ff691d28b6}{show\+\_\+part}} (self, rect, screen=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a5848be0193d71212bebbdc109c5eadda}{fill}} (self, screen=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a4647b897b7c6320d76d30c2067789c34}{close}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a1ba799819e306e2b5dd799aee0a7924e}{make\+\_\+screenshot}} (self, filename=\textquotesingle{}screenshot.\+png\textquotesingle{})
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\begin{DoxyVerb}A class for Display objects, to present Screen objects on a monitor\end{DoxyVerb}
 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_aec48dad0bf4bb5c7d2cb2aca5c0c6bea}\index{pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_aec48dad0bf4bb5c7d2cb2aca5c0c6bea} 
pygaze.\+\_\+display.\+basedisplay.\+Base\+Display.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Initializes a Display object.
        
        arguments

        None

        keyword arguments

        dispsize    --  size of the display in pixels: a (width, height)
                    tuple (default = DISPSIZE)
        fgc     --  the foreground colour: a RGB tuple, e.g. (255,0,0)
                    for red or (0,0,0) for black (default = FGC)
        bgc     --  the background colour: a RGB tuple, e.g. (0,0,255)
                    for blue or (255,255,255) for white (default = BGC)
        screen  --  a screen.Screen instance to be presented on the new
                    Display (default=None)
\end{DoxyVerb}
 

\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a4647b897b7c6320d76d30c2067789c34}\index{pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}!close@{close}}
\index{close@{close}!pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}}
\doxysubsubsection{\texorpdfstring{close()}{close()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a4647b897b7c6320d76d30c2067789c34} 
pygaze.\+\_\+display.\+basedisplay.\+Base\+Display.\+close (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Closes the display
        
        arguments
        
        None
        
        keyword arguments
        
        None
        
        returns
        
        None
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__display_1_1osdisplay_1_1_o_s_display_a1df3833cc8fc66754cef5b4e77c9ff2c}{pygaze.\+\_\+display.\+osdisplay.\+OSDisplay}}, and \mbox{\hyperlink{classpygaze_1_1__display_1_1pygamedisplay_1_1_py_game_display_a49c3f6c5632804af2ec4130c93d32dbf}{pygaze.\+\_\+display.\+pygamedisplay.\+Py\+Game\+Display}}.

\Hypertarget{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a5848be0193d71212bebbdc109c5eadda}\index{pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}!fill@{fill}}
\index{fill@{fill}!pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}}
\doxysubsubsection{\texorpdfstring{fill()}{fill()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a5848be0193d71212bebbdc109c5eadda} 
pygaze.\+\_\+display.\+basedisplay.\+Base\+Display.\+fill (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{screen}{ = {\ttfamily None}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Fills the screen with the background colour of the Screen, NOT
        updating it (call Display.show() to actually show the new contents)
        
        arguments
        
        None
        
        keyword arguments
        
        screen  --  the screen that should be drawn to the display or
                    None to fill the display with its background colour
        
        returns
        
        None
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__display_1_1osdisplay_1_1_o_s_display_a7e8799a4b6f439ab8f39775583755e2a}{pygaze.\+\_\+display.\+osdisplay.\+OSDisplay}}, and \mbox{\hyperlink{classpygaze_1_1__display_1_1pygamedisplay_1_1_py_game_display_a804b8e722cb1a698ef1612fb47834b31}{pygaze.\+\_\+display.\+pygamedisplay.\+Py\+Game\+Display}}.

\Hypertarget{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a1ba799819e306e2b5dd799aee0a7924e}\index{pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}!make\_screenshot@{make\_screenshot}}
\index{make\_screenshot@{make\_screenshot}!pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}}
\doxysubsubsection{\texorpdfstring{make\_screenshot()}{make\_screenshot()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a1ba799819e306e2b5dd799aee0a7924e} 
pygaze.\+\_\+display.\+basedisplay.\+Base\+Display.\+make\+\_\+screenshot (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{filename}{ = {\ttfamily \textquotesingle{}screenshot.png\textquotesingle{}}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Make a screenshot from the current display.

        arguments

        None

        keyword arguments

        filename    --  path and filename, under wich the screenshot will be
                        saved. Defaults to screenshot.png

        returns

        None
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__display_1_1pygamedisplay_1_1_py_game_display_a8bf3785af552ebe2bfb8f28ae4b4d906}{pygaze.\+\_\+display.\+pygamedisplay.\+Py\+Game\+Display}}.

\Hypertarget{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a6d768e7259aa38114cd1ecfb182a3ffd}\index{pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}!show@{show}}
\index{show@{show}!pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}}
\doxysubsubsection{\texorpdfstring{show()}{show()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a6d768e7259aa38114cd1ecfb182a3ffd} 
pygaze.\+\_\+display.\+basedisplay.\+Base\+Display.\+show (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Updates ('flips') the display.
        
        arguments
        
        None
        
        keyword arguments
        
        None
        
        returns
        time        --  the exact refresh time when disptype is PsychoPy,
                    or an estimate when disptype is PyGame
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__display_1_1osdisplay_1_1_o_s_display_a9f3bb0788120c4309ef52f2042353f35}{pygaze.\+\_\+display.\+osdisplay.\+OSDisplay}}, and \mbox{\hyperlink{classpygaze_1_1__display_1_1pygamedisplay_1_1_py_game_display_abd4bd9ae90df0629f62083636138ea64}{pygaze.\+\_\+display.\+pygamedisplay.\+Py\+Game\+Display}}.

\Hypertarget{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a3010174c2b606510ea34c1ff691d28b6}\index{pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}!show\_part@{show\_part}}
\index{show\_part@{show\_part}!pygaze.\_display.basedisplay.BaseDisplay@{pygaze.\_display.basedisplay.BaseDisplay}}
\doxysubsubsection{\texorpdfstring{show\_part()}{show\_part()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__display_1_1basedisplay_1_1_base_display_a3010174c2b606510ea34c1ff691d28b6} 
pygaze.\+\_\+display.\+basedisplay.\+Base\+Display.\+show\+\_\+part (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{rect}{, }\item[{}]{screen}{ = {\ttfamily None}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Fills AND shows part(s) of the screen to given specified screen
        (only works when disptype is PyGame; when this is set to PsychoPy
        the entire display is filled and updated)
        
        arguments
        
        rect        --  a single or a list of rects; a rect is a (x,y,w,h)
                    tuple or list
        
        keyword arguments
        
        screen  --  the screen of which the specified rects should be
                    updated to the display (default = None)
        
        returns
        
        time        --  the exact refresh time when disptype is PsychoPy,
                    or an estimate when disptype is PyGame
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__display_1_1osdisplay_1_1_o_s_display_a8fff0b65f3c64dabc436cff923cc17f3}{pygaze.\+\_\+display.\+osdisplay.\+OSDisplay}}, and \mbox{\hyperlink{classpygaze_1_1__display_1_1pygamedisplay_1_1_py_game_display_a6339a460735c3c1a4d74539d1cde6d10}{pygaze.\+\_\+display.\+pygamedisplay.\+Py\+Game\+Display}}.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
C\+:/\+Users/lurax/eyetracking\+Tobii/pygaze/\+\_\+display/\mbox{\hyperlink{basedisplay_8py}{basedisplay.\+py}}\end{DoxyCompactItemize}
