fake-bpy-module 20240224__py3-none-any.whl → 20240326__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. addon_utils/__init__.pyi +54 -10
  2. animsys_refactor/__init__.pyi +36 -6
  3. aud/__init__.pyi +132 -125
  4. bgl/__init__.pyi +2545 -546
  5. bl_app_override/__init__.pyi +14 -3
  6. bl_app_override/helpers/__init__.pyi +24 -2
  7. bl_app_template_utils/__init__.pyi +19 -4
  8. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +24 -5
  9. bl_console_utils/autocomplete/complete_import/__init__.pyi +14 -3
  10. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +24 -5
  11. bl_console_utils/autocomplete/intellisense/__init__.pyi +9 -2
  12. bl_i18n_utils/bl_extract_messages/__init__.pyi +74 -15
  13. bl_i18n_utils/merge_po/__init__.pyi +4 -1
  14. bl_i18n_utils/settings/__init__.pyi +53 -6
  15. bl_i18n_utils/utils/__init__.pyi +332 -44
  16. bl_i18n_utils/utils_cli/__init__.pyi +29 -6
  17. bl_i18n_utils/utils_languages_menu/__init__.pyi +4 -1
  18. bl_i18n_utils/utils_rtl/__init__.pyi +9 -2
  19. bl_keymap_utils/io/__init__.pyi +44 -9
  20. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +4 -1
  21. bl_keymap_utils/keymap_hierarchy/__init__.pyi +4 -1
  22. bl_keymap_utils/platform_helpers/__init__.pyi +9 -2
  23. bl_keymap_utils/versioning/__init__.pyi +4 -1
  24. bl_math/__init__.pyi +3 -3
  25. bl_operators/__init__.pyi +9 -2
  26. bl_operators/add_mesh_torus/__init__.pyi +171 -37
  27. bl_operators/anim/__init__.pyi +1065 -226
  28. bl_operators/assets/__init__.pyi +427 -92
  29. bl_operators/bmesh/find_adjacent/__init__.pyi +44 -9
  30. bl_operators/clip/__init__.pyi +1342 -287
  31. bl_operators/console/__init__.pyi +647 -140
  32. bl_operators/constraint/__init__.pyi +524 -112
  33. bl_operators/file/__init__.pyi +396 -84
  34. bl_operators/freestyle/__init__.pyi +532 -113
  35. bl_operators/geometry_nodes/__init__.pyi +2412 -596
  36. bl_operators/image/__init__.pyi +380 -82
  37. bl_operators/mesh/__init__.pyi +401 -85
  38. bl_operators/node/__init__.pyi +1756 -384
  39. bl_operators/object/__init__.pyi +2022 -552
  40. bl_operators/object_align/__init__.pyi +145 -31
  41. bl_operators/object_quick_effects/__init__.pyi +555 -124
  42. bl_operators/object_randomize_transform/__init__.pyi +136 -32
  43. bl_operators/presets/__init__.pyi +3516 -708
  44. bl_operators/rigidbody/__init__.pyi +401 -85
  45. bl_operators/screen_play_rendered_anim/__init__.pyi +129 -29
  46. bl_operators/sequencer/__init__.pyi +731 -149
  47. bl_operators/spreadsheet/__init__.pyi +145 -30
  48. bl_operators/userpref/__init__.pyi +3416 -824
  49. bl_operators/uvcalc_follow_active/__init__.pyi +149 -32
  50. bl_operators/uvcalc_lightmap/__init__.pyi +187 -34
  51. bl_operators/uvcalc_transform/__init__.pyi +344 -73
  52. bl_operators/vertexpaint_dirt/__init__.pyi +140 -30
  53. bl_operators/view3d/__init__.pyi +697 -146
  54. bl_operators/wm/__init__.pyi +6287 -1533
  55. bl_previews_utils/bl_previews_render/__init__.pyi +34 -7
  56. bl_rna_utils/data_path/__init__.pyi +12 -2
  57. bl_text_utils/external_editor/__init__.pyi +4 -1
  58. bl_ui/__init__.pyi +504 -106
  59. bl_ui/anim/__init__.pyi +164 -33
  60. bl_ui/asset_shelf/__init__.pyi +146 -31
  61. bl_ui/generic_ui_list/__init__.pyi +471 -99
  62. bl_ui/node_add_menu/__init__.pyi +196 -40
  63. bl_ui/node_add_menu_compositor/__init__.pyi +3017 -621
  64. bl_ui/node_add_menu_geometry/__init__.pyi +8060 -1625
  65. bl_ui/node_add_menu_shader/__init__.pyi +1709 -348
  66. bl_ui/node_add_menu_texture/__init__.pyi +1502 -305
  67. bl_ui/properties_animviz/__init__.pyi +32 -2
  68. bl_ui/properties_collection/__init__.pyi +787 -179
  69. bl_ui/properties_constraint/__init__.pyi +28635 -5523
  70. bl_ui/properties_data_armature/__init__.pyi +1905 -448
  71. bl_ui/properties_data_bone/__init__.pyi +1560 -336
  72. bl_ui/properties_data_camera/__init__.pyi +2269 -494
  73. bl_ui/properties_data_curve/__init__.pyi +2362 -534
  74. bl_ui/properties_data_curves/__init__.pyi +951 -203
  75. bl_ui/properties_data_empty/__init__.pyi +317 -69
  76. bl_ui/properties_data_gpencil/__init__.pyi +2924 -734
  77. bl_ui/properties_data_grease_pencil/__init__.pyi +1631 -188
  78. bl_ui/properties_data_lattice/__init__.pyi +472 -104
  79. bl_ui/properties_data_light/__init__.pyi +1570 -337
  80. bl_ui/properties_data_lightprobe/__init__.pyi +938 -208
  81. bl_ui/properties_data_mesh/__init__.pyi +3205 -767
  82. bl_ui/properties_data_metaball/__init__.pyi +774 -170
  83. bl_ui/properties_data_modifier/__init__.pyi +1554 -328
  84. bl_ui/properties_data_pointcloud/__init__.pyi +821 -194
  85. bl_ui/properties_data_shaderfx/__init__.pyi +154 -34
  86. bl_ui/properties_data_speaker/__init__.pyi +782 -168
  87. bl_ui/properties_data_volume/__init__.pyi +1243 -281
  88. bl_ui/properties_freestyle/__init__.pyi +4071 -1030
  89. bl_ui/properties_grease_pencil_common/__init__.pyi +2399 -483
  90. bl_ui/properties_mask_common/__init__.pyi +1256 -249
  91. bl_ui/properties_material/__init__.pyi +2351 -542
  92. bl_ui/properties_material_gpencil/__init__.pyi +1590 -365
  93. bl_ui/properties_object/__init__.pyi +2179 -512
  94. bl_ui/properties_output/__init__.pyi +2956 -705
  95. bl_ui/properties_paint_common/__init__.pyi +947 -140
  96. bl_ui/properties_particle/__init__.pyi +8322 -1970
  97. bl_ui/properties_physics_cloth/__init__.pyi +2254 -508
  98. bl_ui/properties_physics_common/__init__.pyi +200 -44
  99. bl_ui/properties_physics_dynamicpaint/__init__.pyi +4454 -965
  100. bl_ui/properties_physics_field/__init__.pyi +1695 -364
  101. bl_ui/properties_physics_fluid/__init__.pyi +6127 -1280
  102. bl_ui/properties_physics_geometry_nodes/__init__.pyi +157 -32
  103. bl_ui/properties_physics_rigidbody/__init__.pyi +1254 -278
  104. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +2053 -483
  105. bl_ui/properties_physics_softbody/__init__.pyi +2394 -542
  106. bl_ui/properties_render/__init__.pyi +8312 -1933
  107. bl_ui/properties_scene/__init__.pyi +2211 -539
  108. bl_ui/properties_texture/__init__.pyi +4185 -1013
  109. bl_ui/properties_view_layer/__init__.pyi +2803 -664
  110. bl_ui/properties_workspace/__init__.pyi +626 -148
  111. bl_ui/properties_world/__init__.pyi +1092 -234
  112. bl_ui/space_clip/__init__.pyi +11475 -2805
  113. bl_ui/space_console/__init__.pyi +967 -202
  114. bl_ui/space_dopesheet/__init__.pyi +4260 -966
  115. bl_ui/space_filebrowser/__init__.pyi +4852 -1187
  116. bl_ui/space_graph/__init__.pyi +3251 -702
  117. bl_ui/space_image/__init__.pyi +12219 -2968
  118. bl_ui/space_info/__init__.pyi +964 -200
  119. bl_ui/space_nla/__init__.pyi +2756 -584
  120. bl_ui/space_node/__init__.pyi +5661 -1265
  121. bl_ui/space_outliner/__init__.pyi +2294 -478
  122. bl_ui/space_properties/__init__.pyi +417 -92
  123. bl_ui/space_sequencer/__init__.pyi +12436 -3009
  124. bl_ui/space_spreadsheet/__init__.pyi +184 -36
  125. bl_ui/space_statusbar/__init__.pyi +135 -30
  126. bl_ui/space_text/__init__.pyi +2556 -542
  127. bl_ui/space_time/__init__.pyi +1151 -243
  128. bl_ui/space_toolsystem_common/__init__.pyi +368 -66
  129. bl_ui/space_toolsystem_toolbar/__init__.pyi +1378 -228
  130. bl_ui/space_topbar/__init__.pyi +4214 -887
  131. bl_ui/space_userpref/__init__.pyi +13920 -3468
  132. bl_ui/space_view3d/__init__.pyi +43701 -10599
  133. bl_ui/space_view3d_toolbar/__init__.pyi +16380 -3860
  134. bl_ui/utils/__init__.pyi +42 -4
  135. bl_ui_utils/bug_report_url/__init__.pyi +4 -1
  136. bl_ui_utils/layout/__init__.pyi +4 -1
  137. blend_render_info/__init__.pyi +13 -3
  138. blf/__init__.pyi +5 -7
  139. bmesh/__init__.pyi +7 -7
  140. bmesh/geometry/__init__.pyi +5 -5
  141. bmesh/ops/__init__.pyi +490 -504
  142. bmesh/types/__init__.pyi +268 -262
  143. bmesh/utils/__init__.pyi +55 -55
  144. bpy/__init__.pyi +2 -2
  145. bpy/app/__init__.pyi +4 -5
  146. bpy/app/handlers/__init__.pyi +36 -36
  147. bpy/app/icons/__init__.pyi +8 -10
  148. bpy/app/timers/__init__.pyi +9 -11
  149. bpy/app/translations/__init__.pyi +20 -22
  150. bpy/msgbus/__init__.pyi +3 -12
  151. bpy/ops/action/__init__.pyi +350 -305
  152. bpy/ops/anim/__init__.pyi +464 -426
  153. bpy/ops/armature/__init__.pyi +392 -360
  154. bpy/ops/asset/__init__.pyi +166 -129
  155. bpy/ops/boid/__init__.pyi +64 -37
  156. bpy/ops/brush/__init__.pyi +78 -72
  157. bpy/ops/buttons/__init__.pyi +136 -122
  158. bpy/ops/cachefile/__init__.pyi +128 -123
  159. bpy/ops/camera/__init__.pyi +22 -24
  160. bpy/ops/clip/__init__.pyi +844 -735
  161. bpy/ops/cloth/__init__.pyi +10 -11
  162. bpy/ops/collection/__init__.pyi +38 -38
  163. bpy/ops/console/__init__.pyi +170 -141
  164. bpy/ops/constraint/__init__.pyi +156 -159
  165. bpy/ops/curve/__init__.pyi +518 -461
  166. bpy/ops/curves/__init__.pyi +188 -159
  167. bpy/ops/cycles/__init__.pyi +20 -18
  168. bpy/ops/dpaint/__init__.pyi +40 -30
  169. bpy/ops/ed/__init__.pyi +136 -107
  170. bpy/ops/export_anim/__init__.pyi +18 -19
  171. bpy/ops/export_mesh/__init__.pyi +26 -27
  172. bpy/ops/export_scene/__init__.pyi +313 -334
  173. bpy/ops/file/__init__.pyi +394 -304
  174. bpy/ops/fluid/__init__.pyi +114 -63
  175. bpy/ops/font/__init__.pyi +272 -245
  176. bpy/ops/geometry/__init__.pyi +92 -87
  177. bpy/ops/gizmogroup/__init__.pyi +24 -21
  178. bpy/ops/gpencil/__init__.pyi +1530 -1476
  179. bpy/ops/graph/__init__.pyi +680 -659
  180. bpy/ops/grease_pencil/__init__.pyi +510 -390
  181. bpy/ops/image/__init__.pyi +650 -603
  182. bpy/ops/import_anim/__init__.pyi +26 -27
  183. bpy/ops/import_curve/__init__.pyi +6 -7
  184. bpy/ops/import_mesh/__init__.pyi +18 -21
  185. bpy/ops/import_scene/__init__.pyi +86 -95
  186. bpy/ops/info/__init__.pyi +68 -55
  187. bpy/ops/lattice/__init__.pyi +70 -63
  188. bpy/ops/marker/__init__.pyi +110 -111
  189. bpy/ops/mask/__init__.pyi +352 -308
  190. bpy/ops/material/__init__.pyi +24 -12
  191. bpy/ops/mball/__init__.pyi +72 -75
  192. bpy/ops/mesh/__init__.pyi +2052 -2088
  193. bpy/ops/nla/__init__.pyi +369 -313
  194. bpy/ops/node/__init__.pyi +944 -805
  195. bpy/ops/object/__init__.pyi +2662 -2461
  196. bpy/ops/outliner/__init__.pyi +582 -431
  197. bpy/ops/paint/__init__.pyi +605 -516
  198. bpy/ops/paintcurve/__init__.pyi +72 -60
  199. bpy/ops/palette/__init__.pyi +54 -46
  200. bpy/ops/particle/__init__.pyi +302 -245
  201. bpy/ops/pose/__init__.pyi +366 -330
  202. bpy/ops/poselib/__init__.pyi +78 -64
  203. bpy/ops/preferences/__init__.pyi +361 -341
  204. bpy/ops/ptcache/__init__.pyi +56 -38
  205. bpy/ops/render/__init__.pyi +120 -117
  206. bpy/ops/rigidbody/__init__.pyi +114 -97
  207. bpy/ops/scene/__init__.pyi +302 -240
  208. bpy/ops/screen/__init__.pyi +414 -363
  209. bpy/ops/script/__init__.pyi +20 -18
  210. bpy/ops/sculpt/__init__.pyi +414 -452
  211. bpy/ops/sculpt_curves/__init__.pyi +42 -43
  212. bpy/ops/sequencer/__init__.pyi +1094 -1053
  213. bpy/ops/sound/__init__.pyi +214 -206
  214. bpy/ops/spreadsheet/__init__.pyi +34 -28
  215. bpy/ops/surface/__init__.pyi +108 -114
  216. bpy/ops/text/__init__.pyi +432 -350
  217. bpy/ops/text_editor/__init__.pyi +10 -11
  218. bpy/ops/texture/__init__.pyi +32 -21
  219. bpy/ops/transform/__init__.pyi +801 -854
  220. bpy/ops/ui/__init__.pyi +254 -185
  221. bpy/ops/uilist/__init__.pyi +20 -23
  222. bpy/ops/uv/__init__.pyi +618 -626
  223. bpy/ops/view2d/__init__.pyi +162 -161
  224. bpy/ops/view3d/__init__.pyi +669 -658
  225. bpy/ops/wm/__init__.pyi +2433 -2415
  226. bpy/ops/workspace/__init__.pyi +54 -31
  227. bpy/ops/world/__init__.pyi +8 -4
  228. bpy/path/__init__.pyi +111 -68
  229. bpy/props/__init__.pyi +263 -267
  230. bpy/types/__init__.pyi +86789 -85719
  231. bpy/utils/__init__.pyi +265 -123
  232. bpy/utils/previews/__init__.pyi +103 -17
  233. bpy/utils/units/__init__.pyi +19 -22
  234. bpy_extras/__init__.pyi +0 -4
  235. bpy_extras/anim_utils/__init__.pyi +11 -46
  236. bpy_extras/asset_utils/__init__.pyi +3 -12
  237. bpy_extras/id_map_utils/__init__.pyi +0 -2
  238. bpy_extras/image_utils/__init__.pyi +2 -2
  239. bpy_extras/io_utils/__init__.pyi +30 -27
  240. bpy_extras/keyconfig_utils/__init__.pyi +4 -1
  241. bpy_extras/mesh_utils/__init__.pyi +18 -18
  242. bpy_extras/node_utils/__init__.pyi +4 -3
  243. bpy_extras/object_utils/__init__.pyi +25 -26
  244. bpy_extras/view3d_utils/__init__.pyi +33 -38
  245. bpy_restrict_state/__init__.pyi +14 -1
  246. bpy_types/__init__.pyi +3873 -997
  247. console_python/__init__.pyi +41 -7
  248. console_shell/__init__.pyi +24 -5
  249. {fake_bpy_module-20240224.dist-info → fake_bpy_module-20240326.dist-info}/METADATA +1 -1
  250. fake_bpy_module-20240326.dist-info/RECORD +343 -0
  251. {fake_bpy_module-20240224.dist-info → fake_bpy_module-20240326.dist-info}/WHEEL +1 -1
  252. freestyle/chainingiterators/__init__.pyi +50 -52
  253. freestyle/functions/__init__.pyi +303 -207
  254. freestyle/predicates/__init__.pyi +299 -115
  255. freestyle/shaders/__init__.pyi +49 -80
  256. freestyle/types/__init__.pyi +465 -472
  257. freestyle/utils/ContextFunctions/__init__.pyi +9 -9
  258. freestyle/utils/__init__.pyi +28 -18
  259. gpu/capabilities/__init__.pyi +27 -19
  260. gpu/matrix/__init__.pyi +14 -16
  261. gpu/platform/__init__.pyi +5 -5
  262. gpu/shader/__init__.pyi +2 -5
  263. gpu/state/__init__.pyi +1 -1
  264. gpu/texture/__init__.pyi +3 -3
  265. gpu/types/__init__.pyi +54 -85
  266. gpu_extras/batch/__init__.pyi +27 -5
  267. gpu_extras/presets/__init__.pyi +52 -14
  268. graphviz_export/__init__.pyi +9 -2
  269. idprop/types/__init__.pyi +36 -12
  270. imbuf/__init__.pyi +8 -9
  271. imbuf/types/__init__.pyi +8 -15
  272. keyingsets_builtins/__init__.pyi +3149 -701
  273. keyingsets_utils/__init__.pyi +69 -14
  274. mathutils/__init__.pyi +502 -427
  275. mathutils/bvhtree/__init__.pyi +28 -32
  276. mathutils/geometry/__init__.pyi +177 -186
  277. mathutils/kdtree/__init__.pyi +16 -18
  278. mathutils/noise/__init__.pyi +47 -48
  279. nodeitems_builtins/__init__.pyi +50 -10
  280. nodeitems_utils/__init__.pyi +58 -10
  281. rna_info/__init__.pyi +230 -26
  282. rna_keymap_ui/__init__.pyi +29 -6
  283. rna_prop_ui/__init__.pyi +69 -12
  284. rna_xml/__init__.pyi +29 -6
  285. sys_info/__init__.pyi +4 -1
  286. bpy_extras/bmesh_utils/__init__.pyi +0 -6
  287. bpy_extras/extensions/__init__.pyi +0 -4
  288. bpy_extras/extensions/junction_module/__init__.pyi +0 -12
  289. bpy_extras/node_shader_utils/__init__.pyi +0 -131
  290. bpy_extras/wm_utils/__init__.pyi +0 -4
  291. bpy_extras/wm_utils/progress_report/__init__.pyi +0 -29
  292. fake_bpy_module-20240224.dist-info/RECORD +0 -349
  293. {fake_bpy_module-20240224.dist-info → fake_bpy_module-20240326.dist-info}/top_level.txt +0 -0
