fake-bpy-module 20240417__py3-none-any.whl → 20240419__py3-none-any.whl

gpu/state/__init__.pyi

@@ -1,3 +1,8 @@
+"""
+This module provides access to the gpu state.
+
+"""
+
 import typing
 
 GenericType = typing.TypeVar("GenericType")
@@ -24,10 +29,11 @@ def blend_set(mode: str):
 
     ...
 
-def clip_distances_set(distances_enabled):
+def clip_distances_set(distances_enabled: int):
     """Sets the number of gl_ClipDistance planes used for clip geometry.
 
     :param distances_enabled: Number of clip distances enabled.
+    :type distances_enabled: int
     """
 
     ...
@@ -114,7 +120,7 @@ def program_point_size_set(enable: bool):
 
     ...
 
-def scissor_get():
+def scissor_get() -> typing.Union[int, int]:
     """Retrieve the scissors of the active framebuffer.
     Note: Only valid between 'scissor_set' and a framebuffer rebind.
 
@@ -122,16 +128,19 @@ def scissor_get():
     (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: typing.Union[int, int]
     """
 
     ...
 
-def scissor_set(x, y, xsize, ysize):
+def scissor_set(x: int, y, xsize: int, ysize):
     """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
     """
 
     ...
@@ -151,12 +160,14 @@ def viewport_get():
 
     ...
 
-def viewport_set(x, y, xsize, ysize):
+def viewport_set(x: int, y, xsize: int, ysize):
     """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
     """
 
     ...

gpu/texture/__init__.pyi

@@ -1,3 +1,8 @@
+"""
+This module provides utils for textures.
+
+"""
+
 import typing
 import bpy.types
 import gpu.types

gpu/types/__init__.pyi

@@ -22,7 +22,9 @@ class GPUBatch:
         """
         ...
 
-    def draw_instanced(self, program: GPUShader, instance_start=0, instance_count=0):
+    def draw_instanced(
+        self, program: GPUShader, instance_start: int = 0, instance_count: int = 0
+    ):
         """Draw multiple instances of the drawing program with the parameters assigned
         to the batch. In the vertex shader, gl_InstanceID will contain the instance
         number being drawn.
@@ -30,13 +32,15 @@ class GPUBatch:
                 :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(self, program: GPUShader, elem_start=0, elem_count=0):
+    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
 
@@ -44,9 +48,11 @@ class GPUBatch:
                 :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
         """
         ...
 
@@ -87,27 +93,40 @@ class GPUFrameBuffer:
         """Context manager to ensure balanced bind calls, even in the case of an error."""
         ...
 
-    def clear(self, color=None, depth=None, stencil=None):
+    def clear(self, color=None, depth: float = None, stencil: int = None):
         """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 depth: depth value.
+                :type depth: float
                 :param stencil: stencil value.
+                :type stencil: int
         """
         ...
 
     def read_color(
-        self, x, y, xsize, ysize, channels, slot, format: str, data: Buffer = None
+        self,
+        x: int,
+        y,
+        xsize,
+        ysize,
+        channels: int,
+        slot: int,
+        format: str,
+        data: Buffer = 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 and 10_11_11_REV.
                 :type format: str
@@ -118,12 +137,14 @@ class GPUFrameBuffer:
         """
         ...
 
