Display

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

See also

ClientDisplayRect, DisplaySize, DisplaySizeMM

Inheritance Diagram

Inheritance diagram for class Display

Methods Summary

__init__	Constructor, setting up a Display instance with the specified 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.
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.
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 Display(object)

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

Possible constructors:

Display(index=0)

Methods

---

__init__(self, index=0)

Constructor, setting up a 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 .

---

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 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 (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: 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: VideoMode

---

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 (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 (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: Rect

See also

GetClientArea , 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 (VideoMode) – Return type:ArrayVideoModes

---

GetName(self)

Returns the display’s name.

A name is not available on all platforms.

Return type:string

---

IsPrimary(self)

Returns True if the display is the primary display.

The primary display is the one whose index is 0.

Return type:bool

Properties

---

ClientArea

See GetClientArea

---

CurrentMode

See GetCurrentMode

---

Geometry

See GetGeometry

---

Name

See GetName