gpu/types/__init__.pyi CHANGED
@@ -13,26 +13,24 @@ class Buffer:
13
13
  class GPUBatch:
14
14
  """Reusable container for drawable geometry."""
15
15
 
16
- def draw(self, program: "GPUShader" = None):
16
+ def draw(self, program: GPUShader = None):
17
17
  """Run the drawing program with the parameters assigned to the batch.
18
18
 
19
19
  :param program: Program that performs the drawing operations.
20
20
  If None is passed, the last program set to this batch will run.
21
- :type program: 'GPUShader'
21
+ :type program: GPUShader
22
22
  """
23
23
  ...
24
24
 
25
25
  def draw_instanced(
26
- self, program: "GPUShader", *, instance_start: int = 0, instance_count: int = 0
26
+ self, program: GPUShader, instance_start: int = 0, instance_count: int = 0
27
27
  ):
28
28
  """Draw multiple instances of the drawing program with the parameters assigned
29
29
  to the batch. In the vertex shader, gl_InstanceID will contain the instance
30
30
  number being drawn.
31
31
 
32
32
  :param program: Program that performs the drawing operations.
33
- :type program: 'GPUShader'
34
- :param *:
35
- :type *:
33
+ :type program: GPUShader
36
34
  :param instance_start: Number of the first instance to draw.
37
35
  :type instance_start: int
38
36
  :param instance_count: Number of instances to draw. When not provided or set to 0
@@ -42,16 +40,12 @@ class GPUBatch:
42
40
  """
