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
|
.. currentmodule:: sdl2.ext
Window routines to manage on-screen windows
===========================================
.. class:: Window(title : string, size : iterable[, position=None[, flags=None]])
The Window class represents a visible on-screen object with an optional
border and *title* text. It represents an area on the screen that can be
accessed by the application for displaying graphics and receive and
process user input.
The position to show the Window at is undefined by default, letting
the operating system or window manager pick the best location. The
behaviour can be adjusted through the ``DEFAULTPOS`` class variable. ::
Window.DEFAULTPOS = (10, 10)
The created Window is hidden by default, which can be overridden at
the time of creation by providing other SDL window flags through the
*flags* parameter. The default flags for creating Window instances
can be adjusted through the ``DEFAULTFLAGS`` class variable. ::
Window.DEFAULTFLAGS = sdl2.SDL_WINDOW_SHOWN
.. attribute:: window
The used :class:`sdl2.SDL_Window`.
.. attribute:: title
The title of the :class:`Window`.
.. attribute:: size
The size of the :class:`Window`.
.. attribute:: position
The current position of the :class:`Window` top-left corner.
.. method:: create() -> None
Creates the underlying SDL2 window. This method does nothing, if the
window was already created.
.. method:: open() -> None
Creates and shows the window.
.. method:: close() -> None
Closes the window, implicitly destroying the underlying SDL2 window.
.. method:: show() -> None
Show the :class:`Window` on the display.
.. method:: hide() -> None
Hide the :class:`Window`.
.. method:: maximize() -> None
Maximizes the :class:`Window` to the display's dimensions.
.. method:: minimize() -> None
Minimizes the :class:`Window` to an iconified state in the system tray.
.. method:: refresh() -> None
Refreshes the entire :class:`Window` surface.
.. note::
This only needs to be called, if a SDL_Surface was acquired via
:meth:`get_surface()` and is used to display contents.
.. method:: get_surface() -> SDL_Surface
Gets the :class:`sdl2.SDL_Surface` used by the :class:`Window` to
display 2D pixel data.
.. note::
Using this method will make the usage of GL operations, such as
texture handling or the usage of SDL renderers impossible.
|