-    def read_depth(self, x, y, xsize, ysize, data: Buffer = None) -> Buffer:
+    def read_depth(self, x: int, y, xsize: int, ysize, data: Buffer = 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
@@ -136,13 +157,15 @@ class GPUFrameBuffer:
         """Returns position and dimension to current viewport."""
         ...
 
-    def viewport_set(self, x, y, xsize, ysize):
+    def viewport_set(self, x: int, y, xsize: int, ysize):
         """Set the viewport for this framebuffer object.
         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:
         """
         ...
@@ -155,11 +178,17 @@ class GPUIndexBuf:
 class GPUOffScreen:
     """This object gives access to off screen buffers."""
 
-    color_texture: typing.Any
-    """ OpenGL bindcode for the color texture."""
+    color_texture: int
+    """ OpenGL bindcode for the color texture.
+
+    :type: int
+    """
+
+    height: int
+    """ Height of the texture.
 
-    height: typing.Any
-    """ Height of the texture."""
+    :type: int
+    """
 
     texture_color: GPUTexture
     """ The color texture attached.
@@ -167,8 +196,11 @@ class GPUOffScreen:
     :type: GPUTexture
     """
 
-    width: typing.Any
-    """ Width of the texture."""
+    width: int
+    """ Width of the texture.
+
+    :type: int
+    """
 
     def bind(self):
         """Context manager to ensure balanced bind calls, even in the case of an error."""
@@ -238,19 +270,23 @@ class GPUShader:
     :type: str
     """
 
-    program: typing.Any
-    """ The name of the program object for use by the OpenGL API (read-only)."""
+    program: int
+    """ The name of the program object for use by the OpenGL API (read-only).
+
+    :type: int
+    """
 
-    def attr_from_name(self, name: str) -> str:
+    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):
+    def attrs_info_get(self) -> typing.Tuple:
         """Information about the attributes used in the Shader.
 
         :return: tuples containing information about the attributes in order (name, type)
@@ -262,7 +298,7 @@ class GPUShader:
         """Bind the shader object. Required to be able to change uniforms of this shader."""
         ...
 
-    def format_calc(self) -> typing.Tuple:
+    def format_calc(self) -> GPUVertFormat:
         """Build a new format based on the attributes of the shader.
 
         :return: vertex attribute format for the shader
@@ -289,12 +325,13 @@ class GPUShader:
         """
         ...
 
-    def uniform_block_from_name(self, name: str) -> str:
+    def uniform_block_from_name(self, name: str) -> int:
         """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
         """
         ...
 
@@ -317,12 +354,13 @@ class GPUShader:
         """
         ...
 
-    def uniform_from_name(self, name: str) -> str:
+    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
         """
         ...
 
@@ -345,10 +383,13 @@ class GPUShader:
         """
         ...
 
-    def uniform_vector_float(self, location, buffer: typing.List[float], length, count):
+    def uniform_vector_float(
+        self, location: int, buffer: typing.List[float], 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: typing.List[float]
                 :param length: Size of the uniform data type:
@@ -364,7 +405,9 @@ class GPUShader:
         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
         """
         ...
 
@@ -397,10 +440,11 @@ class GPUShaderCreateInfo:
         """
         ...
 
-    def fragment_out(self, slot, type: str, name: str, blend: str = "NONE"):
+    def fragment_out(self, slot: int, type: str, name: str, blend: str = "NONE"):
         """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
@@ -450,7 +494,7 @@ class GPUShaderCreateInfo:
 
     def image(
         self,
-        slot,
+        slot: int,
         format: str,
         type: str,
         name: str,
@@ -459,6 +503,7 @@ class GPUShaderCreateInfo:
         """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
@@ -625,12 +670,15 @@ class GPUShaderCreateInfo:
         """
         ...
 
-    def local_group_size(self, x, y=-1, z=-1):
+    def local_group_size(self, x: int, y: int = -1, z: int = -1):
         """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
         """
         ...
 
@@ -675,10 +723,11 @@ class GPUShaderCreateInfo:
         """
         ...
 
-    def sampler(self, slot, type: str, name: str):
+    def sampler(self, slot: int, type: str, name: str):
         """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
@@ -757,10 +806,11 @@ class GPUShaderCreateInfo:
         """
         ...
 
-    def uniform_buf(self, slot, type_name: str, name: str):
+    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.
 
         :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.
@@ -768,10 +818,11 @@ class GPUShaderCreateInfo:
         """
         ...
 
-    def vertex_in(self, slot, type: str, name: str):
+    def vertex_in(self, slot: int, type: str, name: str):
         """Add a vertex shader input attribute.
 
                 :param slot: The attribute index.
+                :type slot: int
                 :param type: One of these types:
 
         FLOAT
@@ -963,11 +1014,17 @@ class GPUTexture:
     :type: str
     """
 
-    height: typing.Any
-    """ Height of the texture."""
+    height: int
+    """ Height of the texture.
 
-    width: typing.Any
-    """ Width of the texture."""
+    :type: int
+    """
+
+    width: int
+    """ Width of the texture.
+
+    :type: int
+    """
 
     def clear(self, format: str = "FLOAT", value=(0.0, 0.0, 0.0, 1.0)):
         """Fill texture with specific value.
@@ -996,11 +1053,11 @@ class GPUUniformBuf:
 class GPUVertBuf:
     """Contains a VBO."""
 
-    def attr_fill(self, id: str, data: typing.List[float]):
+    def attr_fill(self, id: typing.Union[int, str], data: typing.List[float]):
         """Insert data into the buffer for a single attribute.
 
         :param id: Either the name or the id of the attribute.
-        :type id: str
+        :type id: typing.Union[int, str]
         :param data: Sequence of data that should be stored in the buffer
         :type data: typing.List[float]
         """
@@ -1009,7 +1066,7 @@ class GPUVertBuf:
 class GPUVertFormat:
     """This object contains information about the structure of a vertex buffer."""
 
-    def attr_add(self, id: str, comp_type: str, len, fetch_mode: str):
+    def attr_add(self, id: str, comp_type: str, len: int, fetch_mode: str):
         """Add a new attribute to the format.
 
                 :param id: Name the attribute. Often position, normal, ...
@@ -1019,6 +1076,7 @@ class GPUVertFormat:
                 :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

gpu_extras/__init__.pyi

@@ -1,3 +1,18 @@
+"""
+gpu_extras.batch.rst
+gpu_extras.presets.rst
+
+:maxdepth: 1
+:caption: Submodules
+
+gpu_extras.batch.rst
+gpu_extras.presets.rst
+
+:maxdepth: 1
+:caption: Submodules
+
+"""
+
 import typing
 from . import batch
 from . import presets

gpu_extras/presets/__init__.pyi

@@ -4,13 +4,14 @@ import mathutils
 
 GenericType = typing.TypeVar("GenericType")
 
-def draw_circle_2d(position: mathutils.Vector, color, radius, segments=None):
+def draw_circle_2d(position: mathutils.Vector, color, radius: float, segments=None):
     """Draw a circle.
 
         :param position: Position where the circle will be drawn.
         :type position: mathutils.Vector
         :param color: Color of the circle. To use transparency GL_BLEND has to be enabled.
         :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.
@@ -18,13 +19,14 @@ def draw_circle_2d(position: mathutils.Vector, color, radius, segments=None):
 
     ...
 
-def draw_circle_2d(position: mathutils.Vector, color, radius, segments=None):
+def draw_circle_2d(position: mathutils.Vector, color, radius: float, segments=None):
     """Draw a circle.
 
         :param position: Position where the circle will be drawn.
         :type position: mathutils.Vector
         :param color: Color of the circle. To use transparency GL_BLEND has to be enabled.
         :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.
@@ -38,7 +40,10 @@ def draw_circle_2d(position, color, radius, segments):
     ...
 
 def draw_texture_2d(
-    texture: gpu.types.GPUTexture, position: mathutils.Vector, width, height
+    texture: gpu.types.GPUTexture,
+    position: mathutils.Vector,
+    width: float,
+    height: float,
 ):
     """Draw a 2d texture.
 
@@ -48,13 +53,18 @@ def draw_texture_2d(
         :type position: mathutils.Vector
         :param width: Width of the image when drawn (not necessarily
     the original width of the texture).
+        :type width: float
         :param height: Height of the image when drawn.
+        :type height: float
     """
 
     ...
 
 def draw_texture_2d(
-    texture: gpu.types.GPUTexture, position: mathutils.Vector, width, height
+    texture: gpu.types.GPUTexture,
+    position: mathutils.Vector,
+    width: float,
+    height: float,
 ):
     """Draw a 2d texture.
 
@@ -64,7 +74,9 @@ def draw_texture_2d(
         :type position: mathutils.Vector
         :param width: Width of the image when drawn (not necessarily
     the original width of the texture).
+        :type width: float
         :param height: Height of the image when drawn.
+        :type height: float
     """
 
     ...

imbuf/__init__.pyi

@@ -1,3 +1,16 @@
+"""
+This module provides access to Blender's image manipulation API.
+
+It provides access to image buffers outside of Blender's
+bpy.types.Image data-block context.
+
+imbuf.types.rst
+
+:maxdepth: 1
+:caption: Submodules
+
+"""
+
 import typing
 import imbuf.types
 

imbuf/types/__init__.pyi

@@ -1,3 +1,12 @@
+"""
+This module provides access to image buffer types.
+
+[NOTE]
+Image buffer is also the structure used by bpy.types.Image
+ID type to store and manipulate image data at runtime.
+
+"""
+
 import typing
 
 GenericType = typing.TypeVar("GenericType")
@@ -5,8 +14,11 @@ GenericType = typing.TypeVar("GenericType")
 class ImBuf:
     """ """
 
-    channels: typing.Any
-    """ Number of bit-planes."""
+    channels: int
+    """ Number of bit-planes.
+
+    :type: int
+    """
 
     filepath: str
     """ filepath associated with this image.
@@ -14,8 +26,11 @@ class ImBuf:
     :type: str
     """
 
-    planes: typing.Any
-    """ Number of bits associated with this image."""
+    planes: int
+    """ Number of bits associated with this image.
+
+    :type: int
+    """
 
     ppm: typing.Any
     """ pixels per meter."""
@@ -23,7 +38,7 @@ class ImBuf:
     size: typing.Any
     """ size of the image in pixels."""
 
-    def copy(self):
+    def copy(self) -> ImBuf:
         """
 
         :return: A copy of the image.