fake-bge-module 20250317__py3-none-any.whl → 20260201__py3-none-any.whl

gpu/platform/__init__.pyi

@@ -6,38 +6,34 @@ This module provides access to GPU Platform definitions.
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 
 def backend_type_get() -> str:
     """Get actuve GPU backend.
 
-    :return: Backend type ('OPENGL', 'VULKAN', 'METAL', 'NONE', 'UNKNOWN').
-    :rtype: str
+    :return: Backend type (OPENGL, VULKAN, METAL, NONE, UNKNOWN).
     """
 
 def device_type_get() -> str:
     """Get GPU device type.
 
-    :return: Device type ('APPLE', 'NVIDIA', 'AMD', 'INTEL', 'SOFTWARE', 'QUALCOMM', 'UNKNOWN').
-    :rtype: str
+    :return: Device type (APPLE, NVIDIA, AMD, INTEL, SOFTWARE, QUALCOMM, UNKNOWN).
     """
 
 def renderer_get() -> str:
     """Get GPU to be used for rendering.
 
     :return: GPU name.
-    :rtype: str
     """
 
 def vendor_get() -> str:
     """Get GPU vendor.
 
     :return: Vendor name.
-    :rtype: str
     """
 
 def version_get() -> str:
     """Get GPU driver version.
 
     :return: Driver version.
-    :rtype: str
     """

gpu/select/__init__.pyi

@@ -6,8 +6,9 @@ This module provides access to selection.
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 
-def load_id(id):
+def load_id(id) -> None:
     """Set the selection ID.
 
     :param id: Number (32-bit uint).

gpu/shader/__init__.pyi

@@ -9,6 +9,9 @@ All built-in shaders have the mat4 ModelViewProjectionMatrix
 
 Its value must be modified using the gpu.matrix module.
 
+[IMPORTANT]
+Shader uniforms must be explicitly initialized to avoid retaining values from previous executions.
+
 FLAT_COLOR
 
 
@@ -25,6 +28,15 @@ IMAGE
 
 
 
+IMAGE_SCENE_LINEAR_TO_REC709_SRGB
+
+
+    Attributes: vec3 pos, vec2 texCoord
+    Uniforms: sampler2D image
+    Note: Expect texture to be in scene linear color space
+
+
+
 IMAGE_COLOR
 
 
@@ -33,6 +45,15 @@ IMAGE_COLOR
 
 
 
+IMAGE_COLOR_SCENE_LINEAR_TO_REC709_SRGB
+
+
+    Attributes: vec3 pos, vec2 texCoord
+    Uniforms: sampler2D image, vec4 color
+    Note: Expect texture to be in scene linear color space
+
+
+
 SMOOTH_COLOR
 
 
@@ -69,7 +90,23 @@ POLYLINE_UNIFORM_COLOR
 
 
     Attributes: vec3 pos
-    Uniforms: vec2 viewportSize, float lineWidth
+    Uniforms: vec2 viewportSize, float lineWidth, vec4 color
+
+
+
+POINT_FLAT_COLOR
+
+
+    Attributes: vec3 pos, vec4 color
+    Uniforms: float size
+
+
+
+POINT_UNIFORM_COLOR
+
+
+    Attributes: vec3 pos
+    Uniforms: vec4 color, float size
 
 
 
@@ -78,32 +115,29 @@ POLYLINE_UNIFORM_COLOR
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 import gpu.types
 
-def create_from_info(shader_info) -> gpu.types.GPUShader:
+def create_from_info(shader_info: gpu.types.GPUShaderCreateInfo) -> gpu.types.GPUShader:
     """Create shader from a GPUShaderCreateInfo.
 
     :param shader_info: GPUShaderCreateInfo
