rendercanvas

One canvas API, multiple backends 🚀

This project is part of pygfx.org

Introduction

See how the two windows above look the same? That's the idea; they also look the same to the code that renders to them. Yet, the GUI systems are very different (Qt vs glfw in this case). Now that's a powerful abstraction!

Purpose

Providing a generic API for:

managing a canvas window (BaseRenderCanvas).
presenting rendered results with wgpu (WgpuContext).
presenting rendered results as a bitmap (BitmapContext).
working with events that have standardized behavior.

The following backends are currently available:

auto - automatically selects an appropriate backend.
glfw - a native desktop window.
offscreen - for offscreen rendering.
terminal - to render in the terminal (e.g. over SSH).
qt (pyside6 / pyside2 / pyqt6 / pyqt5) - to embed a render canvas in a qt GUI.
wx - to embed a render canvas in a wx GUI.
anywidget - for notebooks like Jupyter, VSCode, and Marimo.
jupyter - previous backend for notebooks that uses jupyter_rfb.
http - for server side rendering, display in a browser connected via the internet.
pyodide - to run in the browser with Pyodide or PyScript.

In addition to the GUI libraries mentioned above, the following event loops are supported:

asyncio
trio
raw

Installation

pip install rendercanvas

To have at least one backend, we recommend:

pip install rendercanvas glfw

Usage

Also see the online documentation and the examples.

A minimal example that renders noise:

import numpy as np
from rendercanvas.auto import RenderCanvas, loop

canvas = RenderCanvas(update_mode="continuous")
context = canvas.get_bitmap_context()

@canvas.request_draw
def animate():
    w, h = canvas.get_logical_size()
    bitmap = np.random.uniform(0, 255, (h, w)).astype(np.uint8)
    context.set_bitmap(bitmap)

loop.run()

Run wgpu visualizations:

from rendercanvas.auto import RenderCanvas, loop
from rendercanvas.utils.cube import setup_drawing_sync


canvas = RenderCanvas(
    title="The wgpu cube example on $backend", update_mode="continuous"
)
draw_frame = setup_drawing_sync(canvas)
canvas.request_draw(draw_frame)

loop.run()

Embed in a Qt application:

from PySide6 import QtWidgets
from rendercanvas.qt import QRenderWidget

class Main(QtWidgets.QWidget):

    def __init__(self):
        super().__init__()

        splitter = QtWidgets.QSplitter()
        self.canvas = QRenderWidget(splitter)
        ...


app = QtWidgets.QApplication([])
main = Main()
app.exec()

Async or not async

We support both; a render canvas can be used in a fully async setting using e.g. Asyncio or Trio, or in an event-driven framework like Qt. If you like callbacks, loop.call_later() always works. If you like async, use loop.add_task(). See the docs on async for details.

License

This code is distributed under the 2-clause BSD license.

Contributing

See the contribution guide.

Development install

Clone the repo.
Install rendercanvas and developer deps using pip install -e .[dev].

Quick tips

Use ruff format to apply autoformatting.
Use ruff check to check for linting errors.
Use pytest tests to run the tests.
Use pytest examples to run a subset of the examples.

Code of Conduct

This repository follows the PyGfx Code of Conduct

Metadata

Release files for rendercanvas 2.7.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rendercanvas 2.7.2
File	Size	Uploaded	Provenance
rendercanvas-2.7.2.tar.gz	117.9 kB	Jul 21, 2026	With provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for rendercanvas 2.7.2
File	Interpreter	ABI	Platform	Reset
rendercanvas-2.7.2-py3-none-any.whl 138.1 kB Jul 21, 2026 With provenance	Python 3	none	any	Details

Total release size: 256.1 kB

Release files / rendercanvas-2.7.2.tar.gz

Download URL	rendercanvas-2.7.2.tar.gz
Size	117.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`061507e379aefad390d066969bf3797f8d92f54c5943934dc43ab77d0f8bd690`
BLAKE2b-256 checksum How to use checksums	`efebb263fd2f1bbc3ebc6ce54d21e5a0b08f0dbb38dab6af08a37cf217cbfce7`
Upload date	Jul 21, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/pygfx/rendercanvas
Publishing commit: github.com/pygfx/rendercanvas/tree/03db811ed97f6935448824043bac7fee683a2edc

Workflow

Publishing configuration: github.com/pygfx/rendercanvas/blob/03db811ed97f6935448824043bac7fee683a2edc/.github/workflows/ci.yml
Publishing logs: github.com/pygfx/rendercanvas/actions/runs/29813069209/attempts/1

Artifact

Subject: rendercanvas-2.7.2.tar.gz
SHA-256 checksum: 061507e379aefad390d066969bf3797f8d92f54c5943934dc43ab77d0f8bd690 Verifying attestations

Release files / rendercanvas-2.7.2-py3-none-any.whl

Download URL	rendercanvas-2.7.2-py3-none-any.whl
Size	138.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0d98ca3f59fdf90c2601b6162f239d3beeced64d27d44bacb15c4253b21c4784`
BLAKE2b-256 checksum How to use checksums	`f14e492bc856902c7fa9e10e00e5f3136afc8890f37a5b838f4fc52847af100a`
Upload date	Jul 21, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/pygfx/rendercanvas
Publishing commit: github.com/pygfx/rendercanvas/tree/03db811ed97f6935448824043bac7fee683a2edc

Workflow

Publishing configuration: github.com/pygfx/rendercanvas/blob/03db811ed97f6935448824043bac7fee683a2edc/.github/workflows/ci.yml
Publishing logs: github.com/pygfx/rendercanvas/actions/runs/29813069209/attempts/1

Artifact

Subject: rendercanvas-2.7.2-py3-none-any.whl
SHA-256 checksum: 0d98ca3f59fdf90c2601b6162f239d3beeced64d27d44bacb15c4253b21c4784 Verifying attestations

Security for rendercanvas 2.7.2

Report project as malware

Provenance

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Attestation for rendercanvas-2.7.2.tar.gz

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/pygfx/rendercanvas
Publishing commit: github.com/pygfx/rendercanvas/tree/03db811ed97f6935448824043bac7fee683a2edc

Workflow

Publishing configuration: github.com/pygfx/rendercanvas/blob/03db811ed97f6935448824043bac7fee683a2edc/.github/workflows/ci.yml
Publishing logs: github.com/pygfx/rendercanvas/actions/runs/29813069209/attempts/1

Artifact

Subject: rendercanvas-2.7.2.tar.gz
SHA-256 checksum: 061507e379aefad390d066969bf3797f8d92f54c5943934dc43ab77d0f8bd690 Verifying attestations

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.