Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs for Change/GetMode(s) (patch 966312)

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28451 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2004-07-25 11:01:23 +00:00
parent a90bf70914
commit d6108c664a
1 changed files with 38 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/latex/wx/display.tex
View File

@@ -36,6 +36,27 @@ and lower than the value returned by \helpref{GetCount()}{wxdisplaygetcount}.}
Destructor.
\membersection{wxDisplay::ChangeMode}\label{wxdisplaychangemode}
\func{bool }{ChangeMode}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
Changes the video mode of this display to the mode specified
in the mode parameter.
If wxDefaultVideoMode is passed in as the mode parameter,
the defined behaviour is that wxDisplay will reset the video
mode to the default mode used by the display. On Windows,
the behavior is normal. However, there are differences on other
platforms. On Unix variations using X11 extensions it should
behave as defined, but some irregularities may occur.
On wxMac passing in wxDefaultVideoMode as the mode
parameter does nothing. This happens because carbon
no longer has access to DMUseScreenPrefs, an undocumented
function that changed the video mode to the system
default by using the system's 'scrn' resource.
\membersection{wxDisplay::GetCount}\label{wxdisplaygetcount}
\func{static size\_t}{GetCount}{\void}
@@ -43,6 +64,13 @@ Destructor.
Returns the number of connected displays.
\membersection{wxDisplay::GetCurrentMode}\label{wxdisplaygetcurrentmode}
\constfunc{wxVideoMode }{GetCurrentMode}{\void}
Returns the current video mode that this display is in.
\membersection{wxDisplay::GetDepth}\label{wxdisplaygetdepth}
\constfunc{int }{GetDepth}{\void}
@@ -70,6 +98,16 @@ Returns the bounding rectangle of the display whose index was passed to the
constructor.
\membersection{wxDisplay::GetModes}\label{wxdisplaygetmodes}
\constfunc{wxArrayVideoModes }{GetModes}{\param{const wxVideoMode\& }{mode = wxDefaultVideoMode}}
Fills and returns an array with all the video modes that
are supported by this display, or video modes that are
supported by this display and match the mode parameter
(if mode is not wxDefaultVideoMode).
\membersection{wxDisplay::GetName}\label{wxdisplaygetname}
\constfunc{wxString }{GetName}{\void}