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

bl_math/__init__.pyi

@@ -1,37 +1,53 @@
+"""
+Miscellaneous math utilities module
+
+"""
+
 import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def clamp(value, min=0, max=1):
+def clamp(value: float, min: float = 0, max: float = 1) -> float:
     """Clamps the float value between minimum and maximum. To avoid
     confusion, any call must use either one or all three arguments.
 
         :param value: The value to clamp.
+        :type value: float
         :param min: The minimum value, defaults to 0.
+        :type min: float
         :param max: The maximum value, defaults to 1.
+        :type max: float
         :return: The clamped value.
+        :rtype: float
     """
 
     ...
 
-def lerp(from_value, to_value, factor):
+def lerp(from_value: float, to_value: float, factor: float) -> float:
     """Linearly interpolate between two float values based on factor.
 
     :param from_value: The value to return when factor is 0.
+    :type from_value: float
     :param to_value: The value to return when factor is 1.
+    :type to_value: float
     :param factor: The interpolation value, normally in [0.0, 1.0].
+    :type factor: float
     :return: The interpolated value.
+    :rtype: float
     """
 
     ...
 
-def smoothstep(from_value, to_value, value):
+def smoothstep(from_value: float, to_value: float, value) -> float:
     """Performs smooth interpolation between 0 and 1 as value changes between from and to values.
     Outside the range the function returns the same value as the nearest edge.
 
         :param from_value: The edge value where the result is 0.
+        :type from_value: float
         :param to_value: The edge value where the result is 1.
+        :type to_value: float
         :return: The interpolated value in [0.0, 1.0].
+        :rtype: float
     """
 
     ...

blf/__init__.pyi

@@ -1,44 +1,70 @@
+"""
+This module provides access to Blender's text drawing functions.
+
+
+--------------------
+
+Example of using the blf module. For this module to work we
+need to use the OpenGL wrapper ~bgl as well.
+
+```../examples/blf.py```
+
+"""
+
 import typing
 
 GenericType = typing.TypeVar("GenericType")
 
-def aspect(fontid, aspect):
+def aspect(fontid: int, aspect: float):
     """Set the aspect for drawing text.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param aspect: The aspect ratio for text drawing to use.
+    :type aspect: float
     """
 
     ...
 
-def clipping(fontid, xmin, ymin, xmax, ymax):
+def clipping(fontid: int, xmin: float, ymin: float, xmax: float, ymax: float):
     """Set the clipping, enable/disable using CLIPPING.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param xmin: Clip the drawing area by these bounds.
+    :type xmin: float
     :param ymin: Clip the drawing area by these bounds.
+    :type ymin: float
     :param xmax: Clip the drawing area by these bounds.
+    :type xmax: float
     :param ymax: Clip the drawing area by these bounds.
+    :type ymax: float
     """
 
     ...
 
-def color(fontid, r, g, b, a):
+def color(fontid: int, r: float, g: float, b: float, a: float):
     """Set the color for drawing text.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param r: red channel 0.0 - 1.0.
+    :type r: float
     :param g: green channel 0.0 - 1.0.
+    :type g: float
     :param b: blue channel 0.0 - 1.0.
+    :type b: float
     :param a: alpha channel 0.0 - 1.0.
+    :type a: float
     """
 
     ...
 
-def dimensions(fontid, text: str):
+def dimensions(fontid: int, text: str):
     """Return the width and height of the text.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param text: the text to draw.
     :type text: str
     :return: the width and height of the text.
@@ -46,30 +72,35 @@ def dimensions(fontid, text: str):
 
     ...
 
-def disable(fontid, option):
+def disable(fontid: int, option: int):
     """Disable option.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param option: One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.
+    :type option: int
     """
 
     ...
 
-def draw(fontid, text: str):
+def draw(fontid: int, text: str):
     """Draw text in the current context.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param text: the text to draw.
     :type text: str
     """
 
     ...
 
-def enable(fontid, option):
+def enable(fontid: int, option: int):
     """Enable option.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param option: One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.
+    :type option: int
     """
 
     ...
@@ -84,54 +115,71 @@ def load(filepath: typing.Union[str, bytes]):
 
     ...
 
-def position(fontid, x, y, z):
+def position(fontid: int, x: float, y: float, z: float):
     """Set the position for drawing text.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param x: X axis position to draw the text.
+    :type x: float
     :param y: Y axis position to draw the text.
+    :type y: float
     :param z: Z axis position to draw the text.
+    :type z: float
     """
 
     ...
 
-def rotation(fontid, angle):
+def rotation(fontid: int, angle: float):
     """Set the text rotation angle, enable/disable using ROTATION.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param angle: The angle for text drawing to use.
+    :type angle: float
     """
 
     ...
 
-def shadow(fontid, level, r, g, b, a):
+def shadow(fontid: int, level: int, r: float, g: float, b: float, a: float):
     """Shadow options, enable/disable using SHADOW .
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param level: The blur level, can be 3, 5 or 0.
+    :type level: int
     :param r: Shadow color (red channel 0.0 - 1.0).
+    :type r: float
     :param g: Shadow color (green channel 0.0 - 1.0).
+    :type g: float
     :param b: Shadow color (blue channel 0.0 - 1.0).
+    :type b: float
     :param a: Shadow color (alpha channel 0.0 - 1.0).
+    :type a: float
     """
 
     ...
 
-def shadow_offset(fontid, x, y):
+def shadow_offset(fontid: int, x: float, y: float):
     """Set the offset for shadow text.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param x: Vertical shadow offset value in pixels.
+    :type x: float
     :param y: Horizontal shadow offset value in pixels.
+    :type y: float
     """
 
     ...
 
-def size(fontid, size):
+def size(fontid: int, size: float):
     """Set the size for drawing text.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param size: Point size of the font.
+    :type size: float
     """
 
     ...
@@ -145,11 +193,13 @@ def unload(filepath: typing.Union[str, bytes]):
 
     ...
 
-def word_wrap(fontid, wrap_width):
+def word_wrap(fontid: int, wrap_width: int):
     """Set the wrap width, enable/disable using WORD_WRAP.
 
     :param fontid: The id of the typeface as returned by `blf.load`, for default font use 0.
+    :type fontid: int
     :param wrap_width: The width (in pixels) to wrap words at.
+    :type wrap_width: int
     """
 
     ...

bmesh/__init__.pyi

@@ -1,3 +1,16 @@
+"""
+This module provides access to blenders bmesh data structures.
+
+bmesh.ops.rst
+bmesh.types.rst
+bmesh.utils.rst
+bmesh.geometry.rst
+
+:maxdepth: 1
+:caption: Submodules
+
+"""
+
 import typing
 import bmesh.types
 import bpy.types

bmesh/geometry/__init__.pyi

@@ -1,3 +1,8 @@
+"""
+This module provides access to bmesh geometry evaluation functions.
+
+"""
+
 import typing
 import bmesh.types
 import mathutils