fake-bpy-module 20241103__py3-none-any.whl → 20241112__py3-none-any.whl

freestyle/utils/__init__.pyi

@@ -70,7 +70,7 @@ def integrate(
     it: freestyle.types.Interface0DIterator,
     it_end: freestyle.types.Interface0DIterator,
     integration_type: freestyle.types.IntegrationType,
-) -> float:
+):
     """Returns a single value from a set of values evaluated at each 0D
     element of this 1D element.
 
@@ -91,7 +91,6 @@ def integrate(
     value type is float if func is of the `UnaryFunction0DDouble`
     or `UnaryFunction0DFloat` type, and int if func is of the
     `UnaryFunction0DUnsigned` type.
-        :rtype: float
     """
 
 def is_poly_clockwise(stroke):

gpu/__init__.pyi

@@ -22,7 +22,13 @@ A batch contains the necessary data to perform the drawing.
 That includes an obligatory *Vertex Buffer* and an optional *Index Buffer*,
 each of which is described in more detail in the following sections.
 A batch also defines a draw type.
-Typical draw types are POINTS, LINES and TRIS.
+Typical draw types are POINTS
+
+, LINES
+
+ and TRIS
+
+.
 The draw type determines how the data will be interpreted and drawn.
 
 
@@ -78,7 +84,9 @@ indices = ((0, 1, 2), (2, 1, 3))
 ibo = gpu.types.GPUIndexBuf(type='TRIS', seq=indices)
 ```
 
-Here the first tuple in indices describes which vertices should be used for the first triangle
+Here the first tuple in indices
+
+ describes which vertices should be used for the first triangle
 (same for the second tuple).
 Note how the diagonal vertices 1 and 2 are shared between both triangles.
 
@@ -92,12 +100,18 @@ Typically multiple shaders are linked together into a *Program*.
 However, in the Blender Python API the term *Shader* refers to an OpenGL Program.
 Every gpu.types.GPUShader consists of a vertex shader, a fragment shader and an optional geometry shader.
 For common drawing tasks there are some built-in shaders accessible from gpu.shader.from_builtin
-with an identifier such as UNIFORM_COLOR or FLAT_COLOR.
+with an identifier such as UNIFORM_COLOR
+
+ or FLAT_COLOR
+
+.
 
 Every shader defines a set of attributes and uniforms that have to be set in order to use the shader.
 Attributes are properties that are set using a vertex buffer and can be different for individual vertices.
 Uniforms are properties that are constant per draw call.
-They can be set using the shader.uniform_* functions after the shader has been bound.
+They can be set using the shader.uniform_*
+
+ functions after the shader has been bound.
 
 
 --------------------
@@ -123,7 +137,7 @@ This is called Offscreen Rendering.
 In Blender Offscreen Rendering is done using the gpu.types.GPUOffScreen type.
 
 [WARNING]
-GPUOffScreen objects are bound to the OpenGL context they have been created in.
+gpu.types.GPUOffScreen objects are bound to the OpenGL context they have been created in.
 This means that once Blender discards this context (i.e. the window is closed),
 the offscreen instance will be freed.
 

gpu/matrix/__init__.pyi

@@ -86,7 +86,7 @@ def reset():
 def scale(scale):
     """Scale the current stack matrix.
 
-    :param scale: Scale the current stack matrix.
+    :param scale: Scale the current stack matrix with 2 or 3 floats.
     """
 
 def scale_uniform(scale: float):
@@ -99,5 +99,5 @@ def scale_uniform(scale: float):
 def translate(offset):
     """Scale the current stack matrix.
 
-    :param offset: Translate the current stack matrix.
+    :param offset: Translate the current stack matrix with 2 or 3 floats.
     """

gpu/state/__init__.pyi

@@ -17,14 +17,22 @@ def blend_set(mode: str):
     """Defines the fixed pipeline blending equation.
 
         :param mode: The type of blend mode.
-    * NONE No blending.
-    * ALPHA The original color channels are interpolated according to the alpha value.
-    * ALPHA_PREMULT The original color channels are interpolated according to the alpha value with the new colors pre-multiplied by this value.
-    * ADDITIVE The original color channels are added by the corresponding ones.
-    * ADDITIVE_PREMULT The original color channels are added by the corresponding ones that are pre-multiplied by the alpha value.
-    * MULTIPLY The original color channels are multiplied by the corresponding ones.
-    * SUBTRACT The original color channels are subtracted by the corresponding ones.
-    * INVERT The original color channels are replaced by its complementary color.
+
+    NONE No blending.
+
+    ALPHA The original color channels are interpolated according to the alpha value.
+
+    ALPHA_PREMULT The original color channels are interpolated according to the alpha value with the new colors pre-multiplied by this value.
+
+    ADDITIVE The original color channels are added by the corresponding ones.
+
+    ADDITIVE_PREMULT The original color channels are added by the corresponding ones that are pre-multiplied by the alpha value.
+
+    MULTIPLY The original color channels are multiplied by the corresponding ones.
+
+    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
     """
 

gpu/types/__init__.pyi

@@ -41,8 +41,7 @@ class GPUBatch:
     def draw_range(
         self, program: GPUShader, *, elem_start: int = 0, elem_count: int = 0
     ):
-        """Run the drawing program with the parameters assigned to the batch. Only draw
-        the elem_count elements of the index buffer starting at elem_start
+        """Run the drawing program with the parameters assigned to the batch. Only draw the elem_count elements of the index buffer starting at elem_start.
 
                 :param program: Program that performs the drawing operations.
                 :type program: GPUShader
@@ -93,7 +92,7 @@ class GPUFrameBuffer:
         """Fill color, depth and stencil textures with specific value.
         Common values: color=(0.0, 0.0, 0.0, 1.0), depth=1.0, stencil=0.
 
-                :param color: float sequence each representing (r, g, b, a).
+                :param color: Sequence of 3 or 4 floats representing (r, g, b, a).
                 :param depth: depth value.
                 :type depth: float | None
                 :param stencil: stencil value.
@@ -272,11 +271,10 @@ class GPUShader:
         :rtype: int
         """
 
-    def attrs_info_get(self) -> tuple:
+    def attrs_info_get(self):
         """Information about the attributes used in the Shader.
 
         :return: tuples containing information about the attributes in order (name, type)
-        :rtype: tuple
         """
 
     def bind(self):
@@ -315,22 +313,20 @@ class GPUShader:
         :rtype: int
         """
 
-    def uniform_bool(self, name: str, value: bool):
+    def uniform_bool(self, name: str, value):
         """Specify the value of a uniform variable for the current program object.
 
         :param name: Name of the uniform variable whose value is to be changed.
         :type name: str
         :param value: Value that will be used to update the specified uniform variable.
-        :type value: bool
         """
 
-    def uniform_float(self, name: str, value: list[float]):
+    def uniform_float(self, name: str, value):
         """Specify the value of a uniform variable for the current program object.
 
         :param name: Name of the uniform variable whose value is to be changed.
         :type name: str
         :param value: Value that will be used to update the specified uniform variable.
-        :type value: list[float]
         """
 
     def uniform_from_name(self, name: str) -> int:
@@ -342,13 +338,12 @@ class GPUShader:
         :rtype: int
         """
 
-    def uniform_int(self, name: str, seq: list[int]):
+    def uniform_int(self, name: str, seq):
         """Specify the value of a uniform variable for the current program object.
 
         :param name: name of the uniform variable whose value is to be changed.
         :type name: str
         :param seq: Value that will be used to update the specified uniform variable.
-        :type seq: list[int]
         """
 
     def uniform_sampler(self, name: str, texture: GPUTexture):
@@ -360,15 +355,12 @@ class GPUShader:
         :type texture: GPUTexture
         """
 
-    def uniform_vector_float(
-        self, location: int, buffer: list[float], length: int, count: int
-    ):
+    def uniform_vector_float(self, location: int, buffer, length: int, count: int):
         """Set the buffer to fill the uniform.
 
                 :param location: Location of the uniform variable to be modified.
                 :type location: int
                 :param buffer: The data that should be set. Can support the buffer protocol.
-                :type buffer: list[float]
                 :param length: Size of the uniform data type:
 
         1: float
@@ -464,12 +456,7 @@ class GPUShaderCreateInfo:
         """
 
     def image(
-        self,
-        slot: int,
-        format: str,
-        type: str,
-        name: str,
-        qualifiers: set = {"NO_RESTRICT"},
+        self, slot: int, format: str, type: str, name: str, qualifiers={"NO_RESTRICT"}
     ):
         """Specify an image resource used for arbitrary load and store operations.
 
@@ -637,7 +624,6 @@ class GPUShaderCreateInfo:
         - NO_RESTRICT
         - READ
         - WRITE
-                :type qualifiers: set
         """
 
     def local_group_size(self, x: int, y: int = -1, z: int = -1):
@@ -651,7 +637,7 @@ class GPUShaderCreateInfo:
         :type z: int
         """
 
-    def push_constant(self, type: str, name: str, size=0):
+    def push_constant(self, type: str, name: str, size: int = 0):
         """Specify a global access constant.
 
                 :param type: One of these types:
@@ -689,6 +675,7 @@ class GPUShaderCreateInfo:
                 :param name: Name of the constant.
                 :type name: str
                 :param size: If not zero, indicates that the constant is an array with the specified size.
+                :type size: int
         """
 
     def sampler(self, slot: int, type: str, name: str):
@@ -773,7 +760,7 @@ class GPUShaderCreateInfo:
         """
 
     def uniform_buf(self, slot: int, type_name: str, name: str):
-        """Specify a uniform variable whose type can be one of those declared in typedef_source.
+        """Specify a uniform variable whose type can be one of those declared in `gpu.types.GPUShaderCreateInfo.typedef_source`.
 
         :param slot: The uniform variable index.
         :type slot: int
@@ -991,7 +978,7 @@ class GPUTexture:
                 :param format: The format that describes the content of a single item.
         Possible values are FLOAT, INT, UINT, UBYTE, UINT_24_8 and 10_11_11_REV.
                 :type format: str
-                :param value: sequence each representing the value to fill.
+                :param value: Sequence each representing the value to fill. Sizes 1..4 are supported.
         """
 
     def read(self):
@@ -1009,13 +996,11 @@ class GPUUniformBuf:
 class GPUVertBuf:
     """Contains a VBO."""
 
-    def attr_fill(self, id: int | str, data: list[float]):
+    def attr_fill(self, id, data):
         """Insert data into the buffer for a single attribute.
 
         :param id: Either the name or the id of the attribute.
-        :type id: int | str
-        :param data: Sequence of data that should be stored in the buffer
-        :type data: list[float]
+        :param data: Buffer or sequence of data that should be stored in the buffer
         """
 
 class GPUVertFormat:

gpu_extras/batch/__init__.pyi

@@ -4,16 +4,16 @@ import typing_extensions
 import gpu.types
 
 def batch_for_shader(
-    shader: gpu.types.GPUShader, type: str, content: dict, *, indices=None
+    shader: gpu.types.GPUShader, type: str, content, *, indices=None
 ) -> gpu.types.GPUBatch:
     """Return a batch already configured and compatible with the shader.
 
-    :param shader: shader for which a compatible format will be computed.
-    :type shader: gpu.types.GPUShader
-    :param type: "'POINTS', 'LINES', 'TRIS' or 'LINES_ADJ'".
-    :type type: str
-    :param content: Maps the name of the shader attribute with the data to fill the vertex buffer.
-    :type content: dict
-    :return: compatible batch
-    :rtype: gpu.types.GPUBatch
+        :param shader: shader for which a compatible format will be computed.
+        :type shader: gpu.types.GPUShader
+        :param type: "'POINTS', 'LINES', 'TRIS' or 'LINES_ADJ'".
+        :type type: str
+        :param content: Maps the name of the shader attribute with the data to fill the vertex buffer.
+    For the dictionary values see documentation for `gpu.types.GPUVertBuf.attr_fill` data argument.
+        :return: compatible batch
+        :rtype: gpu.types.GPUBatch
     """

gpu_extras/presets/__init__.pyi

@@ -4,24 +4,17 @@ import typing_extensions
 import gpu.types
 import mathutils
 
-def draw_circle_2d(
-    position: collections.abc.Sequence[float] | mathutils.Vector,
-    color,
-    radius: float,
-    *,
-    segments: int | None = None,
-):
+def draw_circle_2d(position, color, radius: float, *, segments=None):
     """Draw a circle.
 
-        :param position: Position where the circle will be drawn.
-        :type position: collections.abc.Sequence[float] | mathutils.Vector
-        :param color: Color of the circle. To use transparency GL_BLEND has to be enabled.
+        :param position: 2D position where the circle will be drawn.
+        :param color: Color of the circle (RGBA).
+    To use transparency blend must be set to ALPHA, see: `gpu.state.blend_set`.
         :param radius: Radius of the circle.
         :type radius: float
         :param segments: How many segments will be used to draw the circle.
     Higher values give better results but the drawing will take longer.
     If None or not specified, an automatic value will be calculated.
-        :type segments: int | None
     """
 
 def draw_texture_2d(

idprop/types/__init__.pyi

@@ -40,11 +40,10 @@ class IDPropertyGroup:
     def to_dict(self):
         """Return a purely Python version of the group."""
 
-    def update(self, other: dict | typing_extensions.Self):
+    def update(self, other):
         """Update key, values.
 
         :param other: Updates the values in the group with this.
-        :type other: dict | typing_extensions.Self
         """
 
     def values(self):

imbuf/__init__.pyi

@@ -18,11 +18,10 @@ import imbuf.types
 
 from . import types as types
 
-def load(filepath: bytes | str) -> imbuf.types.ImBuf:
+def load(filepath) -> imbuf.types.ImBuf:
     """Load an image from a file.
 
     :param filepath: the filepath of the image.
-    :type filepath: bytes | str
     :return: the newly loaded image.
     :rtype: imbuf.types.ImBuf
     """
@@ -35,11 +34,10 @@ def new(size) -> imbuf.types.ImBuf:
     :rtype: imbuf.types.ImBuf
     """
 
-def write(image: imbuf.types.ImBuf, filepath: bytes | str = image.filepath):
+def write(image: imbuf.types.ImBuf, filepath=image.filepath):
     """Write an image.
 
     :param image: the image to write.
     :type image: imbuf.types.ImBuf
     :param filepath: Optional filepath of the image (fallback to the images file path).
-    :type filepath: bytes | str
     """