pyglet.info

pyglet.info records system, driver, and active graphics-context details for bug reports:

python -m pyglet.info > info.txt

Use the isolated graphics probe to test the OpenGL and OpenGL ES versions supported by pyglet on that machine. It also compiles pyglet’s built-in startup shaders for each successful context:

python -m pyglet.info --probe-graphics > info.txt

Test one specific request with --backend and --version:

python -m pyglet.info --backend gles3 --version 3.1

Command-line options

python -m pyglet.info accepts the following public options:

Option

Purpose

-h, --help

Show the command-line help text.

-extensions

Include complete graphics and audio extension lists instead of shortened previews.

--verbose

Include full tracebacks when a diagnostic section fails.

--backend BACKEND

Use opengl, gl2, gles3, gles2, webgl, or vulkan for the main report.

--version MAJOR.MINOR

Explicitly request an OpenGL or OpenGL ES version for the main report. Requires --backend; omit it to use the backend’s default version.

--probe-graphics

Test pyglet’s supported OpenGL-family requests in isolated processes and print a recommendation.

The --graphics-worker option is reserved for the probe’s internal subprocesses and is not part of the public CLI.

Get environment information useful for debugging.

Intended usage is to create a file for bug reports, e.g.:

python -m pyglet.info > info.txt

Graphics API and version support can be tested in isolated subprocesses:

python -m pyglet.info --probe-graphics > info.txt

One specific configuration can also be requested:

python -m pyglet.info --backend gles3 --version 3.1
dump(graphics_config: Any | None = None) → None

Dump all information to stdout.

Return type:

None

dump_al() → None

Dump OpenAL info.

Return type:

None

dump_backend(window: Any | None = None) → None

Dump active backend details and selected surface config.

Return type:

None

dump_backend_glx(
context: OpenGLSurfaceContext | None = None,
) → None

Dump GLX info.

Return type:

None

dump_backend_platform_api(
context: OpenGLSurfaceContext,
) → None

Dump platform-specific OpenGL details for the active backend.

Return type:

None

dump_backend_wgl(
context: OpenGLSurfaceContext | None = None,
) → None

Dump WGL info.

Return type:

None

dump_ffmpeg() → None

Dump FFmpeg info.

Return type:

None

dump_gl(
context: OpenGLSurfaceContext | None = None,
) → None

Backward-compatible wrapper for dump_graphics_api().

Return type:

None

dump_gl_platform(
context: OpenGLSurfaceContext,
) → None

Backward-compatible wrapper for dump_backend_platform_api().

Return type:

None

dump_glx(
context: OpenGLSurfaceContext | None = None,
) → None

Backward-compatible wrapper for dump_backend_glx().

Return type:

None

dump_graphics_api(
context: OpenGLSurfaceContext | None = None,
) → None

Dump active graphics API info for the given context.

Return type:

None

dump_graphics_probe() → None

Probe pyglet graphics backends and versions in isolated processes.

Return type:

None

dump_media() → None

Dump pyglet.media info.

Return type:

None

dump_media_decoders() → None

Dump available media decoders.

Return type:

None

dump_platform() → None

Dump OS specific.

Return type:

None

dump_pyglet() → None

Dump pyglet version and options.

Return type:

None

dump_python() → None

Dump Python version and environment to stdout.

Return type:

None

dump_wgl(
context: OpenGLSurfaceContext | None = None,
) → None

Backward-compatible wrapper for dump_backend_wgl().

Return type:

None

dump_window(window: Any | None = None) → None

Dump display, window, and screen info.

Return type:

None

dump_window_and_backend(config: Any | None = None) → None

Create one diagnostic window and use it for all graphics output.

Return type:

None

dump_wintab() → None

Dump WinTab info.

Return type:

None

main(argv: list[str] | None = None) → int

Run the environment report or an isolated graphics probe worker.

Return type:

int