43
41
  ...
44
42
 
45
- def draw_range(
46
- self, program: "GPUShader", *, elem_start: int = 0, elem_count: int = 0
47
- ):
43
+ def draw_range(self, program: GPUShader, elem_start: int = 0, elem_count: int = 0):
48
44
  """Run the drawing program with the parameters assigned to the batch. Only draw
49
45
  the elem_count elements of the index buffer starting at elem_start
50
46
 
51
47
  :param program: Program that performs the drawing operations.
52
- :type program: 'GPUShader'
53
- :param *:
54
- :type *:
48
+ :type program: GPUShader
55
49
  :param elem_start: First index to draw. When not provided or set to 0 drawing
56
50
  will start from the first element of the index buffer.
57
51
  :type elem_start: int
@@ -62,18 +56,18 @@ class GPUBatch:
62
56
  """
63
57
  ...
64
58
 
65
- def program_set(self, program: "GPUShader"):
59
+ def program_set(self, program: GPUShader):
66
60
  """Assign a shader to this batch that will be used for drawing when not overwritten later.
67
61
  Note: This method has to be called in the draw context that the batch will be drawn in.
68
62
  This function does not need to be called when you always
69
63
  set the shader when calling `gpu.types.GPUBatch.draw`.
70
64
 
71
65
  :param program: The program/shader the batch will use in future draw calls.
72
- :type program: 'GPUShader'
66
+ :type program: GPUShader
73
67
  """
