X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d14a1e28567de23c586bc80017073d0c39f8d18f..0439c23bddd7ae80ab3e0e2813706e5d70e4ae4f:/wxPython/contrib/glcanvas/msw/glcanvas.py

diff --git a/wxPython/contrib/glcanvas/msw/glcanvas.py b/wxPython/contrib/glcanvas/msw/glcanvas.py
index ece1507994..bb4006c8d3 100644
--- a/wxPython/contrib/glcanvas/msw/glcanvas.py
+++ b/wxPython/contrib/glcanvas/msw/glcanvas.py
@@ -1,26 +1,49 @@
 # This file was created automatically by SWIG.
 # Don't modify this file, modify the SWIG interface instead.
 
+"""
+`GLCanvas` provides an OpenGL Context on a `wx.Window`.
+"""
+
 import _glcanvas
 
-import core
-wx = core 
-class GLContext(core.Object):
+import _core
+wx = _core 
+__docfilter__ = wx.__DocFilter(globals()) 
+class GLContext(_core.Object):
+    def __repr__(self):
+        return "<%s.%s; proxy of C++ wxGLContext instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
+        """
+        __init__(self, bool isRGB, GLCanvas win, wxPalette palette=wxNullPalette, 
+            GLContext other=None) -> GLContext
+        """
         newobj = _glcanvas.new_GLContext(*args, **kwargs)
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
     def __del__(self, destroy=_glcanvas.delete_GLContext):
+        """__del__(self)"""
         try:
             if self.thisown: destroy(self)
         except: pass
-    def SetCurrent(*args, **kwargs): return _glcanvas.GLContext_SetCurrent(*args, **kwargs)
-    def SetColour(*args, **kwargs): return _glcanvas.GLContext_SetColour(*args, **kwargs)
-    def SwapBuffers(*args, **kwargs): return _glcanvas.GLContext_SwapBuffers(*args, **kwargs)
-    def GetWindow(*args, **kwargs): return _glcanvas.GLContext_GetWindow(*args, **kwargs)
-    def __repr__(self):
-        return "<%s.%s; proxy of C++ wxGLContext instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+
+    def SetCurrent(*args, **kwargs):
+        """SetCurrent(self)"""
+        return _glcanvas.GLContext_SetCurrent(*args, **kwargs)
+
+    def SetColour(*args, **kwargs):
+        """SetColour(self, String colour)"""
+        return _glcanvas.GLContext_SetColour(*args, **kwargs)
+
+    def SwapBuffers(*args, **kwargs):
+        """SwapBuffers(self)"""
+        return _glcanvas.GLContext_SwapBuffers(*args, **kwargs)
+
+    def GetWindow(*args, **kwargs):
+        """GetWindow(self) -> Window"""
+        return _glcanvas.GLContext_GetWindow(*args, **kwargs)
+
 
 class GLContextPtr(GLContext):
     def __init__(self, this):
@@ -28,6 +51,8 @@ class GLContextPtr(GLContext):
         if not hasattr(self,"thisown"): self.thisown = 0
         self.__class__ = GLContext
 _glcanvas.GLContext_swigregister(GLContextPtr)
+cvar = _glcanvas.cvar
+GLCanvasNameStr = cvar.GLCanvasNameStr
 
 WX_GL_RGBA = _glcanvas.WX_GL_RGBA
 WX_GL_BUFFER_SIZE = _glcanvas.WX_GL_BUFFER_SIZE
@@ -45,23 +70,53 @@ WX_GL_MIN_ACCUM_RED = _glcanvas.WX_GL_MIN_ACCUM_RED
 WX_GL_MIN_ACCUM_GREEN = _glcanvas.WX_GL_MIN_ACCUM_GREEN
 WX_GL_MIN_ACCUM_BLUE = _glcanvas.WX_GL_MIN_ACCUM_BLUE
 WX_GL_MIN_ACCUM_ALPHA = _glcanvas.WX_GL_MIN_ACCUM_ALPHA
