fake-bpy-module 20231205__py3-none-any.whl → 20231207__py3-none-any.whl

gpu/matrix/__init__.pyi

@@ -0,0 +1,162 @@
+import sys
+import typing
+import mathutils
+
+GenericType = typing.TypeVar("GenericType")
+
+
+def get_model_view_matrix() -> 'mathutils.Matrix':
+    ''' Return a copy of the model-view matrix.
+
+    :rtype: 'mathutils.Matrix'
+    :return: A 4x4 view matrix.
+    '''
+
+    ...
+
+
+def get_normal_matrix() -> 'mathutils.Matrix':
+    ''' Return a copy of the normal matrix.
+
+    :rtype: 'mathutils.Matrix'
+    :return: A 3x3 normal matrix.
+    '''
+
+    ...
+
+
+def get_projection_matrix() -> 'mathutils.Matrix':
+    ''' Return a copy of the projection matrix.
+
+    :rtype: 'mathutils.Matrix'
+    :return: A 4x4 projection matrix.
+    '''
+
+    ...
+
+
+def load_identity():
+    ''' Empty stack and set to identity.
+
+    '''
+
+    ...
+
+
+def load_matrix(
+        matrix: typing.Union[typing.Sequence[float], 'mathutils.Matrix']):
+    ''' Load a matrix into the stack.
+
+    :param matrix: A 4x4 matrix.
+    :type matrix: typing.Union[typing.Sequence[float], 'mathutils.Matrix']
+    '''
+
+    ...
+
+
+def load_projection_matrix(
+        matrix: typing.Union[typing.Sequence[float], 'mathutils.Matrix']):
+    ''' Load a projection matrix into the stack.
+
+    :param matrix: A 4x4 matrix.
+    :type matrix: typing.Union[typing.Sequence[float], 'mathutils.Matrix']
+    '''
+
+    ...
+
+
+def multiply_matrix(
+        matrix: typing.Union[typing.Sequence[float], 'mathutils.Matrix']):
+    ''' Multiply the current stack matrix.
+
+    :param matrix: A 4x4 matrix.
+    :type matrix: typing.Union[typing.Sequence[float], 'mathutils.Matrix']
+    '''
+
+    ...
+
+
+def pop():
+    ''' Remove the last model-view matrix from the stack.
+
+    '''
+
+    ...
+
+
+def pop_projection():
+    ''' Remove the last projection matrix from the stack.
+
+    '''
+
+    ...
+
+
+def push():
+    ''' Add to the model-view matrix stack.
+
+    '''
+
+    ...
+
+
+def push_pop():
+    ''' Context manager to ensure balanced push/pop calls, even in the case of an error.
+
+    '''
+
+    ...
+
+
+def push_pop_projection():
+    ''' Context manager to ensure balanced push/pop calls, even in the case of an error.
+
+    '''
+
+    ...
+
+
+def push_projection():
+    ''' Add to the projection matrix stack.
+
+    '''
+
+    ...
+
+
+def reset():
+    ''' Empty stack and set to identity.
+
+    '''
+
+    ...
+
+
+def scale(scale: typing.List):
+    ''' Scale the current stack matrix.
+
+    :param scale: Scale the current stack matrix.
+    :type scale: typing.List
+    '''
+
+    ...
+
+
+def scale_uniform(scale: float):
+    ''' 
+
+    :param scale: Scale the current stack matrix.
+    :type scale: float
+    '''
+
+    ...
+
+
+def translate(offset: typing.List):
+    ''' Scale the current stack matrix.
+
+    :param offset: Translate the current stack matrix.
+    :type offset: typing.List
+    '''
+
+    ...

gpu/platform/__init__.pyi

@@ -0,0 +1,54 @@
+import sys
+import typing
+
+GenericType = typing.TypeVar("GenericType")
+
+
+def backend_type_get() -> str:
+    ''' Get actuve GPU backend.
+
+    :rtype: str
+    :return: Backend type ('OPENGL', 'VULKAN', 'METAL', 'NONE', 'UNKNOWN').
+    '''
+
+    ...
+
+
+def device_type_get() -> str:
+    ''' Get GPU device type.
+
+    :rtype: str
+    :return: Device type ('APPLE', 'NVIDIA', 'AMD', 'INTEL', 'SOFTWARE', 'QUALCOMM', 'UNKNOWN').
+    '''
+
+    ...
+
+
+def renderer_get() -> str:
+    ''' Get GPU to be used for rendering.
+
+    :rtype: str
+    :return: GPU name.
+    '''
+
+    ...
+
+
+def vendor_get() -> str:
+    ''' Get GPU vendor.
+
+    :rtype: str
+    :return: Vendor name.
+    '''
+
+    ...
+
+
+def version_get() -> str:
+    ''' Get GPU driver version.
+
+    :rtype: str
+    :return: Driver version.
+    '''
+
+    ...

gpu/select/__init__.pyi

@@ -0,0 +1,15 @@
+import sys
+import typing
+
+GenericType = typing.TypeVar("GenericType")
+
+
+def load_id(id: typing.Any):
+    ''' Set the selection ID.
+
+    :type select: int
+    :param id:  Number (32-bit uint).
+    :type id: typing.Any
+    '''
+
+    ...

