Rendering Contexts

These are the top-level rendering contexts available in yt_idv.

yt_idv.rendering_contexts.render_context(engine='pyglet', **kwargs)

Return the appropriate rendering context.

At present, this accepts “pyglet”, “osmesa” or “egl”

Parameters:

engine (str, "pyglet", "osmesa" or "egl") –

Returns:

Return type:

RenderingContext

class yt_idv.rendering_contexts.pyglet_context.PygletRenderingContext(*args: Any, **kwargs: Any)

Bases: pyglet.window.Window, yt_idv.rendering_contexts.base_context.BaseContext

Basic rendering context for IDV using GLFW3, that handles the main window event loop

Parameters:

• width (int, optional) – The width of the Interactive Data Visualization window. For performance reasons it is recommended to use values that are natural powers of 2.

• height (int, optional) – The height of the Interactive Data Visualization window. For performance reasons it is recommended to use values that are natural powers of 2.

• title (str, optional) – The title of the Interactive Data Visualization window.

• position (tuple of ints, optional) – What position should the window be moved to? (Upper left) If not specified, default to center.

center_window()

on_draw()

on_key_press(symbol, modifiers)

on_mouse_drag(x, y, dx, dy, buttons, modifiers)

on_mouse_press(x, y, button, modifiers)

on_mouse_scroll(x, y, scroll_x, scroll_y)

on_resize(width, height)

run()

set_position(xpos, ypos)

class yt_idv.rendering_contexts.egl_context.EGLRenderingContext(width=1024, height=1024, **kwargs)

Bases: yt_idv.rendering_contexts.base_offscreen.OffscreenRenderingContext

Offscreen rendering context using EGL (experimental)

Parameters:

• width (int, optional) – The width of the off-screen buffer window. For performance reasons it is recommended to use values that are natural powers of 2.

• height (int, optional) – The height of the off-screen buffer window. For performance reasons it it is recommended to use values that are natural powers of 2.