-    :return: Shader object corresponding to the given name.
-    :rtype: gpu.types.GPUShader
+    :return: Shader object corresponding to the given shader info.
     """
 
-def from_builtin(shader_name: str, config: str = "DEFAULT") -> gpu.types.GPUShader:
+def from_builtin(shader_name: str, *, config: str = "DEFAULT") -> gpu.types.GPUShader:
     """Shaders that are embedded in the blender internal code (see `built-in-shaders`).
     They all read the uniform mat4 ModelViewProjectionMatrix,
     which can be edited by the `gpu.matrix` module.You can also choose a shader configuration that uses clip_planes by setting the CLIPPED value to the config parameter. Note that in this case you also need to manually set the value of mat4 ModelMatrix.
 
         :param shader_name: One of the builtin shader names.
-        :type shader_name: str
         :param config: One of these types of shader configuration:
 
     DEFAULT
 
     CLIPPED
-        :type config: str
         :return: Shader object corresponding to the given name.
-        :rtype: gpu.types.GPUShader
     """
 
-def unbind():
+def unbind() -> None:
     """Unbind the bound shader object."""

gpu/state/__init__.pyi

@@ -6,14 +6,22 @@ This module provides access to the gpu state.
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
+import gpu.types
 
-def active_framebuffer_get(enable):
-    """Return the active frame-buffer in context."""
+def active_framebuffer_get() -> gpu.types.GPUFrameBuffer:
+    """Return the active frame-buffer in context.
 
-def blend_get():
-    """Current blending equation."""
+    :return: The active framebuffer.
+    """
+
+def blend_get() -> str:
+    """Current blending equation.
+
+    :return: The current blend mode.
+    """
 
-def blend_set(mode: str):
+def blend_set(mode: str) -> None:
     """Defines the fixed pipeline blending equation.
 
         :param mode: The type of blend mode.
@@ -33,109 +41,123 @@ def blend_set(mode: str):
     SUBTRACT The original color channels are subtracted by the corresponding ones.
 
     INVERT The original color channels are replaced by its complementary color.
-        :type mode: str
     """
 
-def clip_distances_set(distances_enabled: int):
+def clip_distances_set(distances_enabled: int) -> None:
     """Sets the number of gl_ClipDistance planes used for clip geometry.
 
     :param distances_enabled: Number of clip distances enabled.
-    :type distances_enabled: int
     """
 
-def color_mask_set(r: bool, g, b, a):
+def color_mask_set(r: bool, g: bool, b: bool, a: bool) -> None:
     """Enable or disable writing of frame buffer color components.
 
-    :param r: components red, green, blue, and alpha.
-    :type r: bool
+    :param r: Red component.
+    :param g: Green component.
+    :param b: Blue component.
+    :param a: Alpha component.
     """
 
-def depth_mask_get():
-    """Writing status in the depth component."""
+def depth_mask_get() -> bool:
+    """Writing status in the depth component.
 
-def depth_mask_set(value):
+    :return: True if writing to the depth component is enabled.
+    """
+
+def depth_mask_set(value: bool) -> None:
     """Write to depth component.
 
     :param value: True for writing to the depth component.
     """
 
-def depth_test_get():
-    """Current depth_test equation."""
+def depth_test_get() -> str:
+    """Current depth_test equation.
+
+    :return: The current depth test mode.
+    """
 
-def depth_test_set(mode: str):
+def depth_test_set(mode: str) -> None:
     """Defines the depth_test equation.
 
         :param mode: The depth test equation name.
     Possible values are NONE, ALWAYS, LESS, LESS_EQUAL, EQUAL, GREATER and GREATER_EQUAL.
-        :type mode: str
     """
 
-def face_culling_set(culling):
-    """Specify whether none, front-facing or back-facing facets can be culled."""
+def face_culling_set(culling: str) -> None:
+    """Specify whether none, front-facing or back-facing facets can be culled.
 
-def front_facing_set(invert):
+    :param culling: NONE, FRONT or BACK.
+    """
+
+def front_facing_set(invert: bool) -> None:
     """Specifies the orientation of front-facing polygons.
 
     :param invert: True for clockwise polygons as front-facing.
     """
 
-def line_width_get():
-    """Current width of rasterized lines."""
+def line_width_get() -> float:
+    """Current width of rasterized lines.
+
+    :return: The current line width.
+    """
+
+def line_width_set(width: float) -> None:
+    """Specify the width of rasterized lines.
 
