wx.Display¶

Determines the sizes and locations of displays connected to the system.

Class Hierarchy¶

Inheritance diagram for class Display:

Methods Summary¶

`__init__`	Default constructor creating wx.Display object representing the primary display.
`ChangeMode`	Changes the video mode of this display to the mode specified in the mode parameter.
`GetClientArea`	Returns the client area of the display.
`GetCount`	Returns the number of connected displays.
`GetCurrentMode`	Returns the current video mode that this display is in.
`GetDepth`	Returns display depth, i.e.
`GetFromPoint`	Returns the index of the display on which the given point lies, or `NOT_FOUND` if the point is not on any connected display.
`GetFromWindow`	Returns the index of the display on which the given window lies.
`GetGeometry`	Returns the bounding rectangle of the display whose index was passed to the constructor.
`GetModes`	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 DefaultVideoMode).
`GetName`	Returns the display’s name.
`GetPPI`	Returns display resolution in pixels per inch.
`GetScaleFactor`	Returns scaling factor used by this display.
`GetStdPPI`	Returns default display resolution for the current platform as wx.Size.
`GetStdPPIValue`	Returns default display resolution for the current platform in pixels per inch.
`IsPrimary`	Returns `True` if the display is the primary display.

Properties Summary¶

`ClientArea`	See `GetClientArea`
`CurrentMode`	See `GetCurrentMode`
`Geometry`	See `GetGeometry`
`Name`	See `GetName`

Class API¶

class wx.Display(object)¶

Possible constructors:

Display() -> None

Display(index) -> None

Display(window) -> None

Determines the sizes and locations of displays connected to the system.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor creating wx.Display object representing the primary display.

Return type:: None

__init__ (self, index)

Constructor, setting up a wx.Display instance with the specified display.

Parameters:: index (int) – The index of the display to use. This must be non-negative and lower than the value returned by GetCount .
Return type:: None

__init__ (self, window)

Constructor creating the display object associated with the given window.

This is the most convenient way of finding the display on which the given window is shown while falling back to the default display if it is not shown at all or positioned outside of any display.

Parameters:: window (wx.Window) – A valid, i.e. non-null, window.
Return type:: None

Added in version 4.1/wxWidgets-3.1.2.

See also

GetFromWindow

ChangeMode(self, mode=DefaultVideoMode)¶

Changes the video mode of this display to the mode specified in the mode parameter.

If DefaultVideoMode is passed in as the mode parameter, the defined behaviour is that wx.Display will reset the video mode to the default mode used by the display. On Windows, the behaviour 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.

Parameters:: mode (wx.VideoMode)
Return type:: bool

GetClientArea(self)¶

Returns the client area of the display.

The client area is the part of the display available for the normal (non full screen) windows, usually it is the same as GetGeometry but it could be less if there is a taskbar (or equivalent) on this display.

Return type:: wx.Rect

static GetCount()¶

Returns the number of connected displays.

Return type:: int

GetCurrentMode(self)¶

Returns the current video mode that this display is in.

Return type:: wx.VideoMode

GetDepth(self)¶

Returns display depth, i.e.

number of bits per pixel (0 if unknown)

Return type:: int

Added in version 4.1/wxWidgets-3.1.2.

static GetFromPoint(pt)¶

Returns the index of the display on which the given point lies, or NOT_FOUND if the point is not on any connected display.

Parameters:: pt (wx.Point) – The point to locate.
Return type:: int

static GetFromWindow(win)¶

Returns the index of the display on which the given window lies.

If the window is on more than one display it gets the display that overlaps the window the most.

Returns NOT_FOUND if the window is not on any connected display.

Parameters:: win (wx.Window) – The window to locate.
Return type:: int

GetGeometry(self)¶

Returns the bounding rectangle of the display whose index was passed to the constructor.

Return type:: wx.Rect

See also

GetClientArea , wx.DisplaySize

GetModes(self, mode=DefaultVideoMode)¶

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 DefaultVideoMode).

Parameters:: mode (wx.VideoMode)
Return type:: List[VideoModes]

GetName(self)¶

Returns the display’s name.

The returned value is currently an empty string under all platforms except MSW.

Return type:: str

GetPPI(self)¶

Returns display resolution in pixels per inch.

Horizontal and vertical resolution are returned in x and y components of the wx.Size object respectively.

If the resolution information is not available, returns:

wx.Size(0, 0)

Return type:: wx.Size

Added in version 4.1/wxWidgets-3.1.2.

GetScaleFactor(self)¶

Returns scaling factor used by this display.

The scaling factor is the ratio between GetPPI and GetStdPPI (it is implicitly assumed that this ratio is the same for both horizontal and vertical components).

Return type:: float

Added in version 4.1/wxWidgets-3.1.5.

static GetStdPPI()¶

Returns default display resolution for the current platform as wx.Size.

This function is equivalent to constructing wx.Size object with both components set to GetStdPPIValue .

Return type:: wx.Size

Added in version 4.1/wxWidgets-3.1.5.

static GetStdPPIValue()¶

Returns default display resolution for the current platform in pixels per inch.

This function mostly used internally, use GetPPI to get the actual display resolution.

Currently the standard PPI is the same in both horizontal and vertical directions on all platforms and its value is 96 everywhere except under Apple devices (those running macOS, iOS, watchOS etc), where it is 72.