Skip to main content

Portable OpenGL Context

Project description

pypi

glcontext

glcontext is a library providing OpenGL implementation for ModernGL on multiple platforms.

Backends

A glcontext backend is either an extension or a submodule of the glcontext package. The package itself does not import any of the backends. Importing the base package glcontext must safe and lightweight.

Structure

Every backend of glcontext must provide a factory function:

def create_context(*args, **kwargs) -> GLContext:
    pass

The create_context method can take any number of positional and keyword arguments. The factory function must return an object supporting the following methods:

def load(self, name:str) -> int:
    pass

The load method takes an OpenGL function name as an input and returns a C/C++ function pointer as a python integer. The return value must be 0 for not implemented functions.

def __enter__(self, name:str):
    pass

The enter method calls ___MakeCurrent to make the GLContext the calling thread's current rendering context. ___MakeCurrent stands for wglMakeCurrent, glxMakeCurrent, ...

def __exit__(self, exc_type, exc_val, exc_tb):
    pass

The exit method calls ___MakeCurrent to make the GLContext no longer current.

def release(self):
    pass

The release method destroys the OpenGL context.

Development Guide

There are "empty" example backends provided for developers to help adding new backends to the library. There is a pure python example in empty.py and an extension example in empty.cpp. Besides their name match, they do not depend on each other, they are independent submodules of glcontext.

An "portable" backend implementation must load its dependency at runtime. This rule is for simplifying the build of the entire package. If an implementation cannot provide a "portable" backend, it will not be added to this library. Non "portable" backends are welcome as third party libraries.

A backend must be lightweight, its size must fit within reasonable limits.

To add support for new platforms one must edit the setup.py too. Platform specific dependencies are exceptions from the "portability" rule.

Example for platform specific dependencies:

  • gdi32.lib on windows
  • libdl.a on linux

Please note that libGL.so is loaded dinamically by the backends.

Running tests

pip install -r tests/requirements.txt
pytest tests

Contributing

Contribution is welcome.

Pull Requests will be merged if they match the Development Guide.

For prototypes, pure python implementations using ctypes are also welcome. We will probably port it to a proper extension in the future.

Please ask questions here.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

glcontext-1.0.1.tar.gz (11.9 kB view hashes)

Uploaded Source

Built Distributions

glcontext-1.0.1-cp38-cp38-win_amd64.whl (10.9 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

glcontext-1.0.1-cp38-cp38-win32.whl (10.0 kB view hashes)

Uploaded CPython 3.8 Windows x86

glcontext-1.0.1-cp38-cp38-manylinux1_x86_64.whl (37.1 kB view hashes)

Uploaded CPython 3.8

glcontext-1.0.1-cp38-cp38-manylinux1_i686.whl (36.3 kB view hashes)

Uploaded CPython 3.8

glcontext-1.0.1-cp38-cp38-macosx_10_9_x86_64.whl (7.3 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

glcontext-1.0.1-cp37-cp37m-win_amd64.whl (10.8 kB view hashes)

Uploaded CPython 3.7m Windows x86-64

glcontext-1.0.1-cp37-cp37m-win32.whl (9.9 kB view hashes)

Uploaded CPython 3.7m Windows x86

glcontext-1.0.1-cp37-cp37m-manylinux1_x86_64.whl (36.5 kB view hashes)

Uploaded CPython 3.7m

glcontext-1.0.1-cp37-cp37m-manylinux1_i686.whl (35.7 kB view hashes)

Uploaded CPython 3.7m

glcontext-1.0.1-cp37-cp37m-macosx_10_9_x86_64.whl (7.3 kB view hashes)

Uploaded CPython 3.7m macOS 10.9+ x86-64

glcontext-1.0.1-cp36-cp36m-win_amd64.whl (10.8 kB view hashes)

Uploaded CPython 3.6m Windows x86-64

glcontext-1.0.1-cp36-cp36m-win32.whl (9.9 kB view hashes)

Uploaded CPython 3.6m Windows x86

glcontext-1.0.1-cp36-cp36m-manylinux1_x86_64.whl (36.1 kB view hashes)

Uploaded CPython 3.6m

glcontext-1.0.1-cp36-cp36m-manylinux1_i686.whl (35.4 kB view hashes)

Uploaded CPython 3.6m

glcontext-1.0.1-cp36-cp36m-macosx_10_9_x86_64.whl (7.3 kB view hashes)

Uploaded CPython 3.6m macOS 10.9+ x86-64

glcontext-1.0.1-cp35-cp35m-win_amd64.whl (11.0 kB view hashes)

Uploaded CPython 3.5m Windows x86-64

glcontext-1.0.1-cp35-cp35m-win32.whl (10.1 kB view hashes)

Uploaded CPython 3.5m Windows x86

glcontext-1.0.1-cp35-cp35m-manylinux1_x86_64.whl (35.9 kB view hashes)

Uploaded CPython 3.5m

glcontext-1.0.1-cp35-cp35m-manylinux1_i686.whl (35.2 kB view hashes)

Uploaded CPython 3.5m

glcontext-1.0.1-cp35-cp35m-macosx_10_6_intel.whl (9.2 kB view hashes)

Uploaded CPython 3.5m macOS 10.6+ intel

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page