-def line_width_set(width):
-    """Specify the width of rasterized lines."""
+    :param width: New width.
+    """
 
-def point_size_set(size):
+def point_size_set(size: float) -> None:
     """Specify the diameter of rasterized points.
 
     :param size: New diameter.
     """
 
-def program_point_size_set(enable: bool):
+def program_point_size_set(enable: bool) -> None:
     """If enabled, the derived point size is taken from the (potentially clipped) shader builtin gl_PointSize.
 
     :param enable: True for shader builtin gl_PointSize.
-    :type enable: bool
     """
 
 def scissor_get() -> tuple[int, int, int, int]:
     """Retrieve the scissors of the active framebuffer.
-    Note: Only valid between 'scissor_set' and a framebuffer rebind.
+    Note: Only valid between scissor_set and a framebuffer rebind.
 
         :return: The scissor of the active framebuffer as a tuple
     (x, y, xsize, ysize).
     x, y: lower left corner of the scissor rectangle, in pixels.
     xsize, ysize: width and height of the scissor rectangle.
-        :rtype: tuple[int, int, int, int]
     """
 
-def scissor_set(x: int, y, xsize: int, ysize):
+def scissor_set(x: int, y: int, xsize: int, ysize: int) -> None:
     """Specifies the scissor area of the active framebuffer.
     Note: The scissor state is not saved upon framebuffer rebind.
 
-        :param x: lower left corner of the scissor rectangle, in pixels.
-        :type x: int
-        :param xsize: width and height of the scissor rectangle.
-        :type xsize: int
+        :param x: Lower left corner x coordinate, in pixels.
+        :param y: Lower left corner y coordinate, in pixels.
+        :param xsize: Width of the scissor rectangle.
+        :param ysize: Height of the scissor rectangle.
     """
 
-def scissor_test_set(enable: bool):
+def scissor_test_set(enable: bool) -> None:
     """Enable/disable scissor testing on the active framebuffer.
 
         :param enable: True - enable scissor testing.
     False - disable scissor testing.
-        :type enable: bool
     """
 
-def viewport_get():
-    """Viewport of the active framebuffer."""
+def viewport_get() -> tuple[int, int, int, int]:
+    """Viewport of the active framebuffer.
+
+    :return: The viewport as a tuple (x, y, xsize, ysize).
+    """
 
-def viewport_set(x: int, y, xsize: int, ysize):
+def viewport_set(x: int, y: int, xsize: int, ysize: int) -> None:
     """Specifies the viewport of the active framebuffer.
     Note: The viewport state is not saved upon framebuffer rebind.
 
-        :param x: lower left corner of the viewport_set rectangle, in pixels.
-        :type x: int
-        :param xsize: width and height of the viewport_set.
-        :type xsize: int
+        :param x: Lower left corner x coordinate, in pixels.
+        :param y: Lower left corner y coordinate, in pixels.
+        :param xsize: Width of the viewport.
+        :param ysize: Height of the viewport.
     """

gpu/texture/__init__.pyi

@@ -1,20 +1,19 @@
 """
-This module provides utils for textures.
+This module provides utilities for textures.
 
 """
 
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 import bpy.types
 import gpu.types
 
 def from_image(image: bpy.types.Image) -> gpu.types.GPUTexture:
-    """Get GPUTexture corresponding to an Image datablock. The GPUTexture memory is shared with Blender.
+    """Get GPUTexture corresponding to an Image data-block. The GPUTexture memory is shared with Blender.
     Note: Colors read from the texture will be in scene linear color space and have premultiplied or straight alpha matching the image alpha mode.
 
-        :param image: The Image datablock.
-        :type image: bpy.types.Image
+        :param image: The Image data-block.
         :return: The GPUTexture used by the image.
-        :rtype: gpu.types.GPUTexture
     """