headless.Window¶
Methods¶
-
Window.
__init__
(**kwargs)[source]¶ Initialize a window instance.
- Parameters
title (str) – The window title
gl_version (tuple) – Major and minor version of the opengl context to create
size (tuple) – Window size x, y
resizable (bool) – Should the window be resizable?
fullscreen (bool) – Open window in fullsceeen mode
vsync (bool) – Enable/disable vsync
aspect_ratio (float) – The desired aspect ratio. Can be set to None.
samples (int) – Number of MSAA samples for the default framebuffer
cursor (bool) – Enable/disable displaying the cursor inside the window
-
Window.
is_key_pressed
(key) → bool¶ Returns: The press state of a key
-
Window.
close
() → None¶ Signal for the window to close
-
Window.
clear
(red=0.0, green=0.0, blue=0.0, alpha=0.0, depth=1.0, viewport=None)[source]¶ Binds and clears the default framebuffer
- Parameters
red (float) – color component
green (float) – color component
blue (float) – color component
alpha (float) – alpha component
depth (float) – depth value
viewport (tuple) – The viewport
-
Window.
render
(time=0.0, frame_time=0.0) → None¶ Renders a frame by calling the configured render callback
- Keyword Arguments
time (float) – Current time in seconds
frame_time (float) – Delta time from last frame in seconds
-
Window.
swap_buffers
() → None[source]¶ Placeholder. We currently don’t do double buffering in headless mode. This may change in the future.
-
Window.
resize
(width, height) → None¶ Should be called every time window is resized so the example can adapt to the new size if needed
-
Window.
set_default_viewport
() → None¶ Calculates the viewport based on the configured aspect ratio. Will add black borders and center the viewport if the window do not match the configured viewport.
If aspect ratio is None the viewport will be scaled to the entire window size regardless of size.
-
Window.
print_context_info
()¶ Prints moderngl context info.
Attributes¶
-
Window.
keys
¶
-
Window.
ctx
¶ The ModernGL context for the window
- Type
moderngl.Context
-
Window.
fbo
¶ The default framebuffer
- Type
moderngl.Framebuffer
-
Window.
title
¶ Window title
- Type
str
-
Window.
gl_version
¶ (major, minor) required OpenGL version
- Type
Tuple[int, int]
-
Window.
width
¶ The current window width
- Type
int
-
Window.
height
¶ The current window height
- Type
int
-
Window.
size
¶ current window size
- Type
Tuple[int, int]
-
Window.
position
¶ The current window position.
This property can also be set to move the window:
# Move window to 100, 100 window.position = 100, 100
- Type
Tuple[int, int]
-
Window.
buffer_width
¶ the current window buffer width
- Type
int
-
Window.
buffer_height
¶ the current window buffer height
- Type
int
-
Window.
buffer_size
¶ tuple with the current window buffer size
- Type
Tuple[int, int]
-
Window.
pixel_ratio
¶ The frambuffer/window size ratio
- Type
float
-
Window.
viewport
¶ current window viewport
- Type
Tuple[int, int, int, int]
-
Window.
viewport_size
¶ Size of the viewport.
Equivalent to
self.viewport[2], self.viewport[3]
- Type
Tuple[int,int]
-
Window.
viewport_width
¶ The width of the viewport.
Equivalent to
self.viewport[2]
.- Type
int
-
Window.
viewport_height
¶ The height of the viewport
Equivalent to
self.viewport[3]
.- Type
int
-
Window.
frames
¶ Number of frames rendered
- Type
int
-
Window.
resizable
¶ Window is resizable
- Type
bool
-
Window.
fullscreen
¶ Window is in fullscreen mode
- Type
bool
-
Window.
config
¶ Get the current WindowConfig instance
-
Window.
vsync
¶ vertical sync enabled/disabled
- Type
bool
-
Window.
aspect_ratio
¶ Aspect ratio configured for the viewport
- Type
float
-
Window.
samples
¶ Number of Multisample anti-aliasing (MSAA) samples
- Type
float
-
Window.
cursor
¶ Should the mouse cursor be visible inside the window?
- Type
bool
-
Window.
render_func
¶ The render callable
This property can also be used to assign a callable.
- Type
callable
-
Window.
resize_func
¶ The resize callable
This property can also be used to assign a callable.
- Type
callable
-
Window.
key_event_func
¶ The key_event callable
This property can also be used to assign a callable.
- Type
callable
-
Window.
mouse_position_event_func
¶ The mouse_position callable
This property can also be used to assign a callable.
- Type
callable
-
Window.
mouse_press_event_func
¶ The mouse_press callable
This property can also be used to assign a callable.
- Type
callable
-
Window.
mouse_release_event_func
¶ The mouse_release callable
This property can also be used to assign a callable.
- Type
callable
-
Window.
mouse_drag_event_func
¶ The mouse_drag callable
This property can also be used to assign a callable.
- Type
callable
-
Window.
mouse_scroll_event_func
¶ The mouse_scroll_event calable
This property can also be used to assign a callable.
- Type
callable
-
Window.
unicode_char_entered_func
¶ The unicode_char_entered callable
This property can also be used to assign a callable.
- Type
callable
-
Window.
is_closing
¶ Is the window about to close?
- Type
bool
-
Window.
mouse
= <class 'moderngl_window.context.base.window.MouseButtons'>¶
-
Window.
mouse_states
¶ Mouse button state structure.
The current mouse button states.
window.mouse_buttons.left window.mouse_buttons.right window.mouse_buttons.middle
- Type
MouseButtonStates
-
Window.
modifiers
¶ (KeyModifiers) The current keyboard modifiers
-
Window.
gl_version_code
¶ Generates the version code integer for the selected OpenGL version.
gl_version (4, 1) returns 410
- Type
int