fake-bpy-module 20250612__py3-none-any.whl → 20260118__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 (325) hide show
  1. {bl_console_utils → _bl_console_utils}/autocomplete/complete_calltip/__init__.pyi +0 -13
  2. {bl_console_utils → _bl_console_utils}/autocomplete/complete_import/__init__.pyi +0 -5
  3. {bl_console_utils → _bl_console_utils}/autocomplete/complete_namespace/__init__.pyi +0 -11
  4. {bl_console_utils → _bl_console_utils}/autocomplete/intellisense/__init__.pyi +0 -10
  5. {bl_i18n_utils → _bl_i18n_utils}/__init__.pyi +1 -0
  6. {bl_i18n_utils → _bl_i18n_utils}/bl_extract_messages/__init__.pyi +1 -0
  7. {bl_i18n_utils → _bl_i18n_utils}/settings/__init__.pyi +3 -1
  8. {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +4 -4
  9. _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
  10. {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
  11. _blendfile_header/__init__.pyi +48 -0
  12. _bpy_internal/__init__.pyi +4 -1
  13. _bpy_internal/assets/__init__.pyi +5 -0
  14. _bpy_internal/assets/remote_library_listing/__init__.pyi +5 -0
  15. _bpy_internal/assets/remote_library_listing/blender_asset_library_openapi/__init__.pyi +13 -0
  16. _bpy_internal/disk_file_hash_service/__init__.pyi +19 -0
  17. _bpy_internal/disk_file_hash_service/backend_sqlite/__init__.pyi +48 -0
  18. _bpy_internal/disk_file_hash_service/hash_service/__init__.pyi +64 -0
  19. _bpy_internal/disk_file_hash_service/types/__init__.pyi +53 -0
  20. _bpy_internal/extensions/wheel_manager/__init__.pyi +1 -1
  21. _bpy_internal/filesystem/__init__.pyi +5 -0
  22. _bpy_internal/filesystem/locking/__init__.pyi +28 -0
  23. _bpy_internal/grease_pencil/stroke/__init__.pyi +2 -2
  24. _bpy_internal/platform/__init__.pyi +5 -0
  25. _bpy_types/__init__.pyi +1592 -0
  26. {keyingsets_utils → _keyingsets_utils}/__init__.pyi +2 -0
  27. {rna_info → _rna_info}/__init__.pyi +4 -2
  28. addon_utils/__init__.pyi +0 -13
  29. aud/__init__.pyi +122 -145
  30. bl_app_templates_system/Storyboarding/__init__.pyi +11 -0
  31. bl_app_templates_system/__init__.pyi +5 -0
  32. bl_app_templates_system/py.typed +0 -0
  33. bl_math/__init__.pyi +3 -13
  34. bl_operators/__init__.pyi +1 -0
  35. bl_operators/add_mesh_torus/__init__.pyi +2 -3
  36. bl_operators/anim/__init__.pyi +62 -38
  37. bl_operators/assets/__init__.pyi +4 -9
  38. bl_operators/bone_selection_sets/__init__.pyi +15 -42
  39. bl_operators/clip/__init__.pyi +12 -31
  40. bl_operators/connect_to_output/__init__.pyi +2 -3
  41. bl_operators/console/__init__.pyi +6 -15
  42. bl_operators/constraint/__init__.pyi +6 -13
  43. bl_operators/copy_global_transform/__init__.pyi +261 -0
  44. bl_operators/file/__init__.pyi +6 -11
  45. bl_operators/freestyle/__init__.pyi +5 -12
  46. bl_operators/geometry_nodes/__init__.pyi +5 -12
  47. bl_operators/grease_pencil/__init__.pyi +2 -3
  48. bl_operators/image/__init__.pyi +6 -15
  49. bl_operators/image_as_planes/__init__.pyi +3 -10
  50. bl_operators/mesh/__init__.pyi +3 -49
  51. bl_operators/node/__init__.pyi +294 -73
  52. bl_operators/object/__init__.pyi +17 -53
  53. bl_operators/object_align/__init__.pyi +2 -3
  54. bl_operators/object_quick_effects/__init__.pyi +5 -12
  55. bl_operators/object_randomize_transform/__init__.pyi +2 -3
  56. bl_operators/presets/__init__.pyi +27 -76
  57. bl_operators/rigidbody/__init__.pyi +4 -9
  58. bl_operators/screen_play_rendered_anim/__init__.pyi +2 -3
  59. bl_operators/sequencer/__init__.pyi +12 -27
  60. bl_operators/spreadsheet/__init__.pyi +2 -3
  61. bl_operators/userpref/__init__.pyi +26 -75
  62. bl_operators/uvcalc_follow_active/__init__.pyi +3 -4
  63. bl_operators/uvcalc_lightmap/__init__.pyi +3 -4
  64. bl_operators/uvcalc_transform/__init__.pyi +26 -16
  65. bl_operators/vertexpaint_dirt/__init__.pyi +2 -3
  66. bl_operators/view3d/__init__.pyi +9 -24
  67. bl_operators/wm/__init__.pyi +48 -139
  68. bl_operators/world/__init__.pyi +3 -4
  69. bl_ui/__init__.pyi +7 -7
  70. bl_ui/anim/__init__.pyi +2 -3
  71. bl_ui/asset_shelf/__init__.pyi +2 -3
  72. bl_ui/generic_ui_list/__init__.pyi +4 -19
  73. bl_ui/node_add_menu/__init__.pyi +263 -7
  74. bl_ui/node_add_menu_compositor/__init__.pyi +96 -79
  75. bl_ui/node_add_menu_geometry/__init__.pyi +309 -270
  76. bl_ui/node_add_menu_shader/__init__.pyi +49 -49
  77. bl_ui/node_add_menu_texture/__init__.pyi +17 -62
  78. bl_ui/properties_collection/__init__.pyi +9 -22
  79. bl_ui/properties_constraint/__init__.pyi +129 -282
  80. bl_ui/properties_data_armature/__init__.pyi +22 -57
  81. bl_ui/properties_data_bone/__init__.pyi +12 -31
  82. bl_ui/properties_data_camera/__init__.pyi +18 -47
  83. bl_ui/properties_data_curve/__init__.pyi +18 -47
  84. bl_ui/properties_data_curves/__init__.pyi +11 -26
  85. bl_ui/properties_data_empty/__init__.pyi +3 -6
  86. bl_ui/properties_data_grease_pencil/__init__.pyi +23 -62
  87. bl_ui/properties_data_lattice/__init__.pyi +7 -14
  88. bl_ui/properties_data_light/__init__.pyi +13 -32
  89. bl_ui/properties_data_lightprobe/__init__.pyi +16 -43
  90. bl_ui/properties_data_mesh/__init__.pyi +47 -62
  91. bl_ui/properties_data_metaball/__init__.pyi +9 -20
  92. bl_ui/properties_data_modifier/__init__.pyi +22 -28
  93. bl_ui/properties_data_pointcloud/__init__.pyi +8 -19
  94. bl_ui/properties_data_shaderfx/__init__.pyi +2 -3
  95. bl_ui/properties_data_speaker/__init__.pyi +9 -20
  96. bl_ui/properties_data_volume/__init__.pyi +12 -29
  97. bl_ui/properties_freestyle/__init__.pyi +27 -76
  98. bl_ui/properties_grease_pencil_common/__init__.pyi +10 -168
  99. bl_ui/properties_mask_common/__init__.pyi +8 -21
  100. bl_ui/properties_material/__init__.pyi +26 -86
  101. bl_ui/properties_material_gpencil/__init__.pyi +36 -57
  102. bl_ui/properties_object/__init__.pyi +59 -65
  103. bl_ui/properties_output/__init__.pyi +21 -60
  104. bl_ui/properties_paint_common/__init__.pyi +30 -22
  105. bl_ui/properties_particle/__init__.pyi +58 -161
  106. bl_ui/properties_physics_cloth/__init__.pyi +15 -42
  107. bl_ui/properties_physics_common/__init__.pyi +2 -3
  108. bl_ui/properties_physics_dynamicpaint/__init__.pyi +23 -66
  109. bl_ui/properties_physics_field/__init__.pyi +11 -30
  110. bl_ui/properties_physics_fluid/__init__.pyi +29 -84
  111. bl_ui/properties_physics_geometry_nodes/__init__.pyi +2 -3
  112. bl_ui/properties_physics_rigidbody/__init__.pyi +9 -24
  113. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +14 -39
  114. bl_ui/properties_physics_softbody/__init__.pyi +16 -45
  115. bl_ui/properties_render/__init__.pyi +139 -197
  116. bl_ui/properties_scene/__init__.pyi +46 -50
  117. bl_ui/properties_strip/__init__.pyi +744 -0
  118. bl_ui/properties_strip_modifier/__init__.pyi +45 -0
  119. bl_ui/properties_texture/__init__.pyi +30 -83
  120. bl_ui/properties_view_layer/__init__.pyi +84 -39
  121. bl_ui/properties_workspace/__init__.pyi +6 -13
  122. bl_ui/properties_world/__init__.pyi +14 -35
  123. bl_ui/space_clip/__init__.pyi +150 -231
  124. bl_ui/space_console/__init__.pyi +7 -18
  125. bl_ui/space_dopesheet/__init__.pyi +143 -100
  126. bl_ui/space_filebrowser/__init__.pyi +33 -90
  127. bl_ui/space_graph/__init__.pyi +48 -85
  128. bl_ui/space_image/__init__.pyi +111 -229
  129. bl_ui/space_info/__init__.pyi +7 -18
  130. bl_ui/space_nla/__init__.pyi +44 -73
  131. bl_ui/space_node/__init__.pyi +161 -123
  132. bl_ui/space_outliner/__init__.pyi +16 -45
  133. bl_ui/space_properties/__init__.pyi +34 -10
  134. bl_ui/space_sequencer/__init__.pyi +164 -901
  135. bl_ui/space_spreadsheet/__init__.pyi +4 -9
  136. bl_ui/space_statusbar/__init__.pyi +2 -3
  137. bl_ui/space_text/__init__.pyi +17 -48
  138. bl_ui/space_time/__init__.pyi +25 -71
  139. bl_ui/space_toolsystem_common/__init__.pyi +2 -2
  140. bl_ui/space_toolsystem_toolbar/__init__.pyi +30 -7
  141. bl_ui/space_topbar/__init__.pyi +35 -79
  142. bl_ui/space_userpref/__init__.pyi +185 -321
  143. bl_ui/space_view3d/__init__.pyi +337 -817
  144. bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
  145. bl_ui/space_view3d_toolbar/__init__.pyi +110 -880
  146. bl_ui/utils/__init__.pyi +0 -17
  147. blend_render_info/__init__.pyi +1 -0
  148. blf/__init__.pyi +8 -54
  149. bmesh/__init__.pyi +2 -9
  150. bmesh/geometry/__init__.pyi +1 -4
  151. bmesh/ops/__init__.pyi +125 -508
  152. bmesh/types/__init__.pyi +318 -664
  153. bmesh/utils/__init__.pyi +17 -43
  154. bpy/__init__.pyi +1 -1
  155. bpy/app/__init__.pyi +93 -88
  156. bpy/app/handlers/__init__.pyi +19 -19
  157. bpy/app/icons/__init__.pyi +0 -6
  158. bpy/app/timers/__init__.pyi +2 -7
  159. bpy/app/translations/__init__.pyi +8 -23
  160. bpy/msgbus/__init__.pyi +4 -6
  161. bpy/ops/action/__init__.pyi +68 -199
  162. bpy/ops/anim/__init__.pyi +142 -299
  163. bpy/ops/armature/__init__.pyi +78 -209
  164. bpy/ops/asset/__init__.pyi +46 -108
  165. bpy/ops/boid/__init__.pyi +28 -45
  166. bpy/ops/brush/__init__.pyi +13 -108
  167. bpy/ops/buttons/__init__.pyi +16 -75
  168. bpy/ops/cachefile/__init__.pyi +8 -65
  169. bpy/ops/camera/__init__.pyi +0 -11
  170. bpy/ops/clip/__init__.pyi +173 -471
  171. bpy/ops/cloth/__init__.pyi +0 -5
  172. bpy/ops/collection/__init__.pyi +23 -36
  173. bpy/ops/console/__init__.pyi +40 -98
  174. bpy/ops/constraint/__init__.pyi +14 -85
  175. bpy/ops/curve/__init__.pyi +94 -277
  176. bpy/ops/curves/__init__.pyi +119 -166
  177. bpy/ops/cycles/__init__.pyi +4 -15
  178. bpy/ops/dpaint/__init__.pyi +14 -24
  179. bpy/ops/ed/__init__.pyi +44 -92
  180. bpy/ops/export_anim/__init__.pyi +2 -10
  181. bpy/ops/export_scene/__init__.pyi +16 -170
  182. bpy/ops/extensions/__init__.pyi +60 -165
  183. bpy/ops/file/__init__.pyi +110 -246
  184. bpy/ops/fluid/__init__.pyi +52 -83
  185. bpy/ops/font/__init__.pyi +40 -144
  186. bpy/ops/geometry/__init__.pyi +12 -127
  187. bpy/ops/gizmogroup/__init__.pyi +4 -13
  188. bpy/ops/gpencil/__init__.pyi +22 -54
  189. bpy/ops/graph/__init__.pyi +92 -343
  190. bpy/ops/grease_pencil/__init__.pyi +218 -550
  191. bpy/ops/image/__init__.pyi +85 -435
  192. bpy/ops/import_anim/__init__.pyi +3 -17
  193. bpy/ops/import_curve/__init__.pyi +2 -5
  194. bpy/ops/import_scene/__init__.pyi +15 -49
  195. bpy/ops/info/__init__.pyi +16 -39
  196. bpy/ops/lattice/__init__.pyi +12 -36
  197. bpy/ops/marker/__init__.pyi +12 -51
  198. bpy/ops/mask/__init__.pyi +68 -193
  199. bpy/ops/material/__init__.pyi +18 -18
  200. bpy/ops/mball/__init__.pyi +4 -31
  201. bpy/ops/mesh/__init__.pyi +140 -967
  202. bpy/ops/nla/__init__.pyi +87 -206
  203. bpy/ops/node/__init__.pyi +714 -744
  204. bpy/ops/object/__init__.pyi +461 -1341
  205. bpy/ops/outliner/__init__.pyi +192 -376
  206. bpy/ops/paint/__init__.pyi +94 -319
  207. bpy/ops/paintcurve/__init__.pyi +20 -40
  208. bpy/ops/palette/__init__.pyi +14 -30
  209. bpy/ops/particle/__init__.pyi +86 -184
  210. bpy/ops/pointcloud/__init__.pyi +12 -38
  211. bpy/ops/pose/__init__.pyi +108 -261
  212. bpy/ops/poselib/__init__.pyi +32 -67
  213. bpy/ops/preferences/__init__.pyi +37 -187
  214. bpy/ops/ptcache/__init__.pyi +22 -36
  215. bpy/ops/render/__init__.pyi +20 -72
  216. bpy/ops/rigidbody/__init__.pyi +25 -63
  217. bpy/ops/scene/__init__.pyi +122 -181
  218. bpy/ops/screen/__init__.pyi +93 -221
  219. bpy/ops/script/__init__.pyi +4 -13
  220. bpy/ops/sculpt/__init__.pyi +69 -324
  221. bpy/ops/sculpt_curves/__init__.pyi +10 -23
  222. bpy/ops/sequencer/__init__.pyi +410 -730
  223. bpy/ops/sound/__init__.pyi +16 -114
  224. bpy/ops/spreadsheet/__init__.pyi +20 -37
  225. bpy/ops/surface/__init__.pyi +0 -48
  226. bpy/ops/text/__init__.pyi +112 -250
  227. bpy/ops/text_editor/__init__.pyi +0 -5
  228. bpy/ops/texture/__init__.pyi +14 -21
  229. bpy/ops/transform/__init__.pyi +18 -386
  230. bpy/ops/ui/__init__.pyi +117 -188
  231. bpy/ops/uilist/__init__.pyi +0 -13
  232. bpy/ops/uv/__init__.pyi +238 -305
  233. bpy/ops/view2d/__init__.pyi +16 -76
  234. bpy/ops/view3d/__init__.pyi +153 -377
  235. bpy/ops/wm/__init__.pyi +277 -1397
  236. bpy/ops/workspace/__init__.pyi +32 -39
  237. bpy/ops/world/__init__.pyi +10 -12
  238. bpy/path/__init__.pyi +1 -35
  239. bpy/props/__init__.pyi +347 -218
  240. bpy/stub_internal/rna_enums/__init__.pyi +142 -108
  241. bpy/types/__init__.pyi +77367 -101305
  242. bpy/utils/__init__.pyi +11 -82
  243. bpy/utils/previews/__init__.pyi +2 -11
  244. bpy/utils/units/__init__.pyi +5 -15
  245. bpy_extras/anim_utils/__init__.pyi +24 -16
  246. bpy_extras/bmesh_utils/__init__.pyi +0 -1
  247. bpy_extras/id_map_utils/__init__.pyi +14 -6
  248. bpy_extras/image_utils/__init__.pyi +2 -11
  249. bpy_extras/io_utils/__init__.pyi +8 -27
  250. bpy_extras/keyconfig_utils/__init__.pyi +1 -1
  251. bpy_extras/mesh_utils/__init__.pyi +0 -12
  252. bpy_extras/node_shader_utils/__init__.pyi +1 -9
  253. bpy_extras/object_utils/__init__.pyi +1 -15
  254. bpy_extras/view3d_utils/__init__.pyi +0 -18
  255. bpy_extras/wm_utils/progress_report/__init__.pyi +1 -1
  256. {fake_bpy_module-20250612.dist-info → fake_bpy_module-20260118.dist-info}/METADATA +4 -1
  257. fake_bpy_module-20260118.dist-info/RECORD +385 -0
  258. {fake_bpy_module-20250612.dist-info → fake_bpy_module-20260118.dist-info}/top_level.txt +17 -16
  259. freestyle/chainingiterators/__init__.pyi +5 -27
  260. freestyle/functions/__init__.pyi +0 -139
  261. freestyle/predicates/__init__.pyi +2 -53
  262. freestyle/shaders/__init__.pyi +15 -81
  263. freestyle/types/__init__.pyi +159 -799
  264. freestyle/utils/ContextFunctions/__init__.pyi +0 -23
  265. freestyle/utils/__init__.pyi +5 -11
  266. gpu/capabilities/__init__.pyi +0 -21
  267. gpu/matrix/__init__.pyi +1 -10
  268. gpu/platform/__init__.pyi +2 -7
  269. gpu/shader/__init__.pyi +26 -9
  270. gpu/state/__init__.pyi +60 -39
  271. gpu/texture/__init__.pyi +3 -5
  272. gpu/types/__init__.pyi +116 -184
  273. gpu_extras/batch/__init__.pyi +1 -5
  274. gpu_extras/presets/__init__.pyi +6 -8
  275. idprop/types/__init__.pyi +6 -6
  276. imbuf/__init__.pyi +3 -10
  277. imbuf/types/__init__.pyi +7 -21
  278. keyingsets_builtins/__init__.pyi +24 -67
  279. mathutils/__init__.pyi +241 -2207
  280. mathutils/bvhtree/__init__.pyi +18 -26
  281. mathutils/geometry/__init__.pyi +82 -132
  282. mathutils/interpolate/__init__.pyi +6 -5
  283. mathutils/kdtree/__init__.pyi +1 -11
  284. mathutils/noise/__init__.pyi +61 -106
  285. rna_prop_ui/__init__.pyi +1 -1
  286. bgl/__init__.pyi +0 -4256
  287. bpy_types/__init__.pyi +0 -30
  288. fake_bpy_module-20250612.dist-info/RECORD +0 -367
  289. {animsys_refactor → _animsys_refactor}/__init__.pyi +0 -0
  290. {animsys_refactor → _animsys_refactor}/py.typed +0 -0
  291. {bl_console_utils → _bl_console_utils}/__init__.pyi +0 -0
  292. {bl_console_utils → _bl_console_utils}/autocomplete/__init__.pyi +0 -0
  293. {bgl → _bl_console_utils}/py.typed +0 -0
  294. {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +0 -0
  295. {bl_console_utils → _bl_i18n_utils}/py.typed +0 -0
  296. {bl_i18n_utils → _bl_i18n_utils}/utils_cli/__init__.pyi +0 -0
  297. {bl_i18n_utils → _bl_i18n_utils}/utils_languages_menu/__init__.pyi +0 -0
  298. {bl_i18n_utils → _bl_i18n_utils}/utils_rtl/__init__.pyi +0 -0
  299. {bl_previews_utils → _bl_previews_utils}/__init__.pyi +0 -0
  300. {bl_previews_utils → _bl_previews_utils}/bl_previews_render/__init__.pyi +0 -0
  301. {bl_i18n_utils → _bl_previews_utils}/py.typed +0 -0
  302. {bl_rna_utils → _bl_rna_utils}/__init__.pyi +0 -0
  303. {bl_rna_utils → _bl_rna_utils}/data_path/__init__.pyi +0 -0
  304. {bl_previews_utils → _bl_rna_utils}/py.typed +0 -0
  305. {bl_text_utils → _bl_text_utils}/__init__.pyi +0 -0
  306. {bl_text_utils → _bl_text_utils}/external_editor/__init__.pyi +0 -0
  307. {bl_rna_utils → _bl_text_utils}/py.typed +0 -0
  308. {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +0 -0
  309. {bl_text_utils → _bl_ui_utils}/py.typed +0 -0
  310. {bl_ui_utils → _blendfile_header}/py.typed +0 -0
  311. /_bpy_internal/{freedesktop → platform/freedesktop}/__init__.pyi +0 -0
  312. {bpy_restrict_state → _bpy_restrict_state}/__init__.pyi +0 -0
  313. {bpy_restrict_state → _bpy_restrict_state}/py.typed +0 -0
  314. {bpy_types → _bpy_types}/py.typed +0 -0
  315. {console_python → _console_python}/__init__.pyi +0 -0
  316. {console_python → _console_python}/py.typed +0 -0
  317. {console_shell → _console_shell}/__init__.pyi +0 -0
  318. {console_shell → _console_shell}/py.typed +0 -0
  319. {graphviz_export → _graphviz_export}/__init__.pyi +0 -0
  320. {graphviz_export → _graphviz_export}/py.typed +0 -0
  321. {keyingsets_utils → _keyingsets_utils}/py.typed +0 -0
  322. {rna_info → _rna_info}/py.typed +0 -0
  323. {rna_xml → _rna_xml}/__init__.pyi +0 -0
  324. {rna_xml → _rna_xml}/py.typed +0 -0
  325. {fake_bpy_module-20250612.dist-info → fake_bpy_module-20260118.dist-info}/WHEEL +0 -0
@@ -7,13 +7,11 @@ import bpy.types
7
7
  import mathutils
8
8
 
9
9
  def add_render_slot(
10
- execution_context: int | str | None = None, undo: bool | None = None
10
+ execution_context: int | str | None = None,
11
+ undo: bool | None = None,
12
+ /,
11
13
  ) -> None:
12
- """Add a new render slot
13
-
14
- :type execution_context: int | str | None
15
- :type undo: bool | None
16
- """
14
+ """Add a new render slot"""
17
15
 
18
16
  def change_frame(
19
17
  execution_context: int | str | None = None,
@@ -24,47 +22,36 @@ def change_frame(
24
22
  ) -> None:
25
23
  """Interactively change the current frame number
26
24
 
27
- :type execution_context: int | str | None
28
- :type undo: bool | None
29
25
  :param frame: Frame
30
- :type frame: int | None
31
26
  """
32
27
 
33
28
  def clear_render_border(
34
- execution_context: int | str | None = None, undo: bool | None = None
29
+ execution_context: int | str | None = None,
30
+ undo: bool | None = None,
31
+ /,
35
32
  ) -> None:
36
- """Clear the boundaries of the render region and disable render region
37
-
38
- :type execution_context: int | str | None
39
- :type undo: bool | None
40
- """
33
+ """Clear the boundaries of the render region and disable render region"""
41
34
 
42
35
  def clear_render_slot(
43
- execution_context: int | str | None = None, undo: bool | None = None
36
+ execution_context: int | str | None = None,
37
+ undo: bool | None = None,
38
+ /,
44
39
  ) -> None:
45
- """Clear the currently selected render slot
46
-
47
- :type execution_context: int | str | None
48
- :type undo: bool | None
49
- """
40
+ """Clear the currently selected render slot"""
50
41
 
51
42
  def clipboard_copy(
52
- execution_context: int | str | None = None, undo: bool | None = None
43
+ execution_context: int | str | None = None,
44
+ undo: bool | None = None,
45
+ /,
53
46
  ) -> None:
54
- """Copy the image to the clipboard
55
-
56
- :type execution_context: int | str | None
57
- :type undo: bool | None
58
- """
47
+ """Copy the image to the clipboard"""
59
48
 
60
49
  def clipboard_paste(
61
- execution_context: int | str | None = None, undo: bool | None = None
50
+ execution_context: int | str | None = None,
51
+ undo: bool | None = None,
52
+ /,
62
53
  ) -> None:
63
- """Paste new image from the clipboard
64
-
65
- :type execution_context: int | str | None
66
- :type undo: bool | None
67
- """
54
+ """Paste new image from the clipboard"""
68
55
 
69
56
  def convert_to_mesh_plane(
70
57
  execution_context: int | str | None = None,
@@ -74,8 +61,6 @@ def convert_to_mesh_plane(
74
61
  interpolation: typing.Literal["Linear", "Closest", "Cubic", "Smart"]
75
62
  | None = "Linear",
76
63
  extension: typing.Literal["CLIP", "EXTEND", "REPEAT"] | None = "CLIP",
77
- alpha_mode: typing.Literal["STRAIGHT", "PREMUL", "CHANNEL_PACKED", "NONE"]
78
- | None = "STRAIGHT",
79
64
  use_auto_refresh: bool | None = True,
80
65
  relative: bool | None = True,
81
66
  shader: typing.Literal["PRINCIPLED", "SHADELESS", "EMISSION"] | None = "PRINCIPLED",
@@ -90,8 +75,6 @@ def convert_to_mesh_plane(
90
75
  ) -> None:
91
76
  """Convert selected reference images to textured mesh plane
92
77
 
93
- :type execution_context: int | str | None
94
- :type undo: bool | None
95
78
  :param interpolation: Interpolation, Texture interpolation
96
79
 
97
80
  Linear
@@ -105,7 +88,6 @@ def convert_to_mesh_plane(
105
88
 
106
89
  Smart
107
90
  Smart -- Bicubic when magnifying, else bilinear (OSL only).
108
- :type interpolation: typing.Literal['Linear','Closest','Cubic','Smart'] | None
109
91
  :param extension: Extension, How the image is extrapolated past its original bounds
110
92
 
111
93
  CLIP
@@ -116,25 +98,8 @@ def convert_to_mesh_plane(
116
98
 
117
99
  REPEAT
118
100
  Repeat -- Cause the image to repeat horizontally and vertically.
119
- :type extension: typing.Literal['CLIP','EXTEND','REPEAT'] | None
120
- :param alpha_mode: Alpha Mode, Representation of alpha in the image file, to convert to and from when saving and loading the image
121
-
122
- STRAIGHT
123
- Straight -- Store RGB and alpha channels separately with alpha acting as a mask, also known as unassociated alpha. Commonly used by image editing applications and file formats like PNG..
124
-
125
- PREMUL
126
- Premultiplied -- Store RGB channels with alpha multiplied in, also known as associated alpha. The natural format for renders and used by file formats like OpenEXR..
127
-
128
- CHANNEL_PACKED
129
- Channel Packed -- Different images are packed in the RGB and alpha channels, and they should not affect each other. Channel packing is commonly used by game engines to save memory..
130
-
131
- NONE
132
- None -- Ignore alpha channel from the file and make image fully opaque.
133
- :type alpha_mode: typing.Literal['STRAIGHT','PREMUL','CHANNEL_PACKED','NONE'] | None
134
101
  :param use_auto_refresh: Auto Refresh, Always refresh image on frame changes
135
- :type use_auto_refresh: bool | None
136
102
  :param relative: Relative Paths, Use relative file paths
137
- :type relative: bool | None
138
103
  :param shader: Shader, Node shader to use
139
104
 
140
105
  PRINCIPLED
@@ -145,11 +110,8 @@ def convert_to_mesh_plane(
145
110
 
146
111
  EMISSION
147
112
  Emission -- Emission shader.
148
- :type shader: typing.Literal['PRINCIPLED','SHADELESS','EMISSION'] | None
149
113
  :param emit_strength: Emission Strength, Strength of emission
150
- :type emit_strength: float | None
151
114
  :param use_transparency: Use Alpha, Use alpha channel for transparency
152
- :type use_transparency: bool | None
153
115
  :param render_method: Render Method
154
116
 
155
117
  DITHERED
@@ -157,13 +119,9 @@ def convert_to_mesh_plane(
157
119
 
158
120
  BLENDED
159
121
  Blended -- Allows for colored transparency, but incompatible with render passes and ray-tracing. Also known as forward rendering..
160
- :type render_method: typing.Literal['DITHERED','BLENDED'] | None
161
122
  :param use_backface_culling: Backface Culling, Use backface culling to hide the back side of faces
162
- :type use_backface_culling: bool | None
163
123
  :param show_transparent_back: Show Backface, Render multiple transparent layers (may introduce transparency sorting problems)
164
- :type show_transparent_back: bool | None
165
124
  :param overwrite_material: Overwrite Material, Overwrite existing material with the same name
166
- :type overwrite_material: bool | None
167
125
  :param name_from: Name After, Name for new mesh object and material
168
126
 
169
127
  OBJECT
@@ -171,9 +129,7 @@ def convert_to_mesh_plane(
171
129
 
172
130
  IMAGE
173
131
  Source Image -- Name from loaded image.
174
- :type name_from: typing.Literal['OBJECT','IMAGE'] | None
175
132
  :param delete_ref: Delete Reference Object, Delete empty image object once mesh plane is created
176
- :type delete_ref: bool | None
177
133
  """
178
134
 
179
135
  def curves_point_set(
@@ -186,12 +142,8 @@ def curves_point_set(
186
142
  ) -> None:
187
143
  """Set black point or white point for curves
188
144
 
189
- :type execution_context: int | str | None
190
- :type undo: bool | None
191
145
  :param point: Point, Set black point or white point for curves
192
- :type point: typing.Literal['BLACK_POINT','WHITE_POINT'] | None
193
146
  :param size: Sample Size
194
- :type size: int | None
195
147
  """
196
148
 
197
149
  def cycle_render_slot(
@@ -203,10 +155,7 @@ def cycle_render_slot(
203
155
  ) -> None:
204
156
  """Cycle through all non-void render slots
205
157
 
206
- :type execution_context: int | str | None
207
- :type undo: bool | None
208
158
  :param reverse: Cycle in Reverse
209
- :type reverse: bool | None
210
159
  """
211
160
 
212
161
  def external_edit(
@@ -218,10 +167,7 @@ def external_edit(
218
167
  ) -> None:
219
168
  """Edit image in an external application
220
169
 
221
- :type execution_context: int | str | None
222
- :type undo: bool | None
223
170
  :param filepath: filepath
224
- :type filepath: str
225
171
  """
226
172
 
227
173
  def file_browse(
@@ -260,54 +206,29 @@ def file_browse(
260
206
  ) -> None:
261
207
  """Open an image file browser, hold Shift to open the file, Alt to browse containing directory
262
208
 
263
- :type execution_context: int | str | None
264
- :type undo: bool | None
265
209
  :param filepath: File Path, Path to file
266
- :type filepath: str
267
210
  :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
268
- :type hide_props_region: bool | None
269
211
  :param check_existing: Check Existing, Check and warn on overwriting existing files
270
- :type check_existing: bool | None
271
212
  :param filter_blender: Filter .blend files
272
- :type filter_blender: bool | None
273
213
  :param filter_backup: Filter .blend files
274
- :type filter_backup: bool | None
275
214
  :param filter_image: Filter image files
276
- :type filter_image: bool | None
277
215
  :param filter_movie: Filter movie files
278
- :type filter_movie: bool | None
279
216
  :param filter_python: Filter Python files
280
- :type filter_python: bool | None
281
217
  :param filter_font: Filter font files
282
- :type filter_font: bool | None
283
218
  :param filter_sound: Filter sound files
284
- :type filter_sound: bool | None
285
219
  :param filter_text: Filter text files
286
- :type filter_text: bool | None
287
220
  :param filter_archive: Filter archive files
288
- :type filter_archive: bool | None
289
221
  :param filter_btx: Filter btx files
290
- :type filter_btx: bool | None
291
222
  :param filter_alembic: Filter Alembic files
292
- :type filter_alembic: bool | None
293
223
  :param filter_usd: Filter USD files
294
- :type filter_usd: bool | None
295
224
  :param filter_obj: Filter OBJ files
296
- :type filter_obj: bool | None
297
225
  :param filter_volume: Filter OpenVDB volume files
298
- :type filter_volume: bool | None
299
226
  :param filter_folder: Filter folders
300
- :type filter_folder: bool | None
301
227
  :param filter_blenlib: Filter Blender IDs
302
- :type filter_blenlib: bool | None
303
228
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
304
- :type filemode: int | None
305
229
  :param relative_path: Relative Path, Select the file relative to the blend file
306
- :type relative_path: bool | None
307
230
  :param show_multiview: Enable Multi-View
308
- :type show_multiview: bool | None
309
231
  :param use_multiview: Use Multi-View
310
- :type use_multiview: bool | None
311
232
  :param display_type: Display Type
312
233
 
313
234
  DEFAULT
@@ -321,9 +242,7 @@ def file_browse(
321
242
 
322
243
  THUMBNAIL
323
244
  Thumbnails -- Display files as thumbnails.
324
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
325
245
  :param sort_method: File sorting mode
326
- :type sort_method: str | None
327
246
  """
328
247
 
329
248
  def flip(
@@ -336,12 +255,8 @@ def flip(
336
255
  ) -> None:
337
256
  """Flip the image
338
257
 
339
- :type execution_context: int | str | None
340
- :type undo: bool | None
341
258
  :param use_flip_x: Horizontal, Flip the image horizontally
342
- :type use_flip_x: bool | None
343
259
  :param use_flip_y: Vertical, Flip the image vertically
344
- :type use_flip_y: bool | None
345
260
  """
346
261
 
347
262
  def import_as_mesh_planes(
@@ -352,8 +267,6 @@ def import_as_mesh_planes(
352
267
  interpolation: typing.Literal["Linear", "Closest", "Cubic", "Smart"]
353
268
  | None = "Linear",
354
269
  extension: typing.Literal["CLIP", "EXTEND", "REPEAT"] | None = "CLIP",
355
- alpha_mode: typing.Literal["STRAIGHT", "PREMUL", "CHANNEL_PACKED", "NONE"]
356
- | None = "STRAIGHT",
357
270
  use_auto_refresh: bool | None = True,
358
271
  relative: bool | None = True,
359
272
  shader: typing.Literal["PRINCIPLED", "SHADELESS", "EMISSION"] | None = "PRINCIPLED",
@@ -400,8 +313,6 @@ def import_as_mesh_planes(
400
313
  ) -> None:
401
314
  """Create mesh plane(s) from image files with the appropriate aspect ratio
402
315
 
403
- :type execution_context: int | str | None
404
- :type undo: bool | None
405
316
  :param interpolation: Interpolation, Texture interpolation
406
317
 
407
318
  Linear
@@ -415,7 +326,6 @@ def import_as_mesh_planes(
415
326
 
416
327
  Smart
417
328
  Smart -- Bicubic when magnifying, else bilinear (OSL only).
418
- :type interpolation: typing.Literal['Linear','Closest','Cubic','Smart'] | None
419
329
  :param extension: Extension, How the image is extrapolated past its original bounds
420
330
 
421
331
  CLIP
@@ -426,25 +336,8 @@ def import_as_mesh_planes(
426
336
 
427
337
  REPEAT
428
338
  Repeat -- Cause the image to repeat horizontally and vertically.
429
- :type extension: typing.Literal['CLIP','EXTEND','REPEAT'] | None
430
- :param alpha_mode: Alpha Mode, Representation of alpha in the image file, to convert to and from when saving and loading the image
431
-
432
- STRAIGHT
433
- Straight -- Store RGB and alpha channels separately with alpha acting as a mask, also known as unassociated alpha. Commonly used by image editing applications and file formats like PNG..
434
-
435
- PREMUL
436
- Premultiplied -- Store RGB channels with alpha multiplied in, also known as associated alpha. The natural format for renders and used by file formats like OpenEXR..
437
-
438
- CHANNEL_PACKED
439
- Channel Packed -- Different images are packed in the RGB and alpha channels, and they should not affect each other. Channel packing is commonly used by game engines to save memory..
440
-
441
- NONE
442
- None -- Ignore alpha channel from the file and make image fully opaque.
443
- :type alpha_mode: typing.Literal['STRAIGHT','PREMUL','CHANNEL_PACKED','NONE'] | None
444
339
  :param use_auto_refresh: Auto Refresh, Always refresh image on frame changes
445
- :type use_auto_refresh: bool | None
446
340
  :param relative: Relative Paths, Use relative file paths
447
- :type relative: bool | None
448
341
  :param shader: Shader, Node shader to use
449
342
 
450
343
  PRINCIPLED
@@ -455,11 +348,8 @@ def import_as_mesh_planes(
455
348
 
456
349
  EMISSION
457
350
  Emission -- Emission shader.
458
- :type shader: typing.Literal['PRINCIPLED','SHADELESS','EMISSION'] | None
459
351
  :param emit_strength: Emission Strength, Strength of emission
460
- :type emit_strength: float | None
461
352
  :param use_transparency: Use Alpha, Use alpha channel for transparency
462
- :type use_transparency: bool | None
463
353
  :param render_method: Render Method
464
354
 
465
355
  DITHERED
@@ -467,15 +357,10 @@ def import_as_mesh_planes(
467
357
 
468
358
  BLENDED
469
359
  Blended -- Allows for colored transparency, but incompatible with render passes and ray-tracing. Also known as forward rendering..
470
- :type render_method: typing.Literal['DITHERED','BLENDED'] | None
471
360
  :param use_backface_culling: Backface Culling, Use backface culling to hide the back side of faces
472
- :type use_backface_culling: bool | None
473
361
  :param show_transparent_back: Show Backface, Render multiple transparent layers (may introduce transparency sorting problems)
474
- :type show_transparent_back: bool | None
475
362
  :param overwrite_material: Overwrite Material, Overwrite existing material with the same name
476
- :type overwrite_material: bool | None
477
363
  :param filepath: File Path, Filepath used for importing the file
478
- :type filepath: str
479
364
  :param align: Align
480
365
 
481
366
  WORLD
@@ -486,28 +371,17 @@ def import_as_mesh_planes(
486
371
 
487
372
  CURSOR
488
373
  3D Cursor -- Use the 3D cursor orientation for the new object.
489
- :type align: typing.Literal['WORLD','VIEW','CURSOR'] | None
490
374
  :param location: Location
491
- :type location: collections.abc.Sequence[float] | mathutils.Vector | None
492
375
  :param rotation: Rotation
493
- :type rotation: collections.abc.Sequence[float] | mathutils.Euler | None
494
376
  :param files: files
495
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
496
377
  :param directory: directory
497
- :type directory: str
498
378
  :param filter_image: filter_image
499
- :type filter_image: bool | None
500
379
  :param filter_movie: filter_movie
501
- :type filter_movie: bool | None
502
380
  :param filter_folder: filter_folder
503
- :type filter_folder: bool | None
504
381
  :param force_reload: Force Reload, Force reload the image if it is already opened elsewhere in Blender
505
- :type force_reload: bool | None
506
382
  :param image_sequence: Detect Image Sequences, Import sequentially numbered images as an animated image sequence instead of separate planes
507
- :type image_sequence: bool | None
508
383
  :param offset: Offset Planes, Offset planes from each other. If disabled, multiple planes will be created at the same location
509
- :type offset: bool | None
510
- :param offset_axis: Offset Direction, How planes are oriented relative to each others' local axis
384
+ :param offset_axis: Offset Direction, How planes are oriented relative to each others local axis
511
385
 
512
386
  +X
513
387
  +X -- Side by Side to the Left.
@@ -526,9 +400,7 @@ def import_as_mesh_planes(
526
400
 
527
401
  -Z
528
402
  -Z -- Stacked Below.
529
- :type offset_axis: typing.Literal['+X','+Y','+Z','-X','-Y','-Z'] | None
530
403
  :param offset_amount: Offset Distance, Set distance between each plane
531
- :type offset_amount: float | None
532
404
  :param align_axis: Align, How to align the planes
533
405
 
534
406
  +X
@@ -553,8 +425,7 @@ def import_as_mesh_planes(
553
425
  Face Camera -- Facing camera.
554
426
 
555
427
  CAM_AX
556
- Camera's Main Axis -- Facing the camera's dominant axis.
557
- :type align_axis: typing.Literal['+X','+Y','+Z','-X','-Y','-Z','CAM','CAM_AX'] | None
428
+ Cameras Main Axis -- Facing the cameras dominant axis.
558
429
  :param prev_align_axis: prev_align_axis
559
430
 
560
431
  +X
@@ -579,13 +450,11 @@ def import_as_mesh_planes(
579
450
  Face Camera -- Facing camera.
580
451
 
581
452
  CAM_AX
582
- Camera's Main Axis -- Facing the camera's dominant axis.
453
+ Cameras Main Axis -- Facing the cameras dominant axis.
583
454
 
584
455
  NONE
585
456
  Undocumented.
586
- :type prev_align_axis: typing.Literal['+X','+Y','+Z','-X','-Y','-Z','CAM','CAM_AX','NONE'] | None
587
457
  :param align_track: Track Camera, Add a constraint to make the planes track the camera
588
- :type align_track: bool | None
589
458
  :param size_mode: Size Mode, Method for computing the plane size
590
459
 
591
460
  ABSOLUTE
@@ -599,7 +468,6 @@ def import_as_mesh_planes(
599
468
 
600
469
  DPBU
601
470
  Pixels per Blender Unit -- Scale based on pixels per Blender Unit.
602
- :type size_mode: typing.Literal['ABSOLUTE','CAMERA','DPI','DPBU'] | None
603
471
  :param fill_mode: Scale, Method to scale the plane with the camera frame
604
472
 
605
473
  FILL
@@ -607,11 +475,8 @@ def import_as_mesh_planes(
607
475
 
608
476
  FIT
609
477
  Fit -- Fit entire image within the camera frame.
610
- :type fill_mode: typing.Literal['FILL','FIT'] | None
611
478
  :param height: Height, Height of the created plane
612
- :type height: float | None
613
479
  :param factor: Definition, Number of pixels per inch or Blender Unit
614
- :type factor: float | None
615
480
  """
616
481
 
617
482
  def invert(
@@ -624,28 +489,20 @@ def invert(
624
489
  invert_b: bool | None = False,
625
490
  invert_a: bool | None = False,
626
491
  ) -> None:
627
- """Invert image's channels
492
+ """Invert images channels
628
493
 
629
- :type execution_context: int | str | None
630
- :type undo: bool | None
631
494
  :param invert_r: Red, Invert red channel
632
- :type invert_r: bool | None
633
495
  :param invert_g: Green, Invert green channel
634
- :type invert_g: bool | None
635
496
  :param invert_b: Blue, Invert blue channel
636
- :type invert_b: bool | None
637
497
  :param invert_a: Alpha, Invert alpha channel
638
- :type invert_a: bool | None
639
498
  """
640
499
 
641
500
  def match_movie_length(
642
- execution_context: int | str | None = None, undo: bool | None = None
501
+ execution_context: int | str | None = None,
502
+ undo: bool | None = None,
503
+ /,
643
504
  ) -> None:
644
- """Set image's user's length to the one of this video
645
-
646
- :type execution_context: int | str | None
647
- :type undo: bool | None
648
- """
505
+ """Set images users length to the one of this video"""
649
506
 
650
507
  def new(
651
508
  execution_context: int | str | None = None,
@@ -665,26 +522,15 @@ def new(
665
522
  ) -> None:
666
523
  """Create a new image
667
524
 
668
- :type execution_context: int | str | None
669
- :type undo: bool | None
670
525
  :param name: Name, Image data-block name
671
- :type name: str
672
526
  :param width: Width, Image width
673
- :type width: int | None
674
527
  :param height: Height, Image height
675
- :type height: int | None
676
528
  :param color: Color, Default fill color
677
- :type color: collections.abc.Iterable[float] | None
678
529
  :param alpha: Alpha, Create an image with an alpha channel
679
- :type alpha: bool | None
680
530
  :param generated_type: Generated Type, Fill the image with a grid for UV map testing
681
- :type generated_type: bpy.stub_internal.rna_enums.ImageGeneratedTypeItems | None
682
531
  :param float: 32-bit Float, Create image with 32-bit floating-point bit depth
683
- :type float: bool | None
684
532
  :param use_stereo_3d: Stereo 3D, Create an image with left and right views
685
- :type use_stereo_3d: bool | None
686
533
  :param tiled: Tiled, Create a tiled image
687
- :type tiled: bool | None
688
534
  """
689
535
 
690
536
  def open(
@@ -729,60 +575,32 @@ def open(
729
575
  ) -> None:
730
576
  """Open image
731
577
 
732
- :type execution_context: int | str | None
733
- :type undo: bool | None
734
578
  :param allow_path_tokens: Allow the path to contain substitution tokens
735
- :type allow_path_tokens: bool | None
736
579
  :param filepath: File Path, Path to file
737
- :type filepath: str
738
580
  :param directory: Directory, Directory of the file
739
- :type directory: str
740
581
  :param files: Files
741
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
742
582
  :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
743
- :type hide_props_region: bool | None
744
583
  :param check_existing: Check Existing, Check and warn on overwriting existing files
745
- :type check_existing: bool | None
746
584
  :param filter_blender: Filter .blend files
747
- :type filter_blender: bool | None
748
585
  :param filter_backup: Filter .blend files
749
- :type filter_backup: bool | None
750
586
  :param filter_image: Filter image files
751
- :type filter_image: bool | None
752
587
  :param filter_movie: Filter movie files
753
- :type filter_movie: bool | None
754
588
  :param filter_python: Filter Python files
755
- :type filter_python: bool | None
756
589
  :param filter_font: Filter font files
757
- :type filter_font: bool | None
758
590
  :param filter_sound: Filter sound files
759
- :type filter_sound: bool | None
760
591
  :param filter_text: Filter text files
761
- :type filter_text: bool | None
762
592
  :param filter_archive: Filter archive files
763
- :type filter_archive: bool | None
764
593
  :param filter_btx: Filter btx files
765
- :type filter_btx: bool | None
766
594
  :param filter_alembic: Filter Alembic files
767
- :type filter_alembic: bool | None
768
595
  :param filter_usd: Filter USD files
769
- :type filter_usd: bool | None
770
596
  :param filter_obj: Filter OBJ files
771
- :type filter_obj: bool | None
772
597
  :param filter_volume: Filter OpenVDB volume files
773
- :type filter_volume: bool | None
774
598
  :param filter_folder: Filter folders
775
- :type filter_folder: bool | None
776
599
  :param filter_blenlib: Filter Blender IDs
777
- :type filter_blenlib: bool | None
778
600
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
779
- :type filemode: int | None
780
601
  :param relative_path: Relative Path, Select the file relative to the blend file
781
- :type relative_path: bool | None
782
602
  :param show_multiview: Enable Multi-View
783
- :type show_multiview: bool | None
784
603
  :param use_multiview: Use Multi-View
785
- :type use_multiview: bool | None
786
604
  :param display_type: Display Type
787
605
 
788
606
  DEFAULT
@@ -796,13 +614,9 @@ def open(
796
614
 
797
615
  THUMBNAIL
798
616
  Thumbnails -- Display files as thumbnails.
799
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
800
617
  :param sort_method: File sorting mode
801
- :type sort_method: str | None
802
618
  :param use_sequence_detection: Detect Sequences, Automatically detect animated sequences in selected images (based on file names)
803
- :type use_sequence_detection: bool | None
804
619
  :param use_udim_detecting: Detect UDIMs, Detect selected UDIM files and load all matching tiles
805
- :type use_udim_detecting: bool | None
806
620
  """
807
621
 
808
622
  def open_images(
@@ -819,71 +633,54 @@ def open_images(
819
633
  ) -> None:
820
634
  """Undocumented, consider contributing.
821
635
 
822
- :type execution_context: int | str | None
823
- :type undo: bool | None
824
636
  :param directory: directory
825
- :type directory: str
826
637
  :param files: files
827
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
828
638
  :param relative_path: Use relative path
829
- :type relative_path: bool | None
830
639
  :param use_sequence_detection: Use sequence detection
831
- :type use_sequence_detection: bool | None
832
640
  :param use_udim_detection: Use UDIM detection
833
- :type use_udim_detection: bool | None
834
641
  """
835
642
 
836
- def pack(execution_context: int | str | None = None, undo: bool | None = None) -> None:
837
- """Pack an image as embedded data into the .blend file
838
-
839
- :type execution_context: int | str | None
840
- :type undo: bool | None
841
- """
643
+ def pack(
644
+ execution_context: int | str | None = None,
645
+ undo: bool | None = None,
646
+ /,
647
+ ) -> None:
648
+ """Pack an image as embedded data into the .blend file"""
842
649
 
843
650
  def project_apply(
844
- execution_context: int | str | None = None, undo: bool | None = None
651
+ execution_context: int | str | None = None,
652
+ undo: bool | None = None,
653
+ /,
845
654
  ) -> None:
846
- """Project edited image back onto the object
847
-
848
- :type execution_context: int | str | None
849
- :type undo: bool | None
850
- """
655
+ """Project edited image back onto the object"""
851
656
 
852
657
  def project_edit(
853
- execution_context: int | str | None = None, undo: bool | None = None
658
+ execution_context: int | str | None = None,
659
+ undo: bool | None = None,
660
+ /,
854
661
  ) -> None:
855
- """Edit a snapshot of the 3D Viewport in an external image editor
856
-
857
- :type execution_context: int | str | None
858
- :type undo: bool | None
859
- """
662
+ """Edit a snapshot of the 3D Viewport in an external image editor"""
860
663
 
861
664
  def read_viewlayers(
862
- execution_context: int | str | None = None, undo: bool | None = None
665
+ execution_context: int | str | None = None,
666
+ undo: bool | None = None,
667
+ /,
863
668
  ) -> None:
864
- """Read all the current scene's view layers from cache, as needed
865
-
866
- :type execution_context: int | str | None
867
- :type undo: bool | None
868
- """
669
+ """Read all the current scenes view layers from cache, as needed"""
869
670
 
870
671
  def reload(
871
- execution_context: int | str | None = None, undo: bool | None = None
672
+ execution_context: int | str | None = None,
673
+ undo: bool | None = None,
674
+ /,
872
675
  ) -> None:
873
- """Reload current image from disk
874
-
875
- :type execution_context: int | str | None
876
- :type undo: bool | None
877
- """
676
+ """Reload current image from disk"""
878
677
 
879
678
  def remove_render_slot(
880
- execution_context: int | str | None = None, undo: bool | None = None
679
+ execution_context: int | str | None = None,
680
+ undo: bool | None = None,
681
+ /,
881
682
  ) -> None:
882
- """Remove the current render slot
883
-
884
- :type execution_context: int | str | None
885
- :type undo: bool | None
886
- """
683
+ """Remove the current render slot"""
887
684
 
888
685
  def render_border(
889
686
  execution_context: int | str | None = None,
@@ -898,18 +695,11 @@ def render_border(
898
695
  ) -> None:
899
696
  """Set the boundaries of the render region and enable render region
900
697
 
901
- :type execution_context: int | str | None
902
- :type undo: bool | None
903
698
  :param xmin: X Min
904
- :type xmin: int | None
905
699
  :param xmax: X Max
906
- :type xmax: int | None
907
700
  :param ymin: Y Min
908
- :type ymin: int | None
909
701
  :param ymax: Y Max
910
- :type ymax: int | None
911
702
  :param wait_for_input: Wait for Input
912
- :type wait_for_input: bool | None
913
703
  """
914
704
 
915
705
  def replace(
@@ -948,54 +738,29 @@ def replace(
948
738
  ) -> None:
949
739
  """Replace current image by another one from disk
950
740
 
951
- :type execution_context: int | str | None
952
- :type undo: bool | None
953
741
  :param filepath: File Path, Path to file
954
- :type filepath: str
955
742
  :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
956
- :type hide_props_region: bool | None
957
743
  :param check_existing: Check Existing, Check and warn on overwriting existing files
958
- :type check_existing: bool | None
959
744
  :param filter_blender: Filter .blend files
960
- :type filter_blender: bool | None
961
745
  :param filter_backup: Filter .blend files
962
- :type filter_backup: bool | None
963
746
  :param filter_image: Filter image files
964
- :type filter_image: bool | None
965
747
  :param filter_movie: Filter movie files
966
- :type filter_movie: bool | None
967
748
  :param filter_python: Filter Python files
968
- :type filter_python: bool | None
969
749
  :param filter_font: Filter font files
970
- :type filter_font: bool | None
971
750
  :param filter_sound: Filter sound files
972
- :type filter_sound: bool | None
973
751
  :param filter_text: Filter text files
974
- :type filter_text: bool | None
975
752
  :param filter_archive: Filter archive files
976
- :type filter_archive: bool | None
977
753
  :param filter_btx: Filter btx files
978
- :type filter_btx: bool | None
979
754
  :param filter_alembic: Filter Alembic files
980
- :type filter_alembic: bool | None
981
755
  :param filter_usd: Filter USD files
982
- :type filter_usd: bool | None
983
756
  :param filter_obj: Filter OBJ files
984
- :type filter_obj: bool | None
985
757
  :param filter_volume: Filter OpenVDB volume files
986
- :type filter_volume: bool | None
987
758
  :param filter_folder: Filter folders
988
- :type filter_folder: bool | None
989
759
  :param filter_blenlib: Filter Blender IDs
990
- :type filter_blenlib: bool | None
991
760
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
992
- :type filemode: int | None
993
761
  :param relative_path: Relative Path, Select the file relative to the blend file
994
- :type relative_path: bool | None
995
762
  :param show_multiview: Enable Multi-View
996
- :type show_multiview: bool | None
997
763
  :param use_multiview: Use Multi-View
998
- :type use_multiview: bool | None
999
764
  :param display_type: Display Type
1000
765
 
1001
766
  DEFAULT
@@ -1009,9 +774,7 @@ def replace(
1009
774
 
1010
775
  THUMBNAIL
1011
776
  Thumbnails -- Display files as thumbnails.
1012
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
1013
777
  :param sort_method: File sorting mode
1014
- :type sort_method: str | None
1015
778
  """
1016
779
 
1017
780
  def resize(
@@ -1024,12 +787,8 @@ def resize(
1024
787
  ) -> None:
1025
788
  """Resize the image
1026
789
 
1027
- :type execution_context: int | str | None
1028
- :type undo: bool | None
1029
790
  :param size: Size
1030
- :type size: collections.abc.Iterable[int] | None
1031
- :param all_udims: All UDIM Tiles, Scale all the image's UDIM tiles
1032
- :type all_udims: bool | None
791
+ :param all_udims: All UDIM Tiles, Scale all the images UDIM tiles
1033
792
  """
1034
793
 
1035
794
  def rotate_orthogonal(
@@ -1041,8 +800,6 @@ def rotate_orthogonal(
1041
800
  ) -> None:
1042
801
  """Rotate the image
1043
802
 
1044
- :type execution_context: int | str | None
1045
- :type undo: bool | None
1046
803
  :param degrees: Degrees, Amount of rotation in degrees (90, 180, 270)
1047
804
 
1048
805
  90
@@ -1053,7 +810,6 @@ def rotate_orthogonal(
1053
810
 
1054
811
  270
1055
812
  270 Degrees -- Rotate 270 degrees clockwise.
1056
- :type degrees: typing.Literal['90','180','270'] | None
1057
813
  """
1058
814
 
1059
815
  def sample(
@@ -1065,10 +821,7 @@ def sample(
1065
821
  ) -> None:
1066
822
  """Use mouse to sample a color in current image
1067
823
 
1068
- :type execution_context: int | str | None
1069
- :type undo: bool | None
1070
824
  :param size: Sample Size
1071
- :type size: int | None
1072
825
  """
1073
826
 
1074
827
  def sample_line(
@@ -1085,37 +838,27 @@ def sample_line(
1085
838
  ) -> None:
1086
839
  """Sample a line and show it in Scope panels
1087
840
 
1088
- :type execution_context: int | str | None
1089
- :type undo: bool | None
1090
841
  :param xstart: X Start
1091
- :type xstart: int | None
1092
842
  :param xend: X End
1093
- :type xend: int | None
1094
843
  :param ystart: Y Start
1095
- :type ystart: int | None
1096
844
  :param yend: Y End
1097
- :type yend: int | None
1098
845
  :param flip: Flip
1099
- :type flip: bool | None
1100
846
  :param cursor: Cursor, Mouse cursor style to use during the modal operator
1101
- :type cursor: int | None
1102
847
  """
1103
848
 
1104
- def save(execution_context: int | str | None = None, undo: bool | None = None) -> None:
1105
- """Save the image with current name and settings
1106
-
1107
- :type execution_context: int | str | None
1108
- :type undo: bool | None
1109
- """
849
+ def save(
850
+ execution_context: int | str | None = None,
851
+ undo: bool | None = None,
852
+ /,
853
+ ) -> None:
854
+ """Save the image with current name and settings"""
1110
855
 
1111
856
  def save_all_modified(
1112
- execution_context: int | str | None = None, undo: bool | None = None
857
+ execution_context: int | str | None = None,
858
+ undo: bool | None = None,
859
+ /,
1113
860
  ) -> None:
1114
- """Save all modified images
1115
-
1116
- :type execution_context: int | str | None
1117
- :type undo: bool | None
1118
- """
861
+ """Save all modified images"""
1119
862
 
1120
863
  def save_as(
1121
864
  execution_context: int | str | None = None,
@@ -1155,58 +898,31 @@ def save_as(
1155
898
  ) -> None:
1156
899
  """Save the image with another name and/or settings
1157
900
 
1158
- :type execution_context: int | str | None
1159
- :type undo: bool | None
1160
901
  :param save_as_render: Save As Render, Save image with render color management.For display image formats like PNG, apply view and display transform.For intermediate image formats like OpenEXR, use the default render output color space
1161
- :type save_as_render: bool | None
1162
902
  :param copy: Copy, Create a new image file without modifying the current image in Blender
1163
- :type copy: bool | None
1164
903
  :param allow_path_tokens: Allow the path to contain substitution tokens
1165
- :type allow_path_tokens: bool | None
1166
904
  :param filepath: File Path, Path to file
1167
- :type filepath: str
1168
905
  :param check_existing: Check Existing, Check and warn on overwriting existing files
1169
- :type check_existing: bool | None
1170
906
  :param filter_blender: Filter .blend files
1171
- :type filter_blender: bool | None
1172
907
  :param filter_backup: Filter .blend files
1173
- :type filter_backup: bool | None
1174
908
  :param filter_image: Filter image files
1175
- :type filter_image: bool | None
1176
909
  :param filter_movie: Filter movie files
1177
- :type filter_movie: bool | None
1178
910
  :param filter_python: Filter Python files
1179
- :type filter_python: bool | None
1180
911
  :param filter_font: Filter font files
1181
- :type filter_font: bool | None
1182
912
  :param filter_sound: Filter sound files
1183
- :type filter_sound: bool | None
1184
913
  :param filter_text: Filter text files
1185
- :type filter_text: bool | None
1186
914
  :param filter_archive: Filter archive files
1187
- :type filter_archive: bool | None
1188
915
  :param filter_btx: Filter btx files
1189
- :type filter_btx: bool | None
1190
916
  :param filter_alembic: Filter Alembic files
1191
- :type filter_alembic: bool | None
1192
917
  :param filter_usd: Filter USD files
1193
- :type filter_usd: bool | None
1194
918
  :param filter_obj: Filter OBJ files
1195
- :type filter_obj: bool | None
1196
919
  :param filter_volume: Filter OpenVDB volume files
1197
- :type filter_volume: bool | None
1198
920
  :param filter_folder: Filter folders
1199
- :type filter_folder: bool | None
1200
921
  :param filter_blenlib: Filter Blender IDs
1201
- :type filter_blenlib: bool | None
1202
922
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
1203
- :type filemode: int | None
1204
923
  :param relative_path: Relative Path, Select the file relative to the blend file
1205
- :type relative_path: bool | None
1206
924
  :param show_multiview: Enable Multi-View
1207
- :type show_multiview: bool | None
1208
925
  :param use_multiview: Use Multi-View
1209
- :type use_multiview: bool | None
1210
926
  :param display_type: Display Type
1211
927
 
1212
928
  DEFAULT
@@ -1220,19 +936,15 @@ def save_as(
1220
936
 
1221
937
  THUMBNAIL
1222
938
  Thumbnails -- Display files as thumbnails.
1223
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
1224
939
  :param sort_method: File sorting mode
1225
- :type sort_method: str | None
1226
940
  """
1227
941
 
1228
942
  def save_sequence(
1229
- execution_context: int | str | None = None, undo: bool | None = None
943
+ execution_context: int | str | None = None,
944
+ undo: bool | None = None,
945
+ /,
1230
946
  ) -> None:
1231
- """Save a sequence of images
1232
-
1233
- :type execution_context: int | str | None
1234
- :type undo: bool | None
1235
- """
947
+ """Save a sequence of images"""
1236
948
 
1237
949
  def tile_add(
1238
950
  execution_context: int | str | None = None,
@@ -1253,28 +965,16 @@ def tile_add(
1253
965
  ) -> None:
1254
966
  """Adds a tile to the image
1255
967
 
1256
- :type execution_context: int | str | None
1257
- :type undo: bool | None
1258
968
  :param number: Number, UDIM number of the tile
1259
- :type number: int | None
1260
969
  :param count: Count, How many tiles to add
1261
- :type count: int | None
1262
970
  :param label: Label, Optional tile label
1263
- :type label: str
1264
971
  :param fill: Fill, Fill new tile with a generated image
1265
- :type fill: bool | None
1266
972
  :param color: Color, Default fill color
1267
- :type color: collections.abc.Iterable[float] | None
1268
973
  :param generated_type: Generated Type, Fill the image with a grid for UV map testing
1269
- :type generated_type: bpy.stub_internal.rna_enums.ImageGeneratedTypeItems | None
1270
974
  :param width: Width, Image width
1271
- :type width: int | None
1272
975
  :param height: Height, Image height
1273
- :type height: int | None
1274
976
  :param float: 32-bit Float, Create image with 32-bit floating-point bit depth
1275
- :type float: bool | None
1276
977
  :param alpha: Alpha, Create an image with an alpha channel
1277
- :type alpha: bool | None
1278
978
  """
1279
979
 
1280
980
  def tile_fill(
@@ -1292,30 +992,20 @@ def tile_fill(
1292
992
  ) -> None:
1293
993
  """Fill the current tile with a generated image
1294
994
 
1295
- :type execution_context: int | str | None
1296
- :type undo: bool | None
1297
995
  :param color: Color, Default fill color
1298
- :type color: collections.abc.Iterable[float] | None
1299
996
  :param generated_type: Generated Type, Fill the image with a grid for UV map testing
1300
- :type generated_type: bpy.stub_internal.rna_enums.ImageGeneratedTypeItems | None
1301
997
  :param width: Width, Image width
1302
- :type width: int | None
1303
998
  :param height: Height, Image height
1304
- :type height: int | None
1305
999
  :param float: 32-bit Float, Create image with 32-bit floating-point bit depth
1306
- :type float: bool | None
1307
1000
  :param alpha: Alpha, Create an image with an alpha channel
1308
- :type alpha: bool | None
1309
1001
  """
1310
1002
 
1311
1003
  def tile_remove(
1312
- execution_context: int | str | None = None, undo: bool | None = None
1004
+ execution_context: int | str | None = None,
1005
+ undo: bool | None = None,
1006
+ /,
1313
1007
  ) -> None:
1314
- """Removes a tile from the image
1315
-
1316
- :type execution_context: int | str | None
1317
- :type undo: bool | None
1318
- """
1008
+ """Removes a tile from the image"""
1319
1009
 
1320
1010
  def unpack(
1321
1011
  execution_context: int | str | None = None,
@@ -1327,12 +1017,8 @@ def unpack(
1327
1017
  ) -> None:
1328
1018
  """Save an image packed in the .blend file to disk
1329
1019
 
1330
- :type execution_context: int | str | None
1331
- :type undo: bool | None
1332
1020
  :param method: Method, How to unpack
1333
- :type method: bpy.stub_internal.rna_enums.UnpackMethodItems | None
1334
1021
  :param id: Image Name, Image data-block name to unpack
1335
- :type id: str
1336
1022
  """
1337
1023
 
1338
1024
  def view_all(
@@ -1344,20 +1030,15 @@ def view_all(
1344
1030
  ) -> None:
1345
1031
  """View the entire image
1346
1032
 
1347
- :type execution_context: int | str | None
1348
- :type undo: bool | None
1349
1033
  :param fit_view: Fit View, Fit frame to the viewport
1350
- :type fit_view: bool | None
1351
1034
  """
1352
1035
 
1353
1036
  def view_center_cursor(
1354
- execution_context: int | str | None = None, undo: bool | None = None
1037
+ execution_context: int | str | None = None,
1038
+ undo: bool | None = None,
1039
+ /,
1355
1040
  ) -> None:
1356
- """Center the view so that the cursor is in the middle of the view
1357
-
1358
- :type execution_context: int | str | None
1359
- :type undo: bool | None
1360
- """
1041
+ """Center the view so that the cursor is in the middle of the view"""
1361
1042
 
1362
1043
  def view_cursor_center(
1363
1044
  execution_context: int | str | None = None,
@@ -1368,20 +1049,15 @@ def view_cursor_center(
1368
1049
  ) -> None:
1369
1050
  """Set 2D Cursor To Center View location
1370
1051
 
1371
- :type execution_context: int | str | None
1372
- :type undo: bool | None
1373
1052
  :param fit_view: Fit View, Fit frame to the viewport
1374
- :type fit_view: bool | None
1375
1053
  """
1376
1054
 
1377
1055
  def view_ndof(
1378
- execution_context: int | str | None = None, undo: bool | None = None
1056
+ execution_context: int | str | None = None,
1057
+ undo: bool | None = None,
1058
+ /,
1379
1059
  ) -> None:
1380
- """Use a 3D mouse device to pan/zoom the view
1381
-
1382
- :type execution_context: int | str | None
1383
- :type undo: bool | None
1384
- """
1060
+ """Use a 3D mouse device to pan/zoom the view"""
1385
1061
 
1386
1062
  def view_pan(
1387
1063
  execution_context: int | str | None = None,
@@ -1392,20 +1068,15 @@ def view_pan(
1392
1068
  ) -> None:
1393
1069
  """Pan the view
1394
1070
 
1395
- :type execution_context: int | str | None
1396
- :type undo: bool | None
1397
1071
  :param offset: Offset, Offset in floating-point units, 1.0 is the width and height of the image
1398
- :type offset: collections.abc.Sequence[float] | mathutils.Vector | None
1399
1072
  """
1400
1073
 
1401
1074
  def view_selected(
1402
- execution_context: int | str | None = None, undo: bool | None = None
1075
+ execution_context: int | str | None = None,
1076
+ undo: bool | None = None,
1077
+ /,
1403
1078
  ) -> None:
1404
- """View all selected UVs
1405
-
1406
- :type execution_context: int | str | None
1407
- :type undo: bool | None
1408
- """
1079
+ """View all selected UVs"""
1409
1080
 
1410
1081
  def view_zoom(
1411
1082
  execution_context: int | str | None = None,
@@ -1417,12 +1088,8 @@ def view_zoom(
1417
1088
  ) -> None:
1418
1089
  """Zoom in/out the image
1419
1090
 
1420
- :type execution_context: int | str | None
1421
- :type undo: bool | None
1422
1091
  :param factor: Factor, Zoom factor, values higher than 1.0 zoom in, lower values zoom out
1423
- :type factor: float | None
1424
1092
  :param use_cursor_init: Use Mouse Position, Allow the initial mouse position to be used
1425
- :type use_cursor_init: bool | None
1426
1093
  """
1427
1094
 
1428
1095
  def view_zoom_border(
@@ -1439,20 +1106,12 @@ def view_zoom_border(
1439
1106
  ) -> None:
1440
1107
  """Zoom in the view to the nearest item contained in the border
1441
1108
 
1442
- :type execution_context: int | str | None
1443
- :type undo: bool | None
1444
1109
  :param xmin: X Min
1445
- :type xmin: int | None
1446
1110
  :param xmax: X Max
1447
- :type xmax: int | None
1448
1111
  :param ymin: Y Min
1449
- :type ymin: int | None
1450
1112
  :param ymax: Y Max
1451
- :type ymax: int | None
1452
1113
  :param wait_for_input: Wait for Input
1453
- :type wait_for_input: bool | None
1454
1114
  :param zoom_out: Zoom Out
1455
- :type zoom_out: bool | None
1456
1115
  """
1457
1116
 
1458
1117
  def view_zoom_in(
@@ -1464,10 +1123,7 @@ def view_zoom_in(
1464
1123
  ) -> None:
1465
1124
  """Zoom in the image (centered around 2D cursor)
1466
1125
 
1467
- :type execution_context: int | str | None
1468
- :type undo: bool | None
1469
1126
  :param location: Location, Cursor location in screen coordinates
1470
- :type location: collections.abc.Sequence[float] | mathutils.Vector | None
1471
1127
  """
1472
1128
 
1473
1129
  def view_zoom_out(
@@ -1479,10 +1135,7 @@ def view_zoom_out(
1479
1135
  ) -> None:
1480
1136
  """Zoom out the image (centered around 2D cursor)
1481
1137
 
1482
- :type execution_context: int | str | None
1483
- :type undo: bool | None
1484
1138
  :param location: Location, Cursor location in screen coordinates
1485
- :type location: collections.abc.Sequence[float] | mathutils.Vector | None
1486
1139
  """
1487
1140
 
1488
1141
  def view_zoom_ratio(
@@ -1494,8 +1147,5 @@ def view_zoom_ratio(
1494
1147
  ) -> None:
1495
1148
  """Set zoom ratio of the view
1496
1149
 
1497
- :type execution_context: int | str | None
1498
- :type undo: bool | None
1499
1150
  :param ratio: Ratio, Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out
1500
- :type ratio: float | None
1501
1151
  """