************
wx.VideoMode
************

Inheritance diagram for `wx.VideoMode`:

|

.. inheritance-diagram:: wx.VideoMode

|

Description
===========

A simple struct containing video mode parameters for a display.


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetDepth <#GetDepth>`_ 
* `GetHeight <#GetHeight>`_ 
* `GetWidth <#GetWidth>`_ 
* `IsOk <#IsOk>`_ 
* `Matches <#Matches>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Depth <#Depth>`_ 
* `Height <#Height>`_ 
* `Width <#Width>`_ 
* `bpp <#bpp>`_ 
* `h <#h>`_ 
* `refresh <#refresh>`_ 
* `w <#w>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(width=0, height=0, depth=0, freq=0)

   A simple struct containing video mode parameters for a display.

   **Parameters:**

   * `width` (int)
   * `height` (int)
   * `depth` (int)
   * `freq` (int)

   |

   **Returns:**

   `wx.VideoMode <wx.VideoMode.html>`_
 

--------

.. method:: GetDepth()

   Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0
   means unspecified/known.

   |

   **Returns:**

   `int` 

--------

.. method:: GetHeight()

   Returns the screen height in pixels (e.g. 640\*480), 0 means unspecified.

   |

   **Returns:**

   `int` 

--------

.. method:: GetWidth()

   Returns the screen width in pixels (e.g. 640\*480), 0 means unspecified.

   |

   **Returns:**

   `int` 

--------

.. method:: IsOk()

   returns true if the object has been initialized.

   |

   **Returns:**

   `bool` 

--------

.. method:: Matches(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).

   **Parameters:**

   * `other` (`wx.VideoMode <wx.VideoMode.html>`_)

   |

   **Returns:**

   `bool` 

--------

Properties
^^^^^^^^^^


.. attribute:: Depth

   See `GetDepth <#GetDepth>`_

.. attribute:: Height

   See `GetHeight <#GetHeight>`_

.. attribute:: Width

   See `GetWidth <#GetWidth>`_

.. attribute:: bpp



.. attribute:: h



.. attribute:: refresh



.. attribute:: w