74
68
  ...
75
69
 
76
- def vertbuf_add(self, buf: "GPUVertBuf"):
70
+ def vertbuf_add(self, buf: GPUVertBuf):
77
71
  """Add another vertex buffer to the Batch.
78
72
  It is not possible to add more vertices to the batch using this method.
79
73
  Instead it can be used to add more attributes to the existing vertices.
@@ -82,7 +76,7 @@ class GPUBatch:
82
76
  Current a batch can have at most 16 vertex buffers.
83
77
 
84
78
  :param buf: The vertex buffer that will be added to the batch.
85
- :type buf: 'GPUVertBuf'
79
+ :type buf: GPUVertBuf
86
80
  """
87
81
  ...
88
82
 
@@ -99,14 +93,11 @@ class GPUFrameBuffer:
99
93
  """Context manager to ensure balanced bind calls, even in the case of an error."""
100
94
  ...
101
95
 
102
- def clear(
103
- self, color: typing.List = None, depth: float = None, stencil: int = None
104
- ):
96
+ def clear(self, color=None, depth: float = None, stencil: int = None):
105
97
  """Fill color, depth and stencil textures with specific value.
106
98
  Common values: color=(0.0, 0.0, 0.0, 1.0), depth=1.0, stencil=0.
107
99
 
108
100
  :param color: float sequence each representing (r, g, b, a).
109
- :type color: typing.List
110
101
  :param depth: depth value.
111
102
  :type depth: float
112
103
  :param stencil: stencil value.
@@ -123,18 +114,15 @@ class GPUFrameBuffer:
123
114
  channels: int,
124
115
  slot: int,
125
116
  format: str,
126
- data: "Buffer" = None,
127
- ) -> "Buffer":
117
+ data: Buffer = None,
118
+ ) -> Buffer:
128
119
  """Read a block of pixels from the frame buffer.