-class GLCanvas(core.Window):
+class GLCanvas(_core.Window):
+    def __repr__(self):
+        return "<%s.%s; proxy of C++ wxGLCanvas instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
+        """
+        __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, 
+            Size size=DefaultSize, long style=0, String name=GLCanvasNameStr, 
+            int attribList=None, wxPalette palette=wxNullPalette) -> GLCanvas
+        """
         newobj = _glcanvas.new_GLCanvas(*args, **kwargs)
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
         self._setOORInfo(self)
-    def SetCurrent(*args, **kwargs): return _glcanvas.GLCanvas_SetCurrent(*args, **kwargs)
-    def SetColour(*args, **kwargs): return _glcanvas.GLCanvas_SetColour(*args, **kwargs)
-    def SwapBuffers(*args, **kwargs): return _glcanvas.GLCanvas_SwapBuffers(*args, **kwargs)
-    def GetContext(*args, **kwargs): return _glcanvas.GLCanvas_GetContext(*args, **kwargs)
-    def SetupPixelFormat(*args, **kwargs): return _glcanvas.GLCanvas_SetupPixelFormat(*args, **kwargs)
-    def SetupPalette(*args, **kwargs): return _glcanvas.GLCanvas_SetupPalette(*args, **kwargs)
-    def CreateDefaultPalette(*args, **kwargs): return _glcanvas.GLCanvas_CreateDefaultPalette(*args, **kwargs)
-    def GetPalette(*args, **kwargs): return _glcanvas.GLCanvas_GetPalette(*args, **kwargs)
-    def __repr__(self):
-        return "<%s.%s; proxy of C++ wxGLCanvas instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+
+    def SetCurrent(*args, **kwargs):
+        """SetCurrent(self)"""
+        return _glcanvas.GLCanvas_SetCurrent(*args, **kwargs)
+
+    def SetColour(*args, **kwargs):
+        """SetColour(self, String colour)"""
+        return _glcanvas.GLCanvas_SetColour(*args, **kwargs)
+
+    def SwapBuffers(*args, **kwargs):
+        """SwapBuffers(self)"""
+        return _glcanvas.GLCanvas_SwapBuffers(*args, **kwargs)
+
+    def GetContext(*args, **kwargs):
+        """GetContext(self) -> GLContext"""
+        return _glcanvas.GLCanvas_GetContext(*args, **kwargs)
+
+    def SetupPixelFormat(*args, **kwargs):
+        """SetupPixelFormat(self, int attribList=None)"""
+        return _glcanvas.GLCanvas_SetupPixelFormat(*args, **kwargs)
+
+    def SetupPalette(*args, **kwargs):
+        """SetupPalette(self, wxPalette palette)"""
+        return _glcanvas.GLCanvas_SetupPalette(*args, **kwargs)
+
+    def CreateDefaultPalette(*args, **kwargs):
+        """CreateDefaultPalette(self) -> wxPalette"""
+        return _glcanvas.GLCanvas_CreateDefaultPalette(*args, **kwargs)
+
+    def GetPalette(*args, **kwargs):
+        """GetPalette(self) -> wxPalette"""
+        return _glcanvas.GLCanvas_GetPalette(*args, **kwargs)
+
 
 class GLCanvasPtr(GLCanvas):
     def __init__(self, this):
@@ -70,8 +125,14 @@ class GLCanvasPtr(GLCanvas):
         self.__class__ = GLCanvas
 _glcanvas.GLCanvas_swigregister(GLCanvasPtr)
 
-def wxGLCanvasWithContext(*args, **kwargs):
-    val = _glcanvas.new_wxGLCanvasWithContext(*args, **kwargs)
+def GLCanvasWithContext(*args, **kwargs):
+    """
+    GLCanvasWithContext(Window parent, GLContext shared=None, int id=-1, Point pos=DefaultPosition, 
+        Size size=DefaultSize, 
+        long style=0, String name=GLCanvasNameStr, 
+        int attribList=None, wxPalette palette=wxNullPalette) -> GLCanvas
+    """
+    val = _glcanvas.new_GLCanvasWithContext(*args, **kwargs)
     val.thisown = 1
     val._setOORInfo(val)
     return val