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 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.VideoMode:
==========================================================================================================================================
|phoenix_title| **wx.VideoMode**
==========================================================================================================================================
Determines the sizes and locations of displays connected to the system.
.. seealso:: :ref:`wx.ClientDisplayRect`, :ref:`wx.DisplaySize`, :ref:`wx.DisplaySizeMM`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>VideoMode</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.VideoMode_inheritance.png" alt="Inheritance diagram of VideoMode" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.VideoMode.html" title="wx.VideoMode" alt="" coords="5,5,117,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.VideoMode.__init__` Constructs this class using the given parameters.
:meth:`~wx.VideoMode.GetDepth` Returns bits per pixel (e.g. 32), 1 is monochrome and 0 means unspecified/known.
:meth:`~wx.VideoMode.GetHeight` Returns the screen height in pixels (e.g. 480), 0 means unspecified.
:meth:`~wx.VideoMode.GetWidth` Returns the screen width in pixels (e.g. 640), 0 means unspecified.
:meth:`~wx.VideoMode.IsOk` Returns ``True`` if the object has been initialized.
:meth:`~wx.VideoMode.Matches` Returns ``True`` if this mode matches the other one in the sense that all non zero fields of the other mode have the same value in this one (except for refresh which is allowed to have a greater value).
:meth:`~wx.VideoMode.__bool__`
:meth:`~wx.VideoMode.__nonzero__`
:meth:`~wx.VideoMode.__ne__`
:meth:`~wx.VideoMode.__eq__`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.VideoMode.Depth` See :meth:`~wx.VideoMode.GetDepth`
:attr:`~wx.VideoMode.Height` See :meth:`~wx.VideoMode.GetHeight`
:attr:`~wx.VideoMode.Width` See :meth:`~wx.VideoMode.GetWidth`
:attr:`~wx.VideoMode.bpp` A public C++ attribute of type ``int``. Bits per pixel (e.g. 32), 1 is monochrome and 0 means unspecified/known.
:attr:`~wx.VideoMode.h` A public C++ attribute of type ``int``. The screen height in pixels (e.g. 480), 0 means unspecified.
:attr:`~wx.VideoMode.refresh` A public C++ attribute of type ``int``. Refresh frequency in Hz, 0 means unspecified/unknown.
:attr:`~wx.VideoMode.w` A public C++ attribute of type ``int``. The screen width in pixels (e.g. 640), 0 means unspecified.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.VideoMode(object)
**Possible constructors**::
VideoMode(width=0, height=0, depth=0, freq=0)
Determines the sizes and locations of displays connected to the
system.
.. method:: __init__(self, width=0, height=0, depth=0, freq=0)
Constructs this class using the given parameters.
:param `width`:
:type `width`: int
:param `height`:
:type `height`: int
:param `depth`:
:type `depth`: int
:param `freq`:
:type `freq`: int
.. method:: GetDepth(self)
Returns bits per pixel (e.g. 32), 1 is monochrome and 0 means unspecified/known.
:rtype: `int`
.. method:: GetHeight(self)
Returns the screen height in pixels (e.g. 480), 0 means unspecified.
:rtype: `int`
.. method:: GetWidth(self)
Returns the screen width in pixels (e.g. 640), 0 means unspecified.
:rtype: `int`
.. method:: IsOk(self)
Returns ``True`` if the object has been initialized.
:rtype: `bool`
.. method:: Matches(self, other)
Returns ``True`` if this mode matches the other one in the sense that all non zero fields of the other mode have the same value in this one (except for refresh which is allowed to have a greater value).
:param `other`:
:type `other`: wx.VideoMode
:rtype: `bool`
.. method:: __bool__(self)
:rtype: `int`
.. method:: __nonzero__(self)
:rtype: `int`
.. method:: __ne__(self)
:param `mode`:
:type `mode`: wx.VideoMode
.. method:: __eq__(self)
:param `m`:
:type `m`: wx.VideoMode
.. attribute:: Depth
See :meth:`~wx.VideoMode.GetDepth`
.. attribute:: Height
See :meth:`~wx.VideoMode.GetHeight`
.. attribute:: Width
See :meth:`~wx.VideoMode.GetWidth`
.. attribute:: bpp
A public C++ attribute of type ``int``. Bits per pixel (e.g. 32), 1 is monochrome and 0 means unspecified/known.
.. attribute:: h
A public C++ attribute of type ``int``. The screen height in pixels (e.g. 480), 0 means unspecified.
.. attribute:: refresh
A public C++ attribute of type ``int``. Refresh frequency in Hz, 0 means unspecified/unknown.
.. attribute:: w
A public C++ attribute of type ``int``. The screen width in pixels (e.g. 640), 0 means unspecified.
|