8de6846c79
* Fix construction of GLContextAttrs EndList returns None. I thought it returned self like the rest of the methods. * Tweaked OpenGL context construction The constructors now return the context if everything is valid. If not valid it returns None. The OpenGL 2.1 constructor now checks if GL_ARB_explicit_attrib_location is supported by the system. If the system does not support it an error will be raised at construction rather than when drawing.
114 lines
3.8 KiB
Python
114 lines
3.8 KiB
Python
from typing import Optional, Callable
|
|
import logging
|
|
|
|
import wx
|
|
from wx.glcanvas import GLCanvas, GLAttributes, GLContext, GLContextAttrs
|
|
from OpenGL.GL import (
|
|
GL_DEPTH_TEST,
|
|
glEnable,
|
|
GL_CULL_FACE,
|
|
glDepthFunc,
|
|
GL_LEQUAL,
|
|
GL_BLEND,
|
|
glBlendFunc,
|
|
GL_SRC_ALPHA,
|
|
GL_ONE_MINUS_SRC_ALPHA,
|
|
glGetString,
|
|
GL_VERSION,
|
|
)
|
|
from OpenGL.GL.ARB.explicit_attrib_location import glInitExplicitAttribLocationARB
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
"""OpenGL workflow:
|
|
The initialisation function should be as minimal as possible. No OpenGL functions should be called here. The OpenGL state is not valid until the window is first shown.
|
|
You can implement functions that take a while in threads to not block the GUI but they must still not contain OpenGL functions.
|
|
Upon the window being shown the OpenGL context is activated and the state can be set in _init_opengl
|
|
Objects that need to bind textures or data should do so in the draw function so they can be sure the context is set.
|
|
"""
|
|
|
|
|
|
class BaseCanvas(GLCanvas):
|
|
_context: Optional[GLContext]
|
|
|
|
def __init__(self, parent: wx.Window):
|
|
"""
|
|
Construct the canvas.
|
|
No OpenGL interaction should be done here.
|
|
OpenGL initialisation should be done in _init_opengl which is run after the window is first shown.
|
|
"""
|
|
display_attributes = GLAttributes()
|
|
display_attributes.PlatformDefaults().MinRGBA(8, 8, 8, 8).DoubleBuffer().Depth(
|
|
24
|
|
).EndList()
|
|
super().__init__(
|
|
parent,
|
|
display_attributes,
|
|
size=parent.GetClientSize(),
|
|
style=wx.WANTS_CHARS,
|
|
)
|
|
|
|
# Amulet-Team/Amulet-Map-Editor#84
|
|
# Amulet-Team/Amulet-Map-Editor#597
|
|
# Amulet-Team/Amulet-Map-Editor#856
|
|
def gl3() -> Optional[GLContext]:
|
|
ctx_attrs = GLContextAttrs()
|
|
ctx_attrs.PlatformDefaults()
|
|
ctx_attrs.OGLVersion(3, 3)
|
|
ctx_attrs.CoreProfile()
|
|
ctx_attrs.EndList()
|
|
ctx = GLContext(self, ctxAttrs=ctx_attrs)
|
|
if ctx.IsOK():
|
|
return ctx
|
|
return None
|
|
|
|
def gl2() -> Optional[GLContext]:
|
|
ctx_attrs = GLContextAttrs()
|
|
ctx_attrs.PlatformDefaults()
|
|
ctx_attrs.OGLVersion(2, 1)
|
|
ctx_attrs.CompatibilityProfile()
|
|
ctx_attrs.EndList()
|
|
ctx = GLContext(self, ctxAttrs=ctx_attrs)
|
|
if ctx.IsOK() and glInitExplicitAttribLocationARB():
|
|
return ctx
|
|
return None
|
|
|
|
context_constructors: list[Callable[[], Optional[GLContext]]] = [gl3, gl2]
|
|
context = next((constructor() for constructor in context_constructors), None)
|
|
if context is None:
|
|
raise Exception(f"Failed setting up context")
|
|
|
|
self._context = context
|
|
self._init = False
|
|
|
|
self.Bind(wx.EVT_SHOW, self._on_show)
|
|
|
|
@property
|
|
def context(self) -> GLContext:
|
|
return self._context
|
|
|
|
@property
|
|
def context_identifier(self) -> str:
|
|
# if not self._init:
|
|
# raise Exception("Cannot access the context until the window has been shown.")
|
|
return str(id(self._context))
|
|
|
|
def _on_show(self, evt: wx.ShowEvent):
|
|
if not self._init and evt.IsShown():
|
|
self._init = True
|
|
self._init_opengl()
|
|
|
|
def _init_opengl(self):
|
|
"""Set up the OpenGL state after the window is first shown."""
|
|
self.SetCurrent(self._context)
|
|
gl_version = glGetString(GL_VERSION)
|
|
if isinstance(gl_version, bytes):
|
|
gl_version = gl_version.decode("utf-8")
|
|
log.info(f"OpenGL Version {gl_version}")
|
|
glEnable(GL_DEPTH_TEST)
|
|
glEnable(GL_CULL_FACE)
|
|
glDepthFunc(GL_LEQUAL)
|
|
glEnable(GL_BLEND)
|
|
glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA)
|