129
120
 
130
121
  :param x: Lower left corner of a rectangular block of pixels.
131
122
  :type x: int
132
123
  :param y:
133
- :type y:
134
124
  :param xsize: Dimensions of the pixel rectangle.
135
- :type xsize:
136
125
  :param ysize:
137
- :type ysize:
138
126
  :param channels: Number of components to read.
139
127
  :type channels: int
140
128
  :param slot: The framebuffer slot to read data from.
@@ -143,29 +131,25 @@ class GPUFrameBuffer:
143
131
  Possible values are FLOAT, INT, UINT, UBYTE, UINT_24_8 and 10_11_11_REV.
144
132
  :type format: str
145
133
  :param data: Optional Buffer object to fill with the pixels values.
146
- :type data: 'Buffer'
147
- :rtype: 'Buffer'
134
+ :type data: Buffer
148
135
  :return: The Buffer with the read pixels.
136
+ :rtype: Buffer
149
137
  """
150
138
  ...
151
139
 
152
- def read_depth(
153
- self, x: int, y, xsize: int, ysize, data: "Buffer" = None
154
- ) -> "Buffer":
140
+ def read_depth(self, x: int, y, xsize: int, ysize, data: Buffer = None) -> Buffer:
155
141
  """Read a pixel depth block from the frame buffer.
156
142
 
157
143
  :param x: Lower left corner of a rectangular block of pixels.
158
144
  :type x: int
159
145
  :param y:
160
- :type y:
161
146
  :param xsize: Dimensions of the pixel rectangle.
162
147
  :type xsize: int
163
148
  :param ysize:
164
- :type ysize:
165
149
  :param data: Optional Buffer object to fill with the pixels values.
166
- :type data: 'Buffer'
167
- :rtype: 'Buffer'
150
+ :type data: Buffer
168
151
  :return: The Buffer with the read pixels.
152
+ :rtype: Buffer
169
153
  """
170
154
  ...
171
155
 
@@ -180,11 +164,9 @@ class GPUFrameBuffer:
180
164
  :param x: lower left corner of the viewport_set rectangle, in pixels.
181
165
  :type x: int
182
166
  :param y:
183
- :type y:
184
167
  :param xsize: width and height of the viewport_set.
185
168
  :type xsize: int
186
169
  :param ysize:
187
- :type ysize:
188
170
  """
189
171
  ...
190
172
 
@@ -208,10 +190,10 @@ class GPUOffScreen:
208
190
  :type: int
209
191
  """
210
192
 
211
- texture_color: "GPUTexture"
193
+ texture_color: GPUTexture
212
194
  """ The color texture attached.
213
195
 
214
- :type: 'GPUTexture'
196
+ :type: GPUTexture
215
197
  """
216
198
 
217
199
  width: int
@@ -226,29 +208,29 @@ class GPUOffScreen:
226
208
 
227
209
  def draw_view3d(
228
210
  self,
229
- scene: "bpy.types.Scene",
230
- view_layer: "bpy.types.ViewLayer",
231
- view3d: "bpy.types.SpaceView3D",
232
- region: "bpy.types.Region",
233
- view_matrix: typing.Union["mathutils.Matrix", typing.Sequence[float]],
234
- projection_matrix: typing.Union["mathutils.Matrix", typing.Sequence[float]],
211
+ scene: bpy.types.Scene,
212
+ view_layer: bpy.types.ViewLayer,
213
+ view3d: bpy.types.SpaceView3D,
214
+ region: bpy.types.Region,
215
+ view_matrix: typing.Union[typing.Sequence[float], mathutils.Matrix],
216
+ projection_matrix: typing.Union[typing.Sequence[float], mathutils.Matrix],
235
217
  do_color_management: bool = False,
236
218
  draw_background: bool = True,
237
219
  ):
238
220
  """Draw the 3d viewport in the offscreen object.
