fake-bpy-module 20250828__py3-none-any.whl → 20260118__py3-none-any.whl

gpu/types/__init__.pyi

@@ -14,7 +14,7 @@ class Buffer:
 class GPUBatch:
     """Reusable container for drawable geometry."""
 
-    def draw(self, shader=None) -> None:
+    def draw(self, shader: GPUShader | None = None) -> None:
         """Run the drawing shader with the parameters assigned to the batch.
 
                 :param shader: Shader that performs the drawing operations.
@@ -29,13 +29,10 @@ class GPUBatch:
         number being drawn.
 
                 :param program: Program that performs the drawing operations.
-                :type program: GPUShader
                 :param instance_start: Number of the first instance to draw.
-                :type instance_start: int
                 :param instance_count: Number of instances to draw. When not provided or set to 0
         the number of instances will be determined by the number of rows in the first
         vertex buffer.
-                :type instance_count: int
         """
 
     def draw_range(
@@ -44,14 +41,11 @@ class GPUBatch:
         """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
                 :param elem_start: First index to draw. When not provided or set to 0 drawing
         will start from the first element of the index buffer.
-                :type elem_start: int
                 :param elem_count: Number of elements of the index buffer to draw. When not
         provided or set to 0 all elements from elem_start to the end of the
         index buffer will be drawn.
-                :type elem_count: int
         """
 
     def program_set(self, program: GPUShader) -> None:
@@ -61,7 +55,6 @@ class GPUBatch:
         set the shader when calling `gpu.types.GPUBatch.draw`.
 
                 :param program: The program/shader the batch will use in future draw calls.
-                :type program: GPUShader
         """
 
     def vertbuf_add(self, buf: GPUVertBuf) -> None:
@@ -73,7 +66,6 @@ class GPUBatch:
         Current a batch can have at most GPU_BATCH_VBO_MAX_LEN vertex buffers.
 
                 :param buf: The vertex buffer that will be added to the batch.
-                :type buf: GPUVertBuf
         """
 
 class GPUFrameBuffer:
@@ -99,11 +91,8 @@ class GPUFrameBuffer:
         Common values: color=(0.0, 0.0, 0.0, 1.0), depth=1.0, stencil=0.
 
                 :param color: Sequence of 3 or 4 floats representing (r, g, b, a).
-                :type color: collections.abc.Sequence[float] | None
                 :param depth: depth value.
-                :type depth: float | None
                 :param stencil: stencil value.
-                :type stencil: int | None
         """
 
     def read_color(
@@ -116,44 +105,34 @@ class GPUFrameBuffer:
         slot: int,
         format: str,
         *,
-        data: Buffer = data,
+        data: Buffer | None = None,
     ) -> Buffer:
         """Read a block of pixels from the frame buffer.
 
                 :param x: Lower left corner of a rectangular block of pixels.
-                :type x: int
                 :param y:
                 :param xsize: Dimensions of the pixel rectangle.
                 :param ysize:
                 :param channels: Number of components to read.
-                :type channels: int
                 :param slot: The framebuffer slot to read data from.
-                :type slot: int
                 :param format: The format that describes the content of a single channel.
         Possible values are FLOAT, INT, UINT, UBYTE, UINT_24_8 & 10_11_11_REV.
         UINT_24_8 is deprecated, use FLOAT instead.
-                :type format: str
                 :param data: Optional Buffer object to fill with the pixels values.
-                :type data: Buffer
                 :return: The Buffer with the read pixels.
-                :rtype: Buffer
         """
 
     def read_depth(
-        self, x: int, y, xsize: int, ysize, *, data: Buffer = data
+        self, x: int, y, xsize: int, ysize, *, data: Buffer | None = None
     ) -> Buffer:
         """Read a pixel depth block from the frame buffer.
 
         :param x: Lower left corner of a rectangular block of pixels.
-        :type x: int
         :param y:
         :param xsize: Dimensions of the pixel rectangle.
-        :type xsize: int
         :param ysize:
         :param data: Optional Buffer object to fill with the pixels values.
-        :type data: Buffer
         :return: The Buffer with the read pixels.
-        :rtype: Buffer
         """
 
     def viewport_get(self) -> None:
@@ -164,10 +143,8 @@ class GPUFrameBuffer:
         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 y:
                 :param xsize: width and height of the viewport_set.
-                :type xsize: int
                 :param ysize:
         """
 
@@ -178,22 +155,13 @@ class GPUOffScreen:
     """This object gives access to off screen buffers."""
 
     height: int
-    """ Height of the texture.
-
-    :type: int
-    """
+    """ Height of the texture."""
 
     texture_color: GPUTexture
-    """ The color texture attached.
-
-    :type: GPUTexture
-    """
+    """ The color texture attached."""
 
     width: int
-    """ Width of the texture.
-
-    :type: int
-    """
+    """ Width of the texture."""
 
     def bind(self) -> None:
         """Context manager to ensure balanced bind calls, even in the case of an error."""
@@ -215,21 +183,13 @@ class GPUOffScreen:
         """Draw the 3d viewport in the offscreen object.
 
         :param scene: Scene to draw.
-        :type scene: bpy.types.Scene
         :param view_layer: View layer to draw.
-        :type view_layer: bpy.types.ViewLayer
         :param view3d: 3D View to get the drawing settings from.
-        :type view3d: bpy.types.SpaceView3D
         :param region: Region of the 3D View (required as temporary draw target).
-        :type region: bpy.types.Region
         :param view_matrix: View Matrix (e.g. camera.matrix_world.inverted()).
-        :type view_matrix: collections.abc.Sequence[collections.abc.Sequence[float]] | mathutils.Matrix
         :param projection_matrix: Projection Matrix (e.g. camera.calc_matrix_camera(...)).
-        :type projection_matrix: collections.abc.Sequence[collections.abc.Sequence[float]] | mathutils.Matrix
         :param do_color_management: Color manage the output.
-        :type do_color_management: bool
         :param draw_background: Draw background.
-        :type draw_background: bool
         """
 
     def free(self) -> None:
@@ -242,37 +202,27 @@ class GPUOffScreen:
         """Unbind the offscreen object.
 
         :param restore: Restore the OpenGL state, can only be used when the state has been saved before.
-        :type restore: bool
         """
 
 class GPUShader:
     name: str
-    """ The name of the shader object for debugging purposes (read-only).
-
-    :type: str
-    """
+    """ The name of the shader object for debugging purposes (read-only)."""
 
     program: int
     """ The name of the program object for use by the OpenGL API (read-only).
-This is deprecated and will always return -1.
-
-    :type: int
-    """
+This is deprecated and will always return -1."""
 
     def attr_from_name(self, name: str) -> int:
         """Get attribute location by name.
 
         :param name: The name of the attribute variable whose location is to be queried.
-        :type name: str
         :return: The location of an attribute variable.
-        :rtype: int
         """
 
     def attrs_info_get(self) -> tuple[tuple[str, str | None], ...]:
         """Information about the attributes used in the Shader.
 
         :return: tuples containing information about the attributes in order (name, type)
-        :rtype: tuple[tuple[str, str | None], ...]
         """
 
     def bind(self) -> None:
@@ -282,23 +232,19 @@ This is deprecated and will always return -1.
         """Build a new format based on the attributes of the shader.
 
         :return: vertex attribute format for the shader
-        :rtype: GPUVertFormat
         """
 
     def image(self, name: str, texture: GPUTexture) -> None:
         """Specify the value of an image variable for the current GPUShader.
 
         :param name: Name of the image variable to which the texture is to be bound.
-        :type name: str
         :param texture: Texture to attach.
-        :type texture: GPUTexture
         """
 
-    def uniform_block(self, name: str, ubo) -> None:
-        """Specify the value of an uniform buffer object variable for the current GPUShader.
+    def uniform_block(self, name: str, ubo: GPUUniformBuf) -> None:
+        """Specify the value of a uniform buffer object variable for the current GPUShader.
 
-        :param name: name of the uniform variable whose UBO is to be specified.
-        :type name: str
+        :param name: Name of the uniform variable whose UBO is to be specified.
         :param ubo: Uniform Buffer to attach.
         """
 
@@ -306,9 +252,7 @@ This is deprecated and will always return -1.
         """Get uniform block location by name.
 
         :param name: Name of the uniform block variable whose location is to be queried.
-        :type name: str
         :return: The location of the uniform block variable.
-        :rtype: int
         """
 
     def uniform_bool(
@@ -317,9 +261,7 @@ This is deprecated and will always return -1.
         """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 | collections.abc.Sequence[bool]
         """
 
     def uniform_float(
@@ -328,36 +270,28 @@ This is deprecated and will always return -1.
         """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: collections.abc.Sequence[float] | float
         """
 
     def uniform_from_name(self, name: str) -> int:
         """Get uniform location by name.
 
         :param name: Name of the uniform variable whose location is to be queried.
-        :type name: str
         :return: Location of the uniform variable.
-        :rtype: int
         """
 
-    def uniform_int(self, name: str, seq: collections.abc.Sequence[int]) -> None:
+    def uniform_int(self, name: str, seq: collections.abc.Sequence[int] | int) -> None:
         """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 name: Name of the uniform variable whose value is to be changed.
         :param seq: Value that will be used to update the specified uniform variable.
-        :type seq: collections.abc.Sequence[int]
         """
 
     def uniform_sampler(self, name: str, texture: GPUTexture) -> None:
         """Specify the value of a texture uniform variable for the current GPUShader.
 
-        :param name: name of the uniform variable whose texture is to be specified.
-        :type name: str
+        :param name: Name of the uniform variable whose texture is to be specified.
         :param texture: Texture to attach.
-        :type texture: GPUTexture
         """
 
     def uniform_vector_float(
@@ -370,9 +304,7 @@ This is deprecated and will always return -1.
         """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: collections.abc.Sequence[float]
                 :param length: Size of the uniform data type:
 
         1: float
@@ -386,18 +318,18 @@ This is deprecated and will always return -1.
         9: mat3
 
         16: mat4
-                :type length: int
                 :param count: Specifies the number of elements, vector or matrices that are to be modified.
-                :type count: int
         """
 
-    def uniform_vector_int(self, location, buffer, length, count) -> None:
-        """See GPUShader.uniform_vector_float(...) description.
+    def uniform_vector_int(
+        self, location: int, buffer, length: int, count: int
+    ) -> None:
+        """Set the buffer to fill the uniform.
 
-        :param location:
-        :param buffer:
-        :param length:
-        :param count:
+        :param location: Location of the uniform variable to be modified.
+        :param buffer: Buffer object with format matching the uniform.
+        :param length: Size of the uniform data type.
+        :param count: Specifies the number of elements that are to be modified.
         """
 
 class GPUShaderCreateInfo:
@@ -407,19 +339,16 @@ class GPUShaderCreateInfo:
         """compute shader source code written in GLSL.Example:`GLSL Cross Compilation <https://developer.blender.org/docs/features/gpu/glsl_cross_compilation/>`__
 
         :param source: The compute shader source code.
-        :type source: str
         """
 
     def define(self, name: str, value: str) -> None:
         """Add a preprocessing define directive. In GLSL it would be something like:
 
         :param name: Token name.
-        :type name: str
         :param value: Text that replaces token occurrences.
-        :type value: str
         """
 
-    def depth_write(self, value) -> None:
+    def depth_write(self, value: str) -> None:
         """Specify a depth write behavior when modifying gl_FragDepth.There is a common optimization for GPUs that relies on an early depth
         test to be run before the fragment shader so that the shader evaluation
         can be skipped if the fragment ends up being discarded because it is occluded.This optimization does not affect the final rendering, and is typically
@@ -441,7 +370,6 @@ class GPUShaderCreateInfo:
         """Specify a fragment output corresponding to a framebuffer target slot.
 
                 :param slot: The attribute index.
-                :type slot: int
                 :param type: One of these types:
 
         FLOAT
@@ -473,18 +401,14 @@ class GPUShaderCreateInfo:
         IVEC4
 
         BOOL
-                :type type: str
                 :param name: Name of the attribute.
-                :type name: str
                 :param blend: Dual Source Blending Index. It can be NONE, SRC_0 or SRC_1.
-                :type blend: str
         """
 
     def fragment_source(self, source: str) -> None:
         """Fragment shader source code written in GLSL.Example:`GLSL Cross Compilation <https://developer.blender.org/docs/features/gpu/glsl_cross_compilation/>`__
 
         :param source: The fragment shader source code.
-        :type source: str
         """
 
     def image(
@@ -494,12 +418,11 @@ class GPUShaderCreateInfo:
         type: str,
         name: str,
         *,
-        qualifiers={"NO_RESTRICT"},
+        qualifiers: set[str] = {"NO_RESTRICT"},
     ) -> None:
         """Specify an image resource used for arbitrary load and store operations.
 
                 :param slot: The image resource index.
-                :type slot: int
                 :param format: The GPUTexture format that is passed to the shader. Possible values are:
 
         RGBA8UI
@@ -589,7 +512,6 @@ class GPUShaderCreateInfo:
         DEPTH_COMPONENT24 (deprecated, use DEPTH_COMPONENT32F)
 
         DEPTH_COMPONENT16
-                :type format: str
                 :param type: The data type describing how the image is to be read in the shader. Possible values are:
 
         FLOAT_BUFFER
@@ -655,9 +577,7 @@ class GPUShaderCreateInfo:
         DEPTH_CUBE
 
         DEPTH_CUBE_ARRAY
-                :type type: str
                 :param name: The image resource name.
-                :type name: str
                 :param qualifiers: Set containing values that describe how the image resource is to be read or written. Possible values are:
         - NO_RESTRICT
         - READ
@@ -668,11 +588,8 @@ class GPUShaderCreateInfo:
         """Specify the local group size for compute shaders.
 
         :param x: The local group size in the x dimension.
-        :type x: int
         :param y: The local group size in the y dimension. Optional. Defaults to 1.
-        :type y: int
         :param z: The local group size in the z dimension. Optional. Defaults to 1.
-        :type z: int
         """
 
     def push_constant(self, type: str, name: str, size: int = 0) -> None:
@@ -709,18 +626,14 @@ class GPUShaderCreateInfo:
         IVEC4
 
         BOOL
-                :type type: str
                 :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) -> None:
         """Specify an image texture sampler.
 
                 :param slot: The image texture sampler index.
-                :type slot: int
                 :param type: The data type describing the format of each sampler unit. Possible values are:
 
         FLOAT_BUFFER
@@ -786,34 +699,27 @@ class GPUShaderCreateInfo:
         DEPTH_CUBE
 
         DEPTH_CUBE_ARRAY
-                :type type: str
                 :param name: The image texture sampler name.
-                :type name: str
         """
 
     def typedef_source(self, source: str) -> None:
         """Source code included before resource declaration. Useful for defining structs used by Uniform Buffers.Example:
 
         :param source: The source code defining types.
-        :type source: str
         """
 
     def uniform_buf(self, slot: int, type_name: str, name: str) -> None:
         """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
         :param type_name: Name of the data type. It can be a struct type defined in the source passed through the `gpu.types.GPUShaderCreateInfo.typedef_source`.
-        :type type_name: str
         :param name: The uniform variable name.
-        :type name: str
         """
 
     def vertex_in(self, slot: int, type: str, name: str) -> None:
         """Add a vertex shader input attribute.
 
                 :param slot: The attribute index.
-                :type slot: int
                 :param type: One of these types:
 
         FLOAT
@@ -845,33 +751,26 @@ class GPUShaderCreateInfo:
         IVEC4
 
         BOOL
-                :type type: str
                 :param name: name of the attribute.
-                :type name: str
         """
 
     def vertex_out(self, interface: GPUStageInterfaceInfo) -> None:
         """Add a vertex shader output interface block.
 
         :param interface: Object describing the block.
-        :type interface: GPUStageInterfaceInfo
         """
 
     def vertex_source(self, source: str) -> None:
         """Vertex shader source code written in GLSL.Example:`GLSL Cross Compilation <https://developer.blender.org/docs/features/gpu/glsl_cross_compilation/>`__
 
         :param source: The vertex shader source code.
-        :type source: str
         """
 
 class GPUStageInterfaceInfo:
     """List of varyings between shader stages."""
 
     name: str
-    """ Name of the interface block.
-
-    :type: str
-    """
+    """ Name of the interface block."""
 
     def flat(self, type: str, name: str) -> None:
         """Add an attribute with qualifier of type flat to the interface block.
@@ -907,9 +806,7 @@ class GPUStageInterfaceInfo:
         IVEC4
 
         BOOL
-                :type type: str
                 :param name: name of the attribute.
-                :type name: str
         """
 
     def no_perspective(self, type: str, name: str) -> None:
@@ -946,9 +843,7 @@ class GPUStageInterfaceInfo:
         IVEC4
 
         BOOL
-                :type type: str
                 :param name: name of the attribute.
-                :type name: str
         """
 
     def smooth(self, type: str, name: str) -> None:
@@ -985,31 +880,26 @@ class GPUStageInterfaceInfo:
         IVEC4
 
         BOOL
-                :type type: str
                 :param name: name of the attribute.
-                :type name: str
         """
 
 class GPUTexture:
-    """This object gives access to off GPU textures."""
+    """This object gives access to GPU textures."""
 
     format: str
-    """ Format of the texture.
-
-    :type: str
-    """
+    """ Format of the texture."""
 
     height: int
-    """ Height of the texture.
-
-    :type: int
-    """
+    """ Height of the texture."""
 
     width: int
-    """ Width of the texture.
+    """ Width of the texture."""
 
-    :type: int
-    """
+    def anisotropic_filter(self, use_anisotropic: bool) -> None:
+        """Set anisotropic filter usage. This only has effect if mipmapping is enabled.
+
+        :param use_anisotropic: If set to true, the texture will use anisotropic filtering.
+        """
 
     def clear(
         self,
@@ -1021,9 +911,57 @@ class GPUTexture:
                 :param format: The format that describes the content of a single item.
         Possible values are FLOAT, INT, UINT, UBYTE, UINT_24_8 & 10_11_11_REV.
         UINT_24_8 is deprecated, use FLOAT instead.
-                :type format: str
                 :param value: Sequence each representing the value to fill. Sizes 1..4 are supported.
-                :type value: collections.abc.Sequence[float]
+        """
+
+    def extend_mode(
+        self,
+        extend_mode: typing.Literal[
+            "EXTEND", "REPEAT", "MIRRORED_REPEAT", "CLAMP_TO_BORDER"
+        ] = "EXTEND",
+        /,
+    ) -> None:
+        """Set texture sampling method for coordinates outside of the [0..1] uv range along
+        both the x and y axis.
+
+                :param extend_mode: the specified extent mode.
+        """
+
+    def extend_mode_x(
+        self,
+        extend_mode: typing.Literal[
+            "EXTEND", "REPEAT", "MIRRORED_REPEAT", "CLAMP_TO_BORDER"
+        ] = "EXTEND",
+        /,
+    ) -> None:
+        """Set texture sampling method for coordinates outside of the [0..1] uv range along the x axis.
+
+        :param extend_mode: the specified extent mode.
+        """
+
+    def extend_mode_y(
+        self,
+        extend_mode: typing.Literal[
+            "EXTEND", "REPEAT", "MIRRORED_REPEAT", "CLAMP_TO_BORDER"
+        ] = "EXTEND",
+        /,
+    ) -> None:
+        """Set texture sampling method for coordinates outside of the [0..1] uv range along the y axis.
+
+        :param extend_mode: the specified extent mode.
+        """
+
+    def filter_mode(self, use_filter: bool) -> None:
+        """Set texture filter usage.
+
+        :param use_filter: If set to true, the texture will use linear interpolation between neighboring texels.
+        """
+
+    def mipmap_mode(self, use_mipmap: bool = True, use_filter: bool = True) -> None:
+        """Set texture filter and mip-map usage.
+
+        :param use_mipmap: If set to true, the texture will use mip-mapping as anti-aliasing method.
+        :param use_filter: If set to true, the texture will use linear interpolation between neighboring texels.
         """
 
     def read(self) -> None:
@@ -1053,9 +991,7 @@ class GPUVertBuf:
         """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: Buffer or sequence of data that should be stored in the buffer
-        :type data: Buffer | collections.abc.Sequence[collections.abc.Sequence[float]] | collections.abc.Sequence[collections.abc.Sequence[int]] | collections.abc.Sequence[float] | collections.abc.Sequence[int]
         """
 
 class GPUVertFormat:
@@ -1065,17 +1001,13 @@ class GPUVertFormat:
         """Add a new attribute to the format.
 
                 :param id: Name the attribute. Often position, normal, ...
-                :type id: str
                 :param comp_type: The data type that will be used store the value in memory.
         Possible values are I8, U8, I16, U16, I32, U32, F32 & I10.
-                :type comp_type: str
                 :param len: How many individual values the attribute consists of
         (e.g. 2 for uv coordinates).
-                :type len: int
                 :param fetch_mode: How values from memory will be converted when used in the shader.
         This is mainly useful for memory optimizations when you want to store values with
         reduced precision. E.g. you can store a float in only 1 byte but it will be
         converted to a normal 4 byte float when used.
         Possible values are FLOAT, INT or INT_TO_FLOAT_UNIT.
-                :type fetch_mode: str
         """

gpu_extras/batch/__init__.pyi

@@ -21,12 +21,8 @@ def batch_for_shader(
     """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.
     For the dictionary values see documentation for `gpu.types.GPUVertBuf.attr_fill` data argument.
-        :type content: dict[str, gpu.types.Buffer | collections.abc.Sequence[float] | collections.abc.Sequence[int] | collections.abc.Sequence[collections.abc.Sequence[float]] | collections.abc.Sequence[collections.abc.Sequence[int]]]
         :return: compatible batch
-        :rtype: gpu.types.GPUBatch
     """