wxPython 4.3.2__cp315-cp315-win_amd64.whl

wx/gizmos.py

@@ -0,0 +1,18 @@
+#---------------------------------------------------------------------------
+# Name:        wx/gizmos.py
+# Author:      Robin Dunn
+#
+# Created:     27-Oct-2017
+# Copyright:   (c) 2017-2020 by Total Control Software
+# License:     wxWindows License
+#---------------------------------------------------------------------------
+
+# This is just a compatibility shim to make the gizmos classes usable from
+# the wx.gizmos module, like in Classic.  They're actually in the wx.lib.gizmos
+# package now.
+#
+# This module is deprecated and could be removed some time in the future. Please
+# switch your imports to wx.lib.gizmos
+
+from wx.lib.gizmos import *
+

wx/glcanvas.py

@@ -0,0 +1,13 @@
+# This file is generated by wxPython's SIP generator.  Do not edit by hand.
+#
+# Copyright: (c) 2020 by Total Control Software
+# License:   wxWindows License
+
+"""
+These classes enable viewing and interacting with an OpenGL context in a wx.Window.
+"""
+
+from ._glcanvas import *
+
+import wx
+

wx/glcanvas.pyi

@@ -0,0 +1,544 @@
+# -*- coding: utf-8 -*-
+#---------------------------------------------------------------------------
+# This file is generated by wxPython's PI generator.  Do not edit by hand.
+#
+# The *.pyi files are used by PyCharm and other development tools to provide
+# more information, such as PEP 484 type hints, than it is able to glean from
+# introspection of extension types and methods.  They are not intended to be
+# imported, executed or used for any other purpose other than providing info
+# to the tools. If you don't use use a tool that makes use of .pyi files then
+# you can safely ignore this file.
+#
+# See: https://www.python.org/dev/peps/pep-0484/
+#      https://www.jetbrains.com/help/pycharm/2016.1/type-hinting-in-pycharm.html
+#
+# Copyright: (c) 2020 by Total Control Software
+# License:   wxWindows License
+#---------------------------------------------------------------------------
+
+#-- begin-typing-imports --#
+from __future__ import annotations
+import builtins
+import typing
+from datetime import datetime, date
+from enum import IntEnum, IntFlag, auto
+from typing import (Any, overload, TypeAlias, Generic, TypeVar, Protocol, ClassVar, final,
+    Union, Optional, List, Tuple, Callable, Iterator, Sequence
+)
+try:
+    from typing import ParamSpec
+except ImportError:
+    from typing_extensions import ParamSpec
+from typing_extensions import Buffer
+
+_TwoInts: TypeAlias = Tuple[int, int]
+_ThreeInts: TypeAlias = Tuple[int, int, int]
+_FourInts: TypeAlias = Tuple[int, int, int, int]
+_TwoFloats: TypeAlias = Tuple[float, float]
+_FourFloats: TypeAlias = Tuple[float, float, float, float]
+
+#-- end-typing-imports --#
+
+"""
+These classes enable viewing and interacting with an OpenGL context in a wx.Window.
+"""
+#-- begin-_glcanvas --#
+import wx.siplib
+
+import wx
+WX_GL_RGBA: int
+WX_GL_BUFFER_SIZE: int
+WX_GL_LEVEL: int
+WX_GL_DOUBLEBUFFER: int
+WX_GL_STEREO: int
+WX_GL_AUX_BUFFERS: int
+WX_GL_MIN_RED: int
+WX_GL_MIN_GREEN: int
+WX_GL_MIN_BLUE: int
+WX_GL_MIN_ALPHA: int
+WX_GL_DEPTH_SIZE: int
+WX_GL_STENCIL_SIZE: int
+WX_GL_MIN_ACCUM_RED: int
+WX_GL_MIN_ACCUM_GREEN: int
+WX_GL_MIN_ACCUM_BLUE: int
+WX_GL_MIN_ACCUM_ALPHA: int
+WX_GL_SAMPLE_BUFFERS: int
+WX_GL_SAMPLES: int
+WX_GL_FRAMEBUFFER_SRGB: int
+WX_GL_MAJOR_VERSION: int
+WX_GL_MINOR_VERSION: int
+WX_GL_CORE_PROFILE: int
+WX_GL_COMPAT_PROFILE: int
+WX_GL_FORWARD_COMPAT: int
+WX_GL_ES2: int
+WX_GL_DEBUG: int
+WX_GL_ROBUST_ACCESS: int
+WX_GL_NO_RESET_NOTIFY: int
+WX_GL_LOSE_ON_RESET: int
+WX_GL_RESET_ISOLATION: int
+WX_GL_RELEASE_FLUSH: int
+WX_GL_RELEASE_NONE: int
+
+class GLAttribsBase(wx.siplib.wrapper):
+    """
+    GLAttribsBase() -> None
+    
+    This is the base class for wxGLAttributes and wxGLContextAttrs.
+    """
+
+    def __init__(self) -> None:
+        """
+        GLAttribsBase() -> None
+        
+        This is the base class for wxGLAttributes and wxGLContextAttrs.
+        """
+
+    def AddAttribute(self, attribute: int) -> None:
+        """
+        AddAttribute(attribute) -> None
+        
+        Adds an integer value to the list of attributes.
+        """
+
+    def AddAttribBits(self, searchVal: int, combineVal: int) -> None:
+        """
+        AddAttribBits(searchVal, combineVal) -> None
+        
+        Combine (bitwise OR) a given value with the existing one, if any.
+        """
+
+    def SetNeedsARB(self, needsARB: bool=True) -> None:
+        """
+        SetNeedsARB(needsARB=True) -> None
+        
+        Sets the necessity of using special ARB-functions (e.g.
+        """
+
+    def Reset(self) -> None:
+        """
+        Reset() -> None
+        
+        Delete contents and sets ARB-flag to false.
+        """
+
+    def GetSize(self) -> int:
+        """
+        GetSize() -> int
+        
+        Returns the size of the internal list of attributes.
+        """
+
+    def NeedsARB(self) -> bool:
+        """
+        NeedsARB() -> bool
+        
+        Returns the current value of the ARB-flag.
+        """
+    @property
+    def Size(self) -> int: ...
+# end of class GLAttribsBase
+
+
+class GLAttributes(GLAttribsBase):
+    """
+    This class is used for setting display attributes when drawing through
+    OpenGL ("Pixel format" in MSW and OSX parlance, "Configs" in X11).
+    """
+
+    def RGBA(self) -> GLAttributes:
+        """
+        RGBA() -> GLAttributes
+        
+        Use true colour instead of colour index rendering for each pixel.
+        """
+
+    def BufferSize(self, val: int) -> GLAttributes:
+        """
+        BufferSize(val) -> GLAttributes
+        
+        Specifies the number of bits for colour buffer.
+        """
+
+    def Level(self, val: int) -> GLAttributes:
+        """
+        Level(val) -> GLAttributes
+        
+        Specifies the framebuffer level.
+        """
+
+    def DoubleBuffer(self) -> GLAttributes:
+        """
+        DoubleBuffer() -> GLAttributes
+        
+        Requests using double buffering.
+        """
+
+    def Stereo(self) -> GLAttributes:
+        """
+        Stereo() -> GLAttributes
+        
+        Use stereoscopic display.
+        """
+
+    def AuxBuffers(self, val: int) -> GLAttributes:
+        """
+        AuxBuffers(val) -> GLAttributes
+        
+        Specifies the number of auxiliary buffers.
+        """
+
+    def MinRGBA(self, mRed: int, mGreen: int, mBlue: int, mAlpha: int) -> GLAttributes:
+        """
+        MinRGBA(mRed, mGreen, mBlue, mAlpha) -> GLAttributes
+        
+        Specifies the minimal number of bits for each colour and alpha.
+        """
+
+    def Depth(self, val: int) -> GLAttributes:
+        """
+        Depth(val) -> GLAttributes
+        
+        Specifies number of bits for Z-buffer.
+        """
+
+    def Stencil(self, val: int) -> GLAttributes:
+        """
+        Stencil(val) -> GLAttributes
+        
+        Specifies number of bits for stencil buffer.
+        """
+
+    def MinAcumRGBA(self, mRed: int, mGreen: int, mBlue: int, mAlpha: int) -> GLAttributes:
+        """
+        MinAcumRGBA(mRed, mGreen, mBlue, mAlpha) -> GLAttributes
+        
+        Specifies the minimal number of bits for each accumulator channel.
+        """
+
+    def SampleBuffers(self, val: int) -> GLAttributes:
+        """
+        SampleBuffers(val) -> GLAttributes
+        
+        Use multi-sampling support (antialiasing).
+        """
+
+    def Samplers(self, val: int) -> GLAttributes:
+        """
+        Samplers(val) -> GLAttributes
+        
+        Specifies the number of samplers per pixel.
+        """
+
+    def FrameBuffersRGB(self) -> GLAttributes:
+        """
+        FrameBuffersRGB() -> GLAttributes
+        
+        Used to request a frame buffer sRGB capable.
+        """
+
+    def PlatformDefaults(self) -> GLAttributes:
+        """
+        PlatformDefaults() -> GLAttributes
+        
+        Set some typically needed attributes.
+        """
+
+    def Defaults(self) -> GLAttributes:
+        """
+        Defaults() -> GLAttributes
+        
+        wxWidgets defaults: RGBA, Z-depth 16 bits, double buffering.
+        """
+
+    def EndList(self) -> None:
+        """
+        EndList() -> None
+        
+        The set of attributes must end with this one; otherwise, the GPU may
+        display nothing at all.
+        """
+# end of class GLAttributes
+
+
+class GLContextAttrs(GLAttribsBase):
+    """
+    This class is used for setting context attributes.
+    """
+
+    def CoreProfile(self) -> GLContextAttrs:
+        """
+        CoreProfile() -> GLContextAttrs
+        
+        Request an OpenGL core profile for the context.
+        """
+
+    def MajorVersion(self, val: int) -> GLContextAttrs:
+        """
+        MajorVersion(val) -> GLContextAttrs
+        
+        Request specific OpenGL core major version number (>= 3).
+        """
+
+    def MinorVersion(self, val: int) -> GLContextAttrs:
+        """
+        MinorVersion(val) -> GLContextAttrs
+        
+        Request specific OpenGL core minor version number.
+        """
+
+    def OGLVersion(self, vmayor: int, vminor: int) -> GLContextAttrs:
+        """
+        OGLVersion(vmayor, vminor) -> GLContextAttrs
+        
+        An easy way of requesting an OpenGL version.
+        """
+
+    def CompatibilityProfile(self) -> GLContextAttrs:
+        """
+        CompatibilityProfile() -> GLContextAttrs
+        
+        Request a type of context with all OpenGL features from version 1.0 to
+        the newest available by the GPU driver.
+        """
+
+    def ForwardCompatible(self) -> GLContextAttrs:
+        """
+        ForwardCompatible() -> GLContextAttrs
+        
+        Request a forward-compatible context.
+        """
+
+    def ES2(self) -> GLContextAttrs:
+        """
+        ES2() -> GLContextAttrs
+        
+        Request an ES or ES2 ("Embedded Subsystem") context.
+        """
+
+    def DebugCtx(self) -> GLContextAttrs:
+        """
+        DebugCtx() -> GLContextAttrs
+        
+        Request debugging functionality.
+        """
+
+    def Robust(self) -> GLContextAttrs:
+        """
+        Robust() -> GLContextAttrs
+        
+        Request robustness, or how OpenGL handles out-of-bounds buffer object
+        accesses and graphics reset notification behaviours.
+        """
+
+    def NoResetNotify(self) -> GLContextAttrs:
+        """
+        NoResetNotify() -> GLContextAttrs
+        
+        With robustness enabled, never deliver notification of reset events.
+        """
+
+    def LoseOnReset(self) -> GLContextAttrs:
+        """
+        LoseOnReset() -> GLContextAttrs
+        
+        With robustness enabled, if graphics reset happens, all context state
+        is lost.
+        """
+
+    def ResetIsolation(self) -> GLContextAttrs:
+        """
+        ResetIsolation() -> GLContextAttrs
+        
+        Request OpenGL to protect other applications or shared contexts from
+        reset side-effects.
+        """
+
+    def ReleaseFlush(self, val: int=1) -> GLContextAttrs:
+        """
+        ReleaseFlush(val=1) -> GLContextAttrs
+        
+        Request OpenGL to avoid or not flushing pending commands when the
+        context is made no longer current (released).
+        """
+
+    def PlatformDefaults(self) -> GLContextAttrs:
+        """
+        PlatformDefaults() -> GLContextAttrs
+        
+        Set platform specific defaults.
+        """
+
+    def EndList(self) -> None:
+        """
+        EndList() -> None
+        
+        The set of attributes must end with this one; otherwise, the GPU may
+        display nothing at all.
+        """
+# end of class GLContextAttrs
+
+
+class GLContext(wx.Object):
+    """
+    GLContext(win, other=None, ctxAttrs=None) -> None
+    
+    An instance of a wxGLContext represents the state of an OpenGL state
+    machine and the connection between OpenGL and the system.
+    """
+
+    def __init__(self, win: GLCanvas, other: Optional[GLContext]=None, ctxAttrs: Optional[GLContextAttrs]=None) -> None:
+        """
+        GLContext(win, other=None, ctxAttrs=None) -> None
+        
+        An instance of a wxGLContext represents the state of an OpenGL state
+        machine and the connection between OpenGL and the system.
+        """
+
+    def IsOK(self) -> bool:
+        """
+        IsOK() -> bool
+        
+        Checks if the underlying OpenGL rendering context was correctly
+        created by the system with the requested attributes.
+        """
+
+    def SetCurrent(self, win: GLCanvas) -> bool:
+        """
+        SetCurrent(win) -> bool
+        
+        Makes the OpenGL state that is represented by this rendering context
+        current with the wxGLCanvas win.
+        """
+
+    @staticmethod
+    def ClearCurrent() -> None:
+        """
+        ClearCurrent() -> None
+        
+        Clears any currently set context.
+        """
+# end of class GLContext
+
+
+class GLCanvas(wx.Window):
+    """
+    GLCanvas() -> None
+    GLCanvas(parent, dispAttrs, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name=GLCanvasName, palette=wx.NullPalette) -> None
+    GLCanvas(parent, id=wx.ID_ANY, attribList=None, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name='GLCanvas', palette=wx.NullPalette)
+    
+    wxGLCanvas is a class for displaying OpenGL graphics.
+    """
+
+    class SwapInterval(IntEnum):
+        NotSet = auto()
+        Set = auto()
+        NonAdaptive = auto()
+
+    @overload
+    def __init__(self, parent: wx.Window, dispAttrs: GLAttributes, id: int=wx.ID_ANY, pos: Union[wx.Point, _TwoInts]=wx.DefaultPosition, size: Union[wx.Size, _TwoInts]=wx.DefaultSize, style: int=0, name: str=GLCanvasName, palette: wx.Palette=wx.NullPalette) -> None:
+        ...
+
+    @overload
+    def __init__(self, parent: wx.Window, id: int=wx.ID_ANY, attribList: Optional[List[int]]=None, pos: Union[wx.Point, _TwoInts]=wx.DefaultPosition, size: Union[wx.Size, _TwoInts]=wx.DefaultSize, style: int=0, name: str="GLCanvas", palette: wx.Palette=wx.NullPalette) -> None:
+        ...
+
+    @overload
+    def __init__(self) -> None:
+        """
+        GLCanvas() -> None
+        GLCanvas(parent, dispAttrs, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name=GLCanvasName, palette=wx.NullPalette) -> None
+        GLCanvas(parent, id=wx.ID_ANY, attribList=None, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name='GLCanvas', palette=wx.NullPalette)
+        
+        wxGLCanvas is a class for displaying OpenGL graphics.
+        """
+    DefaultSwapInterval: int
+
+    def GetSwapInterval(self) -> int:
+        """
+        GetSwapInterval() -> int
+        
+        Return the current swap interval.
+        """
+
+    def SetColour(self, colour: str) -> bool:
+        """
+        SetColour(colour) -> bool
+        
+        Sets the current colour for this window (using glcolor3f()), using the
+        wxWidgets colour database to find a named colour.
+        """
+
+    def SetCurrent(self, context: GLContext) -> bool:
+        """
+        SetCurrent(context) -> bool
+        
+        Makes the OpenGL state that is represented by the OpenGL rendering
+        context context current, i.e.
+        """
+
+    def SetSwapInterval(self, interval: int) -> SwapInterval:
+        """
+        SetSwapInterval(interval) -> SwapInterval
+        
+        Set swap interval to the specified value.
+        """
+
+    def SwapBuffers(self) -> bool:
+        """
+        SwapBuffers() -> bool
+        
+        Swaps the double-buffer of this window, making the back-buffer the
+        front-buffer and vice versa, so that the output of the previous OpenGL
+        commands is displayed on the window.
+        """
+
+    @staticmethod
+    def GetGLXVersion() -> int:
+        """
+        GetGLXVersion() -> int
+        
+        Return the version of GLX being used or 0 if not using GLX.
+        """
+
+    @overload
+    @staticmethod
+    def IsDisplaySupported(attribList: List[int]) -> bool:
+        ...
+
+    @overload
+    @staticmethod
+    def IsDisplaySupported(dispAttrs: GLAttributes) -> bool:
+        """
+        IsDisplaySupported(dispAttrs) -> bool
+        IsDisplaySupported(attribList) -> bool
+        
+        Determines if a canvas having the specified attributes is available.
+        """
+
+    @staticmethod
+    def IsExtensionSupported(extension: str) -> bool:
+        """
+        IsExtensionSupported(extension) -> bool
+        
+        Returns true if the extension with given name is supported.
+        """
+
+    @staticmethod
+    def PreferGLX() -> None:
+        """
+        PreferGLX() -> None
+        
+        Prefer using GLX over other OpenGL implementations on Unix-like
+        systems where multiple implementations are available (such as GLX and
+        EGL).
+        """
+
+    @staticmethod
+    def GetClassDefaultAttributes(variant: Union[wx.WindowVariant, int]=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes:
+        """
+        GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes
+        """
+# end of class GLCanvas
+
+USE_GLCANVAS: int
+#-- end-_glcanvas --#