gpu/shader/__init__.pyi

@@ -0,0 +1,38 @@
+import sys
+import typing
+
+GenericType = typing.TypeVar("GenericType")
+
+
+def create_from_info(shader_info: typing.Any) -> typing.Any:
+    ''' Create shader from a GPUShaderCreateInfo.
+
+    :param shader_info: GPUShaderCreateInfo
+    :type shader_info: typing.Any
+    :rtype: typing.Any
+    :return: Shader object corresponding to the given name.
+    '''
+
+    ...
+
+
+def from_builtin(shader_name: str, config: str = 'DEFAULT') -> typing.Any:
+    ''' Shaders that are embedded in the blender internal code (see :ref:`built-in-shaders`). They all read the uniform ``mat4 ModelViewProjectionMatrix``, which can be edited by the :mod:`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: - ``DEFAULT`` - ``CLIPPED``
+    :type config: str
+    :rtype: typing.Any
+    :return: Shader object corresponding to the given name.
+    '''
+
+    ...
+
+
+def unbind():
+    ''' Unbind the bound shader object.
+
+    '''
+
+    ...

gpu/state/__init__.pyi

@@ -0,0 +1,214 @@
+import sys
+import typing
+
+GenericType = typing.TypeVar("GenericType")
+
+
+def blend_get():
+    ''' Current blending equation.
+
+    '''
+
+    ...
+
+
+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.
+    :type mode: str
+    '''
+
+    ...
+
+
+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
+    '''
+
+    ...
+
+
+def color_mask_set(r: bool, g: bool, b: bool, a: bool):
+    ''' Enable or disable writing of frame buffer color components.
+
+    :param r: components red, green, blue, and alpha.
+    :type r: bool
+    :param g: components red, green, blue, and alpha.
+    :type g: bool
+    :param b: components red, green, blue, and alpha.
+    :type b: bool
+    :param a: components red, green, blue, and alpha.
+    :type a: bool
+    '''
+
+    ...
+
+
+def depth_mask_get():
+    ''' Writing status in the depth component.
+
+    '''
+
+    ...
+
+
+def depth_mask_set(value: typing.Any):
+    ''' Write to depth component.
+
+    :type near: bool
+    :param value:  True for writing to the depth component.
+    :type value: typing.Any
+    '''
+
+    ...
+
+
+def depth_test_get():
+    ''' Current depth_test equation.
+
+    '''
+
+    ...
+
+
+def depth_test_set(mode: str):
+    ''' 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.
+
+    :param mode: `NONE`, `FRONT` or `BACK`.
+    :type mode: str
+    '''
+
+    ...
+
+
+def framebuffer_active_get(enable):
+    ''' Return the active frame-buffer in context.
+
+    '''
+
+    ...
+
+
+def front_facing_set(invert: typing.Any):
+    ''' Specifies the orientation of front-facing polygons.
+
+    :type mode: bool
+    :param invert:  True for clockwise polygons as front-facing.
+    :type invert: typing.Any
+    '''
+
+    ...
+
+
+def line_width_get():
+    ''' Current width of rasterized lines.
+
+    '''
+
+    ...
+
+
+def line_width_set(width):
+    ''' Specify the width of rasterized lines.
+
+    :type mode: float
+    :param size:  New width.
+    :type size: typing.Any
+    '''
+
+    ...
+
+
+def point_size_set(size: typing.Any):
+    ''' Specify the diameter of rasterized points.
+
+    :type mode: float
+    :param size:  New diameter.
+    :type size: typing.Any
+    '''
+
+    ...
+
+
+def program_point_size_set(enable: bool):
+    ''' 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() -> typing.Union[int, int]:
+    ''' Retrieve the scissors of the active framebuffer. Note: Only valid between 'scissor_set' and a framebuffer rebind.
+
+    :rtype: typing.Union[int, int]
+    :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.
+    '''
+
+    ...
+
+
+def scissor_set(x: int, y: int, xsize: int, ysize: int):
+    ''' 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 y: lower left corner of the scissor rectangle, in pixels.
+    :type y: int
+    :param xsize: width and height of the scissor rectangle.
+    :type xsize: int
+    :param ysize: width and height of the scissor rectangle.
+    :type ysize: int
+    '''
+
+    ...
+
+
+def scissor_test_set(enable: bool):
+    ''' 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_set(x: int, y: int, xsize: int, ysize: int):
+    ''' 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 y: lower left corner of the viewport_set rectangle, in pixels.
+    :type y: int
+    :param xsize: width and height of the viewport_set.
+    :type xsize: int
+    :param ysize: width and height of the viewport_set.
+    :type ysize: int
+    '''
+
+    ...

gpu/texture/__init__.pyi

@@ -0,0 +1,18 @@
+import sys
+import typing
+import bpy.types
+import gpu.types
+
+GenericType = typing.TypeVar("GenericType")
+
+
+def from_image(image: 'bpy.types.Image') -> 'gpu.types.GPUTexture':
+    ''' Get GPUTexture corresponding to an Image datablock. 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'
+    :rtype: 'gpu.types.GPUTexture'
+    :return: The GPUTexture used by the image.
+    '''
+
+    ...