239
221
 
240
222
  :param scene: Scene to draw.
241
- :type scene: 'bpy.types.Scene'
223
+ :type scene: bpy.types.Scene
242
224
  :param view_layer: View layer to draw.
243
- :type view_layer: 'bpy.types.ViewLayer'
225
+ :type view_layer: bpy.types.ViewLayer
244
226
  :param view3d: 3D View to get the drawing settings from.
245
- :type view3d: 'bpy.types.SpaceView3D'
227
+ :type view3d: bpy.types.SpaceView3D
246
228
  :param region: Region of the 3D View (required as temporary draw target).
247
- :type region: 'bpy.types.Region'
229
+ :type region: bpy.types.Region
248
230
  :param view_matrix: View Matrix (e.g. camera.matrix_world.inverted()).
249
- :type view_matrix: typing.Union['mathutils.Matrix', typing.Sequence[float]]
231
+ :type view_matrix: typing.Union[typing.Sequence[float], mathutils.Matrix]
250
232
  :param projection_matrix: Projection Matrix (e.g. camera.calc_matrix_camera(...)).
251
- :type projection_matrix: typing.Union['mathutils.Matrix', typing.Sequence[float]]
233
+ :type projection_matrix: typing.Union[typing.Sequence[float], mathutils.Matrix]
252
234
  :param do_color_management: Color manage the output.
253
235
  :type do_color_management: bool
254
236
  :param draw_background: Draw background.
@@ -294,21 +276,21 @@ class GPUShader:
294
276
  :type: int
295
277
  """
296
278
 
297
- def attr_from_name(self, name: str) -> int:
279
+ def attr_from_name(self, name: str) -> str:
298
280
  """Get attribute location by name.
299
281
 
300
282
  :param name: The name of the attribute variable whose location is to be queried.
301
283
  :type name: str
302
- :rtype: int
303
284
  :return: The location of an attribute variable.
285
+ :rtype: int
304
286
  """
305
287
  ...
306
288
 
307
- def attrs_info_get(self) -> typing.Tuple:
289
+ def attrs_info_get(self) -> int:
308
290
  """Information about the attributes used in the Shader.
309
291
 
310
- :rtype: typing.Tuple
311
292
  :return: tuples containing information about the attributes in order (name, type)
293
+ :rtype: typing.Tuple
312
294
  """
313
295
  ...
314
296
 
@@ -316,21 +298,21 @@ class GPUShader:
316
298
  """Bind the shader object. Required to be able to change uniforms of this shader."""
317
299
  ...
318
300
 
319
- def format_calc(self) -> "GPUVertFormat":
301
+ def format_calc(self) -> typing.Tuple:
320
302
  """Build a new format based on the attributes of the shader.
321
303
 
322
- :rtype: 'GPUVertFormat'
323
304
  :return: vertex attribute format for the shader
305
+ :rtype: GPUVertFormat
324
306
  """
325
307
  ...
326
308
 
327
- def image(self, name: str, texture: "GPUTexture"):
309
+ def image(self, name: str, texture: GPUTexture):
328
310
  """Specify the value of an image variable for the current GPUShader.
329
311
 
330
312
  :param name: Name of the image variable to which the texture is to be bound.
331
313
  :type name: str
332
314
  :param texture: Texture to attach.
333
- :type texture: 'GPUTexture'
315
+ :type texture: GPUTexture
334
316
  """
335
317
  ...
336
318
 
@@ -340,17 +322,16 @@ class GPUShader:
340
322
  :param name: name of the uniform variable whose UBO is to be specified.
341
323
  :type name: str
342
324
  :param ubo: Uniform Buffer to attach.
343
- :type ubo:
344
325
  """
345
326
  ...
346
327
 
347
- def uniform_block_from_name(self, name: str) -> int:
328
+ def uniform_block_from_name(self, name: str) -> str:
348
329
  """Get uniform block location by name.
349
330
 
350
331
  :param name: Name of the uniform block variable whose location is to be queried.
351
332
  :type name: str
352
- :rtype: int
353
333
  :return: The location of the uniform block variable.
334
+ :rtype: int
354
335
  """
355
336
  ...
356
337
 
@@ -364,43 +345,41 @@ class GPUShader:
364
345
  """
365
346
  ...
366
347
 
367
- def uniform_float(self, name: str, value: typing.List):
348
+ def uniform_float(self, name: str, value):
368
349
  """Specify the value of a uniform variable for the current program object.
369
350
 
370
351
  :param name: Name of the uniform variable whose value is to be changed.
371
352
  :type name: str
372
353
  :param value: Value that will be used to update the specified uniform variable.
373
- :type value: typing.List
374
354
  """
375
355
  ...
376
356
 
377
- def uniform_from_name(self, name: str) -> int:
357
+ def uniform_from_name(self, name: str) -> str:
378
358
  """Get uniform location by name.
379
359
 
380
360
  :param name: Name of the uniform variable whose location is to be queried.
381
361
  :type name: str
382
- :rtype: int
383
362
  :return: Location of the uniform variable.
363
+ :rtype: int
384
364
  """
385
365
  ...
386
366
 
387
- def uniform_int(self, name: str, seq: typing.List):
367
+ def uniform_int(self, name: str, seq):
388
368
  """Specify the value of a uniform variable for the current program object.
389
369
 
390
370
  :param name: name of the uniform variable whose value is to be changed.
391
371
  :type name: str
392
372
  :param seq: Value that will be used to update the specified uniform variable.
393
- :type seq: typing.List
394
373
  """
395
374
  ...
396
375
 
397
- def uniform_sampler(self, name: str, texture: "GPUTexture"):
376
+ def uniform_sampler(self, name: str, texture: GPUTexture):
398
377
  """Specify the value of a texture uniform variable for the current GPUShader.
399
378
 
400
379
  :param name: name of the uniform variable whose texture is to be specified.
401
380
  :type name: str
402
381
  :param texture: Texture to attach.
403
- :type texture: 'GPUTexture'
382
+ :type texture: GPUTexture
404
383
  """
405
384
  ...
406
385
 
@@ -436,13 +415,9 @@ class GPUShader:
436
415
  """See GPUShader.uniform_vector_float(...) description.
437
416
 
438
417
  :param location:
439
- :type location:
440
418
  :param buffer:
441
- :type buffer:
442
419
  :param length:
443
- :type length:
444
420
  :param count:
445
- :type count:
446
421
  """
447
422
  ...
448
423
 
@@ -461,9 +436,7 @@ class GPUShaderCreateInfo:
461
436
  """Add a preprocessing define directive. In GLSL it would be something like:
462
437
 
463
438
  :param name:
464
- :type name:
465
439
  :param value:
466
- :type value:
467
440
  """
468
441
  ...
469
442
 
@@ -525,7 +498,7 @@ class GPUShaderCreateInfo:
525
498
  format: str,
526
499
  type: str,
527
500
  name: str,
528
- qualifiers: typing.Set = {'"NO_RESTRICT"'},
501
+ qualifiers: set = {'"NO_RESTRICT"'},
529
502
  ):
530
503
  """Specify an image resource used for arbitrary load and store operations.
531
504
 
@@ -693,7 +666,7 @@ class GPUShaderCreateInfo:
693
666
  - NO_RESTRICT
694
667
  - READ
695
668
  - WRITE
696
- :type qualifiers: typing.Set
669
+ :type qualifiers: set
697
670
  """
698
671
  ...
699
672
 
@@ -709,7 +682,7 @@ class GPUShaderCreateInfo:
709
682
  """
710
683
  ...
711
684
 
712
- def push_constant(self, type: str, name: str, size: typing.Any = 0):
685
+ def push_constant(self, type: str, name: str, size=0):
713
686
  """Specify a global access constant.
714
687
 
715
688
  :param type: One of these types:
@@ -747,7 +720,6 @@ class GPUShaderCreateInfo:
747
720
  :param name: Name of the constant.
748
721
  :type name: str
749
722
  :param size: If not zero, indicates that the constant is an array with the specified size.
750
- :type size: typing.Any
751
723
  """
752
724
  ...
753
725
 
@@ -831,7 +803,6 @@ class GPUShaderCreateInfo:
831
803
  """Source code included before resource declaration. Useful for defining structs used by Uniform Buffers.Example:
832
804
 
833
805
  :param source:
834
- :type source:
835
806
  """
836
807
  ...
837
808
 
@@ -889,11 +860,11 @@ class GPUShaderCreateInfo:
889
860
  """
890
861
  ...
891
862
 
892
- def vertex_out(self, interface: "GPUStageInterfaceInfo"):
863
+ def vertex_out(self, interface: GPUStageInterfaceInfo):
893
864
  """Add a vertex shader output interface block.
894
865
 
895
866
  :param interface: Object describing the block.
896
- :type interface: 'GPUStageInterfaceInfo'
867
+ :type interface: GPUStageInterfaceInfo
897
868
  """
898
869
  ...
899
870
 
@@ -1055,14 +1026,13 @@ class GPUTexture:
1055
1026
  :type: int
1056
1027
  """
1057
1028
 
1058
- def clear(self, format: str = "FLOAT", value: typing.List = (0.0, 0.0, 0.0, 1.0)):
1029
+ def clear(self, format: str = "FLOAT", value=(0.0, 0.0, 0.0, 1.0)):
1059
1030
  """Fill texture with specific value.
1060
1031
 
1061
1032
  :param format: The format that describes the content of a single item.
1062
1033
  Possible values are FLOAT, INT, UINT, UBYTE, UINT_24_8 and 10_11_11_REV.
1063
1034
  :type format: str
1064
1035
  :param value: sequence each representing the value to fill.
1065
- :type value: typing.List
1066
1036
  """
1067
1037
  ...
1068
1038
 
@@ -1077,7 +1047,6 @@ class GPUUniformBuf:
1077
1047
  """Update the data of the uniform buffer object.
1078
1048
 
1079
1049
  :param data:
1080
- :type data:
1081
1050
  """
1082
1051
  ...
1083
1052
 
@@ -4,18 +4,40 @@ import gpu.types
4
4
  GenericType = typing.TypeVar("GenericType")
5
5
 
6
6
  def batch_for_shader(
7
- shader: "gpu.types.GPUShader", type: str, content: typing.Dict, *, indices=None
8
- ) -> "gpu.types.GPUBatch":
7
+ shader: gpu.types.GPUShader, type: str, content: dict, indices=None
8
+ ) -> gpu.types.GPUBatch:
9
9
  """Return a batch already configured and compatible with the shader.
10
10
 
11
11
  :param shader: shader for which a compatible format will be computed.
12
- :type shader: 'gpu.types.GPUShader'
12
+ :type shader: gpu.types.GPUShader
13
13
  :param type: "'POINTS', 'LINES', 'TRIS' or 'LINES_ADJ'".
14
14
  :type type: str
15
15
  :param content: Maps the name of the shader attribute with the data to fill the vertex buffer.
16
- :type content: typing.Dict
17
- :rtype: 'gpu.types.GPUBatch'
16
+ :type content: dict
18
17
  :return: compatible batch
18
+ :rtype: gpu.types.GPUBatch
19
19
  """
20
20
 
21
21
  ...
22
+
23
+ def batch_for_shader(
24
+ shader: gpu.types.GPUShader, type: str, content: dict, indices=None
25
+ ) -> gpu.types.GPUBatch:
26
+ """Return a batch already configured and compatible with the shader.
27
+
28
+ :param shader: shader for which a compatible format will be computed.
29
+ :type shader: gpu.types.GPUShader
30
+ :param type: "'POINTS', 'LINES', 'TRIS' or 'LINES_ADJ'".
31
+ :type type: str
32
+ :param content: Maps the name of the shader attribute with the data to fill the vertex buffer.
33
+ :type content: dict
34
+ :return: compatible batch
35
+ :rtype: gpu.types.GPUBatch
36
+ """
37
+
38
+ ...
39
+
40
+ def batch_for_shader(shader, type, content, indices):
41
+ """ """
42
+
43
+ ...
@@ -4,41 +4,53 @@ import mathutils
4
4
 
5
5
  GenericType = typing.TypeVar("GenericType")
6
6
 
7
- def draw_circle_2d(
8
- position: "mathutils.Vector",
9
- color: typing.Tuple,
10
- radius: float,
11
- *,
12
- segments: typing.Optional[int] = None,
13
- ):
7
+ def draw_circle_2d(position: mathutils.Vector, color, radius: float, segments=None):
14
8
  """Draw a circle.
15
9
 
16
10
  :param position: Position where the circle will be drawn.
17
- :type position: 'mathutils.Vector'
11
+ :type position: mathutils.Vector
18
12
  :param color: Color of the circle. To use transparency GL_BLEND has to be enabled.
19
- :type color: typing.Tuple
20
13
  :param radius: Radius of the circle.
21
14
  :type radius: float
22
15
  :param segments: How many segments will be used to draw the circle.
23
16
  Higher values give better results but the drawing will take longer.
24
17
  If None or not specified, an automatic value will be calculated.
25
- :type segments: typing.Optional[int]
26
18
  """
27
19
 
28
20
  ...
29
21
 
22
+ def draw_circle_2d(position: mathutils.Vector, color, radius: float, segments=None):
23
+ """Draw a circle.
24
+
25
+ :param position: Position where the circle will be drawn.
26
+ :type position: mathutils.Vector
27
+ :param color: Color of the circle. To use transparency GL_BLEND has to be enabled.
28
+ :param radius: Radius of the circle.
29
+ :type radius: float
30
+ :param segments: How many segments will be used to draw the circle.
31
+ Higher values give better results but the drawing will take longer.
32
+ If None or not specified, an automatic value will be calculated.
33
+ """
34
+
35
+ ...
36
+
37
+ def draw_circle_2d(position, color, radius, segments):
38
+ """ """
39
+
40
+ ...
41
+
30
42
  def draw_texture_2d(
31
- texture: "gpu.types.GPUTexture",
32
- position: "mathutils.Vector",
43
+ texture: gpu.types.GPUTexture,
44
+ position: mathutils.Vector,
33
45
  width: float,
34
46
  height: float,
35
47
  ):
36
48
  """Draw a 2d texture.
37
49
 
38
50
  :param texture: GPUTexture to draw (e.g. gpu.texture.from_image(image) for `bpy.types.Image`).
39
- :type texture: 'gpu.types.GPUTexture'
51
+ :type texture: gpu.types.GPUTexture
40
52
  :param position: Position of the lower left corner.
41
- :type position: 'mathutils.Vector'
53
+ :type position: mathutils.Vector
42
54
  :param width: Width of the image when drawn (not necessarily
43
55
  the original width of the texture).
44
56
  :type width: float
@@ -47,3 +59,29 @@ def draw_texture_2d(
47
59
  """
48
60
 
49
61
  ...
62
+
63
+ def draw_texture_2d(
64
+ texture: gpu.types.GPUTexture,
65
+ position: mathutils.Vector,
66
+ width: float,
67
+ height: float,
68
+ ):
69
+ """Draw a 2d texture.
70
+
71
+ :param texture: GPUTexture to draw (e.g. gpu.texture.from_image(image) for `bpy.types.Image`).
72
+ :type texture: gpu.types.GPUTexture
73
+ :param position: Position of the lower left corner.
74
+ :type position: mathutils.Vector
75
+ :param width: Width of the image when drawn (not necessarily
76
+ the original width of the texture).
77
+ :type width: float
78
+ :param height: Height of the image when drawn.
79
+ :type height: float
80
+ """
81
+
82
+ ...
83
+
84
+ def draw_texture_2d(texture, position, width, height):
85
+ """ """
86
+
87
+ ...
@@ -2,5 +2,12 @@ import typing
2
2
 
3
3
  GenericType = typing.TypeVar("GenericType")
4
4
 
5
- def compat_str(text, line_length): ...
6
- def graph_armature(obj, filepath, FAKE_PARENT, CONSTRAINTS, DRIVERS, XTRA_INFO): ...
5
+ def compat_str(text, line_length):
6
+ """ """
7
+
8
+ ...
9
+
10
+ def graph_armature(obj, filepath, FAKE_PARENT, CONSTRAINTS, DRIVERS, XTRA_INFO):
11
+ """ """
12
+
13
+ ...