fake-bpy-module 20240516__py3-none-any.whl → 20240517__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.

Potentially problematic release.


This version of fake-bpy-module might be problematic. Click here for more details.

Files changed (533) hide show
  1. _bpy_internal/freedesktop/__init__.pyi +2 -2
  2. addon_utils/__init__.pyi +43 -12
  3. animsys_refactor/__init__.pyi +4 -4
  4. aud/__init__.pyi +7 -7
  5. bgl/__init__.pyi +121 -183
  6. bl_app_override/__init__.pyi +5 -5
  7. bl_app_override/helpers/__init__.pyi +3 -1
  8. bl_app_template_utils/__init__.pyi +5 -5
  9. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
  10. bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
  11. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
  12. bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
  13. bl_i18n_utils/bl_extract_messages/__init__.pyi +5 -5
  14. bl_i18n_utils/settings/__init__.pyi +4 -2
  15. bl_i18n_utils/utils/__init__.pyi +86 -58
  16. bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
  17. bl_keymap_utils/io/__init__.pyi +4 -4
  18. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
  19. bl_keymap_utils/platform_helpers/__init__.pyi +2 -2
  20. bl_operators/add_mesh_torus/__init__.pyi +126 -41
  21. bl_operators/anim/__init__.pyi +1001 -328
  22. bl_operators/assets/__init__.pyi +376 -123
  23. bl_operators/bmesh/find_adjacent/__init__.pyi +3 -3
  24. bl_operators/clip/__init__.pyi +1250 -409
  25. bl_operators/console/__init__.pyi +626 -205
  26. bl_operators/constraint/__init__.pyi +502 -165
  27. bl_operators/file/__init__.pyi +376 -123
  28. bl_operators/freestyle/__init__.pyi +501 -164
  29. bl_operators/geometry_nodes/__init__.pyi +501 -164
  30. bl_operators/image/__init__.pyi +621 -200
  31. bl_operators/mesh/__init__.pyi +376 -123
  32. bl_operators/node/__init__.pyi +1243 -402
  33. bl_operators/object/__init__.pyi +1876 -615
  34. bl_operators/object_align/__init__.pyi +126 -41
  35. bl_operators/object_quick_effects/__init__.pyi +502 -165
  36. bl_operators/object_randomize_transform/__init__.pyi +126 -41
  37. bl_operators/presets/__init__.pyi +3069 -1027
  38. bl_operators/rigidbody/__init__.pyi +376 -123
  39. bl_operators/screen_play_rendered_anim/__init__.pyi +126 -41
  40. bl_operators/sequencer/__init__.pyi +1009 -331
  41. bl_operators/spreadsheet/__init__.pyi +126 -41
  42. bl_operators/userpref/__init__.pyi +3263 -1078
  43. bl_operators/uvcalc_follow_active/__init__.pyi +126 -41
  44. bl_operators/uvcalc_lightmap/__init__.pyi +137 -47
  45. bl_operators/uvcalc_transform/__init__.pyi +289 -90
  46. bl_operators/vertexpaint_dirt/__init__.pyi +126 -41
  47. bl_operators/view3d/__init__.pyi +868 -279
  48. bl_operators/wm/__init__.pyi +5777 -1934
  49. bl_operators/world/__init__.pyi +126 -41
  50. bl_previews_utils/bl_previews_render/__init__.pyi +1 -1
  51. bl_rna_utils/data_path/__init__.pyi +8 -3
  52. bl_ui/__init__.pyi +338 -131
  53. bl_ui/anim/__init__.pyi +164 -64
  54. bl_ui/asset_shelf/__init__.pyi +129 -42
  55. bl_ui/generic_ui_list/__init__.pyi +412 -135
  56. bl_ui/node_add_menu/__init__.pyi +168 -68
  57. bl_ui/node_add_menu_compositor/__init__.pyi +2921 -1138
  58. bl_ui/node_add_menu_geometry/__init__.pyi +7785 -3032
  59. bl_ui/node_add_menu_shader/__init__.pyi +1621 -630
  60. bl_ui/node_add_menu_texture/__init__.pyi +1459 -567
  61. bl_ui/properties_animviz/__init__.pyi +2 -2
  62. bl_ui/properties_collection/__init__.pyi +806 -274
  63. bl_ui/properties_constraint/__init__.pyi +10253 -3458
  64. bl_ui/properties_data_armature/__init__.pyi +1615 -552
  65. bl_ui/properties_data_bone/__init__.pyi +1288 -425
  66. bl_ui/properties_data_camera/__init__.pyi +1854 -631
  67. bl_ui/properties_data_curve/__init__.pyi +1929 -636
  68. bl_ui/properties_data_curves/__init__.pyi +806 -274
  69. bl_ui/properties_data_empty/__init__.pyi +257 -84
  70. bl_ui/properties_data_gpencil/__init__.pyi +2380 -803
  71. bl_ui/properties_data_grease_pencil/__init__.pyi +1902 -656
  72. bl_ui/properties_data_lattice/__init__.pyi +388 -127
  73. bl_ui/properties_data_light/__init__.pyi +1541 -506
  74. bl_ui/properties_data_lightprobe/__init__.pyi +1667 -548
  75. bl_ui/properties_data_mesh/__init__.pyi +2704 -929
  76. bl_ui/properties_data_metaball/__init__.pyi +644 -211
  77. bl_ui/properties_data_modifier/__init__.pyi +1353 -502
  78. bl_ui/properties_data_pointcloud/__init__.pyi +679 -233
  79. bl_ui/properties_data_shaderfx/__init__.pyi +129 -42
  80. bl_ui/properties_data_speaker/__init__.pyi +644 -211
  81. bl_ui/properties_data_volume/__init__.pyi +1030 -339
  82. bl_ui/properties_freestyle/__init__.pyi +3113 -1035
  83. bl_ui/properties_grease_pencil_common/__init__.pyi +2464 -933
  84. bl_ui/properties_mask_common/__init__.pyi +1101 -420
  85. bl_ui/properties_material/__init__.pyi +2091 -699
  86. bl_ui/properties_material_gpencil/__init__.pyi +1350 -466
  87. bl_ui/properties_object/__init__.pyi +1838 -618
  88. bl_ui/properties_output/__init__.pyi +2414 -831
  89. bl_ui/properties_paint_common/__init__.pyi +412 -289
  90. bl_ui/properties_particle/__init__.pyi +6737 -2241
  91. bl_ui/properties_physics_cloth/__init__.pyi +1825 -612
  92. bl_ui/properties_physics_common/__init__.pyi +129 -42
  93. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2821 -928
  94. bl_ui/properties_physics_field/__init__.pyi +1283 -422
  95. bl_ui/properties_physics_fluid/__init__.pyi +3620 -1203
  96. bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -42
  97. bl_ui/properties_physics_rigidbody/__init__.pyi +1027 -338
  98. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1667 -548
  99. bl_ui/properties_physics_softbody/__init__.pyi +1924 -633
  100. bl_ui/properties_render/__init__.pyi +6830 -2263
  101. bl_ui/properties_scene/__init__.pyi +1929 -636
  102. bl_ui/properties_texture/__init__.pyi +3370 -1118
  103. bl_ui/properties_view_layer/__init__.pyi +2346 -782
  104. bl_ui/properties_workspace/__init__.pyi +516 -169
  105. bl_ui/properties_world/__init__.pyi +1284 -421
  106. bl_ui/space_clip/__init__.pyi +10134 -3639
  107. bl_ui/space_console/__init__.pyi +939 -357
  108. bl_ui/space_dopesheet/__init__.pyi +4327 -1562
  109. bl_ui/space_filebrowser/__init__.pyi +4164 -1499
  110. bl_ui/space_graph/__init__.pyi +3108 -1179
  111. bl_ui/space_image/__init__.pyi +9766 -3596
  112. bl_ui/space_info/__init__.pyi +939 -357
  113. bl_ui/space_nla/__init__.pyi +2620 -988
  114. bl_ui/space_node/__init__.pyi +3994 -1434
  115. bl_ui/space_outliner/__init__.pyi +2203 -842
  116. bl_ui/space_properties/__init__.pyi +386 -127
  117. bl_ui/space_sequencer/__init__.pyi +10773 -3878
  118. bl_ui/space_spreadsheet/__init__.pyi +130 -43
  119. bl_ui/space_statusbar/__init__.pyi +129 -42
  120. bl_ui/space_text/__init__.pyi +2458 -925
  121. bl_ui/space_time/__init__.pyi +1033 -378
  122. bl_ui/space_toolsystem_common/__init__.pyi +20 -16
  123. bl_ui/space_toolsystem_toolbar/__init__.pyi +37 -21
  124. bl_ui/space_topbar/__init__.pyi +3980 -1496
  125. bl_ui/space_userpref/__init__.pyi +11373 -3797
  126. bl_ui/space_view3d/__init__.pyi +40865 -15356
  127. bl_ui/space_view3d_toolbar/__init__.pyi +12520 -4647
  128. bl_ui/temp_anim_layers/__init__.pyi +129 -42
  129. bl_ui/utils/__init__.pyi +28 -20
  130. bl_ui_utils/bug_report_url/__init__.pyi +1 -1
  131. bl_ui_utils/layout/__init__.pyi +1 -1
  132. blend_render_info/__init__.pyi +1 -1
  133. blf/__init__.pyi +4 -4
  134. bmesh/geometry/__init__.pyi +2 -3
  135. bmesh/ops/__init__.pyi +372 -419
  136. bmesh/types/__init__.pyi +38 -38
  137. bmesh/utils/__init__.pyi +10 -13
  138. bpy/app/__init__.pyi +4 -4
  139. bpy/app/handlers/__init__.pyi +36 -36
  140. bpy/app/icons/__init__.pyi +8 -8
  141. bpy/app/timers/__init__.pyi +10 -10
  142. bpy/app/translations/__init__.pyi +20 -22
  143. bpy/msgbus/__init__.pyi +2 -4
  144. bpy/ops/action/__init__.pyi +316 -394
  145. bpy/ops/anim/__init__.pyi +442 -548
  146. bpy/ops/armature/__init__.pyi +374 -470
  147. bpy/ops/asset/__init__.pyi +152 -184
  148. bpy/ops/bl_pkg/__init__.pyi +221 -272
  149. bpy/ops/boid/__init__.pyi +50 -66
  150. bpy/ops/brush/__init__.pyi +72 -90
  151. bpy/ops/buttons/__init__.pyi +132 -144
  152. bpy/ops/cachefile/__init__.pyi +128 -138
  153. bpy/ops/camera/__init__.pyi +26 -30
  154. bpy/ops/clip/__init__.pyi +777 -964
  155. bpy/ops/cloth/__init__.pyi +12 -14
  156. bpy/ops/collection/__init__.pyi +68 -86
  157. bpy/ops/console/__init__.pyi +158 -200
  158. bpy/ops/constraint/__init__.pyi +178 -214
  159. bpy/ops/curve/__init__.pyi +473 -576
  160. bpy/ops/curves/__init__.pyi +247 -302
  161. bpy/ops/cycles/__init__.pyi +28 -34
  162. bpy/ops/dpaint/__init__.pyi +34 -44
  163. bpy/ops/ed/__init__.pyi +126 -150
  164. bpy/ops/export_anim/__init__.pyi +22 -24
  165. bpy/ops/export_scene/__init__.pyi +302 -336
  166. bpy/ops/file/__init__.pyi +352 -432
  167. bpy/ops/fluid/__init__.pyi +90 -118
  168. bpy/ops/font/__init__.pyi +258 -304
  169. bpy/ops/geometry/__init__.pyi +100 -120
  170. bpy/ops/gizmogroup/__init__.pyi +22 -26
  171. bpy/ops/gpencil/__init__.pyi +1469 -1778
  172. bpy/ops/graph/__init__.pyi +644 -776
  173. bpy/ops/grease_pencil/__init__.pyi +597 -748
  174. bpy/ops/image/__init__.pyi +648 -744
  175. bpy/ops/import_anim/__init__.pyi +30 -32
  176. bpy/ops/import_curve/__init__.pyi +10 -12
  177. bpy/ops/import_scene/__init__.pyi +88 -96
  178. bpy/ops/info/__init__.pyi +60 -74
  179. bpy/ops/lattice/__init__.pyi +64 -80
  180. bpy/ops/marker/__init__.pyi +108 -130
  181. bpy/ops/mask/__init__.pyi +322 -402
  182. bpy/ops/material/__init__.pyi +18 -24
  183. bpy/ops/mball/__init__.pyi +70 -86
  184. bpy/ops/mesh/__init__.pyi +1986 -2322
  185. bpy/ops/nla/__init__.pyi +333 -411
  186. bpy/ops/node/__init__.pyi +886 -1100
  187. bpy/ops/object/__init__.pyi +2585 -3078
  188. bpy/ops/outliner/__init__.pyi +498 -636
  189. bpy/ops/paint/__init__.pyi +565 -680
  190. bpy/ops/paintcurve/__init__.pyi +64 -80
  191. bpy/ops/palette/__init__.pyi +50 -64
  192. bpy/ops/particle/__init__.pyi +267 -340
  193. bpy/ops/pose/__init__.pyi +336 -414
  194. bpy/ops/poselib/__init__.pyi +72 -90
  195. bpy/ops/preferences/__init__.pyi +386 -463
  196. bpy/ops/ptcache/__init__.pyi +46 -60
  197. bpy/ops/render/__init__.pyi +130 -154
  198. bpy/ops/rigidbody/__init__.pyi +102 -128
  199. bpy/ops/scene/__init__.pyi +280 -358
  200. bpy/ops/screen/__init__.pyi +382 -460
  201. bpy/ops/script/__init__.pyi +24 -30
  202. bpy/ops/sculpt/__init__.pyi +458 -532
  203. bpy/ops/sculpt_curves/__init__.pyi +41 -50
  204. bpy/ops/sequencer/__init__.pyi +1066 -1244
  205. bpy/ops/sound/__init__.pyi +216 -230
  206. bpy/ops/spreadsheet/__init__.pyi +30 -38
  207. bpy/ops/surface/__init__.pyi +108 -120
  208. bpy/ops/text/__init__.pyi +390 -476
  209. bpy/ops/text_editor/__init__.pyi +12 -14
  210. bpy/ops/texture/__init__.pyi +26 -34
  211. bpy/ops/transform/__init__.pyi +792 -878
  212. bpy/ops/ui/__init__.pyi +228 -294
  213. bpy/ops/uilist/__init__.pyi +32 -38
  214. bpy/ops/uv/__init__.pyi +602 -704
  215. bpy/ops/view2d/__init__.pyi +156 -184
  216. bpy/ops/view3d/__init__.pyi +582 -718
  217. bpy/ops/wm/__init__.pyi +2680 -2928
  218. bpy/ops/workspace/__init__.pyi +46 -60
  219. bpy/ops/world/__init__.pyi +12 -16
  220. bpy/path/__init__.pyi +179 -75
  221. bpy/props/__init__.pyi +261 -263
  222. bpy/types/__init__.pyi +17056 -21951
  223. bpy/utils/__init__.pyi +242 -118
  224. bpy/utils/previews/__init__.pyi +58 -28
  225. bpy/utils/units/__init__.pyi +20 -20
  226. bpy_extras/anim_utils/__init__.pyi +68 -28
  227. bpy_extras/bmesh_utils/__init__.pyi +8 -2
  228. bpy_extras/extensions/junction_module/__init__.pyi +5 -2
  229. bpy_extras/id_map_utils/__init__.pyi +3 -3
  230. bpy_extras/image_utils/__init__.pyi +44 -11
  231. bpy_extras/io_utils/__init__.pyi +113 -18
  232. bpy_extras/keyconfig_utils/__init__.pyi +2 -2
  233. bpy_extras/mesh_utils/__init__.pyi +71 -19
  234. bpy_extras/node_shader_utils/__init__.pyi +9 -4
  235. bpy_extras/node_utils/__init__.pyi +9 -2
  236. bpy_extras/object_utils/__init__.pyi +71 -12
  237. bpy_extras/view3d_utils/__init__.pyi +80 -10
  238. bpy_extras/wm_utils/progress_report/__init__.pyi +13 -10
  239. bpy_types/__init__.pyi +4197 -1333
  240. console_python/__init__.pyi +6 -1
  241. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/METADATA +1 -1
  242. fake_bpy_module-20240517.dist-info/RECORD +353 -0
  243. freestyle/chainingiterators/__init__.pyi +4 -4
  244. freestyle/shaders/__init__.pyi +2 -2
  245. freestyle/types/__init__.pyi +84 -96
  246. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  247. freestyle/utils/__init__.pyi +3 -3
  248. gpu/matrix/__init__.pyi +6 -8
  249. gpu/state/__init__.pyi +2 -2
  250. gpu/types/__init__.pyi +12 -12
  251. gpu_extras/presets/__init__.pyi +2 -5
  252. graphviz_export/__init__.pyi +4 -2
  253. idprop/types/__init__.pyi +2 -2
  254. imbuf/__init__.pyi +4 -4
  255. keyingsets_builtins/__init__.pyi +2688 -839
  256. mathutils/__init__.pyi +194 -238
  257. mathutils/bvhtree/__init__.pyi +4 -4
  258. mathutils/geometry/__init__.pyi +153 -155
  259. mathutils/kdtree/__init__.pyi +8 -12
  260. mathutils/noise/__init__.pyi +26 -26
  261. nodeitems_utils/__init__.pyi +1 -1
  262. rna_info/__init__.pyi +17 -15
  263. rna_keymap_ui/__init__.pyi +1 -1
  264. rna_prop_ui/__init__.pyi +16 -14
  265. rna_xml/__init__.pyi +12 -12
  266. _bpy_internal/freedesktop/py.typed +0 -0
  267. bl_app_override/helpers/py.typed +0 -0
  268. bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
  269. bl_console_utils/autocomplete/complete_import/py.typed +0 -0
  270. bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
  271. bl_console_utils/autocomplete/intellisense/py.typed +0 -0
  272. bl_console_utils/autocomplete/py.typed +0 -0
  273. bl_i18n_utils/bl_extract_messages/py.typed +0 -0
  274. bl_i18n_utils/merge_po/py.typed +0 -0
  275. bl_i18n_utils/settings/py.typed +0 -0
  276. bl_i18n_utils/utils/py.typed +0 -0
  277. bl_i18n_utils/utils_cli/py.typed +0 -0
  278. bl_i18n_utils/utils_languages_menu/py.typed +0 -0
  279. bl_i18n_utils/utils_rtl/py.typed +0 -0
  280. bl_keymap_utils/io/py.typed +0 -0
  281. bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
  282. bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
  283. bl_keymap_utils/platform_helpers/py.typed +0 -0
  284. bl_keymap_utils/versioning/py.typed +0 -0
  285. bl_operators/add_mesh_torus/py.typed +0 -0
  286. bl_operators/anim/py.typed +0 -0
  287. bl_operators/assets/py.typed +0 -0
  288. bl_operators/bmesh/find_adjacent/py.typed +0 -0
  289. bl_operators/bmesh/py.typed +0 -0
  290. bl_operators/clip/py.typed +0 -0
  291. bl_operators/console/py.typed +0 -0
  292. bl_operators/constraint/py.typed +0 -0
  293. bl_operators/file/py.typed +0 -0
  294. bl_operators/freestyle/py.typed +0 -0
  295. bl_operators/geometry_nodes/py.typed +0 -0
  296. bl_operators/image/py.typed +0 -0
  297. bl_operators/mesh/py.typed +0 -0
  298. bl_operators/node/py.typed +0 -0
  299. bl_operators/object/py.typed +0 -0
  300. bl_operators/object_align/py.typed +0 -0
  301. bl_operators/object_quick_effects/py.typed +0 -0
  302. bl_operators/object_randomize_transform/py.typed +0 -0
  303. bl_operators/presets/py.typed +0 -0
  304. bl_operators/rigidbody/py.typed +0 -0
  305. bl_operators/screen_play_rendered_anim/py.typed +0 -0
  306. bl_operators/sequencer/py.typed +0 -0
  307. bl_operators/spreadsheet/py.typed +0 -0
  308. bl_operators/userpref/py.typed +0 -0
  309. bl_operators/uvcalc_follow_active/py.typed +0 -0
  310. bl_operators/uvcalc_lightmap/py.typed +0 -0
  311. bl_operators/uvcalc_transform/py.typed +0 -0
  312. bl_operators/vertexpaint_dirt/py.typed +0 -0
  313. bl_operators/view3d/py.typed +0 -0
  314. bl_operators/wm/py.typed +0 -0
  315. bl_operators/world/py.typed +0 -0
  316. bl_previews_utils/bl_previews_render/py.typed +0 -0
  317. bl_rna_utils/data_path/py.typed +0 -0
  318. bl_text_utils/external_editor/py.typed +0 -0
  319. bl_ui/anim/py.typed +0 -0
  320. bl_ui/asset_shelf/py.typed +0 -0
  321. bl_ui/generic_ui_list/py.typed +0 -0
  322. bl_ui/node_add_menu/py.typed +0 -0
  323. bl_ui/node_add_menu_compositor/py.typed +0 -0
  324. bl_ui/node_add_menu_geometry/py.typed +0 -0
  325. bl_ui/node_add_menu_shader/py.typed +0 -0
  326. bl_ui/node_add_menu_texture/py.typed +0 -0
  327. bl_ui/properties_animviz/py.typed +0 -0
  328. bl_ui/properties_collection/py.typed +0 -0
  329. bl_ui/properties_constraint/py.typed +0 -0
  330. bl_ui/properties_data_armature/py.typed +0 -0
  331. bl_ui/properties_data_bone/py.typed +0 -0
  332. bl_ui/properties_data_camera/py.typed +0 -0
  333. bl_ui/properties_data_curve/py.typed +0 -0
  334. bl_ui/properties_data_curves/py.typed +0 -0
  335. bl_ui/properties_data_empty/py.typed +0 -0
  336. bl_ui/properties_data_gpencil/py.typed +0 -0
  337. bl_ui/properties_data_grease_pencil/py.typed +0 -0
  338. bl_ui/properties_data_lattice/py.typed +0 -0
  339. bl_ui/properties_data_light/py.typed +0 -0
  340. bl_ui/properties_data_lightprobe/py.typed +0 -0
  341. bl_ui/properties_data_mesh/py.typed +0 -0
  342. bl_ui/properties_data_metaball/py.typed +0 -0
  343. bl_ui/properties_data_modifier/py.typed +0 -0
  344. bl_ui/properties_data_pointcloud/py.typed +0 -0
  345. bl_ui/properties_data_shaderfx/py.typed +0 -0
  346. bl_ui/properties_data_speaker/py.typed +0 -0
  347. bl_ui/properties_data_volume/py.typed +0 -0
  348. bl_ui/properties_freestyle/py.typed +0 -0
  349. bl_ui/properties_grease_pencil_common/py.typed +0 -0
  350. bl_ui/properties_mask_common/py.typed +0 -0
  351. bl_ui/properties_material/py.typed +0 -0
  352. bl_ui/properties_material_gpencil/py.typed +0 -0
  353. bl_ui/properties_object/py.typed +0 -0
  354. bl_ui/properties_output/py.typed +0 -0
  355. bl_ui/properties_paint_common/py.typed +0 -0
  356. bl_ui/properties_particle/py.typed +0 -0
  357. bl_ui/properties_physics_cloth/py.typed +0 -0
  358. bl_ui/properties_physics_common/py.typed +0 -0
  359. bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
  360. bl_ui/properties_physics_field/py.typed +0 -0
  361. bl_ui/properties_physics_fluid/py.typed +0 -0
  362. bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
  363. bl_ui/properties_physics_rigidbody/py.typed +0 -0
  364. bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
  365. bl_ui/properties_physics_softbody/py.typed +0 -0
  366. bl_ui/properties_render/py.typed +0 -0
  367. bl_ui/properties_scene/py.typed +0 -0
  368. bl_ui/properties_texture/py.typed +0 -0
  369. bl_ui/properties_view_layer/py.typed +0 -0
  370. bl_ui/properties_workspace/py.typed +0 -0
  371. bl_ui/properties_world/py.typed +0 -0
  372. bl_ui/space_clip/py.typed +0 -0
  373. bl_ui/space_console/py.typed +0 -0
  374. bl_ui/space_dopesheet/py.typed +0 -0
  375. bl_ui/space_filebrowser/py.typed +0 -0
  376. bl_ui/space_graph/py.typed +0 -0
  377. bl_ui/space_image/py.typed +0 -0
  378. bl_ui/space_info/py.typed +0 -0
  379. bl_ui/space_nla/py.typed +0 -0
  380. bl_ui/space_node/py.typed +0 -0
  381. bl_ui/space_outliner/py.typed +0 -0
  382. bl_ui/space_properties/py.typed +0 -0
  383. bl_ui/space_sequencer/py.typed +0 -0
  384. bl_ui/space_spreadsheet/py.typed +0 -0
  385. bl_ui/space_statusbar/py.typed +0 -0
  386. bl_ui/space_text/py.typed +0 -0
  387. bl_ui/space_time/py.typed +0 -0
  388. bl_ui/space_toolsystem_common/py.typed +0 -0
  389. bl_ui/space_toolsystem_toolbar/py.typed +0 -0
  390. bl_ui/space_topbar/py.typed +0 -0
  391. bl_ui/space_userpref/py.typed +0 -0
  392. bl_ui/space_view3d/py.typed +0 -0
  393. bl_ui/space_view3d_toolbar/py.typed +0 -0
  394. bl_ui/temp_anim_layers/py.typed +0 -0
  395. bl_ui/utils/py.typed +0 -0
  396. bl_ui_utils/bug_report_url/py.typed +0 -0
  397. bl_ui_utils/layout/py.typed +0 -0
  398. bmesh/geometry/py.typed +0 -0
  399. bmesh/ops/py.typed +0 -0
  400. bmesh/types/py.typed +0 -0
  401. bmesh/utils/py.typed +0 -0
  402. bpy/app/handlers/py.typed +0 -0
  403. bpy/app/icons/py.typed +0 -0
  404. bpy/app/py.typed +0 -0
  405. bpy/app/timers/py.typed +0 -0
  406. bpy/app/translations/py.typed +0 -0
  407. bpy/msgbus/py.typed +0 -0
  408. bpy/ops/action/py.typed +0 -0
  409. bpy/ops/anim/py.typed +0 -0
  410. bpy/ops/armature/py.typed +0 -0
  411. bpy/ops/asset/py.typed +0 -0
  412. bpy/ops/bl_pkg/py.typed +0 -0
  413. bpy/ops/boid/py.typed +0 -0
  414. bpy/ops/brush/py.typed +0 -0
  415. bpy/ops/buttons/py.typed +0 -0
  416. bpy/ops/cachefile/py.typed +0 -0
  417. bpy/ops/camera/py.typed +0 -0
  418. bpy/ops/clip/py.typed +0 -0
  419. bpy/ops/cloth/py.typed +0 -0
  420. bpy/ops/collection/py.typed +0 -0
  421. bpy/ops/console/py.typed +0 -0
  422. bpy/ops/constraint/py.typed +0 -0
  423. bpy/ops/curve/py.typed +0 -0
  424. bpy/ops/curves/py.typed +0 -0
  425. bpy/ops/cycles/py.typed +0 -0
  426. bpy/ops/dpaint/py.typed +0 -0
  427. bpy/ops/ed/py.typed +0 -0
  428. bpy/ops/export_anim/py.typed +0 -0
  429. bpy/ops/export_scene/py.typed +0 -0
  430. bpy/ops/file/py.typed +0 -0
  431. bpy/ops/fluid/py.typed +0 -0
  432. bpy/ops/font/py.typed +0 -0
  433. bpy/ops/geometry/py.typed +0 -0
  434. bpy/ops/gizmogroup/py.typed +0 -0
  435. bpy/ops/gpencil/py.typed +0 -0
  436. bpy/ops/graph/py.typed +0 -0
  437. bpy/ops/grease_pencil/py.typed +0 -0
  438. bpy/ops/image/py.typed +0 -0
  439. bpy/ops/import_anim/py.typed +0 -0
  440. bpy/ops/import_curve/py.typed +0 -0
  441. bpy/ops/import_scene/py.typed +0 -0
  442. bpy/ops/info/py.typed +0 -0
  443. bpy/ops/lattice/py.typed +0 -0
  444. bpy/ops/marker/py.typed +0 -0
  445. bpy/ops/mask/py.typed +0 -0
  446. bpy/ops/material/py.typed +0 -0
  447. bpy/ops/mball/py.typed +0 -0
  448. bpy/ops/mesh/py.typed +0 -0
  449. bpy/ops/nla/py.typed +0 -0
  450. bpy/ops/node/py.typed +0 -0
  451. bpy/ops/object/py.typed +0 -0
  452. bpy/ops/outliner/py.typed +0 -0
  453. bpy/ops/paint/py.typed +0 -0
  454. bpy/ops/paintcurve/py.typed +0 -0
  455. bpy/ops/palette/py.typed +0 -0
  456. bpy/ops/particle/py.typed +0 -0
  457. bpy/ops/pose/py.typed +0 -0
  458. bpy/ops/poselib/py.typed +0 -0
  459. bpy/ops/preferences/py.typed +0 -0
  460. bpy/ops/ptcache/py.typed +0 -0
  461. bpy/ops/py.typed +0 -0
  462. bpy/ops/render/py.typed +0 -0
  463. bpy/ops/rigidbody/py.typed +0 -0
  464. bpy/ops/scene/py.typed +0 -0
  465. bpy/ops/screen/py.typed +0 -0
  466. bpy/ops/script/py.typed +0 -0
  467. bpy/ops/sculpt/py.typed +0 -0
  468. bpy/ops/sculpt_curves/py.typed +0 -0
  469. bpy/ops/sequencer/py.typed +0 -0
  470. bpy/ops/sound/py.typed +0 -0
  471. bpy/ops/spreadsheet/py.typed +0 -0
  472. bpy/ops/surface/py.typed +0 -0
  473. bpy/ops/text/py.typed +0 -0
  474. bpy/ops/text_editor/py.typed +0 -0
  475. bpy/ops/texture/py.typed +0 -0
  476. bpy/ops/transform/py.typed +0 -0
  477. bpy/ops/ui/py.typed +0 -0
  478. bpy/ops/uilist/py.typed +0 -0
  479. bpy/ops/uv/py.typed +0 -0
  480. bpy/ops/view2d/py.typed +0 -0
  481. bpy/ops/view3d/py.typed +0 -0
  482. bpy/ops/wm/py.typed +0 -0
  483. bpy/ops/workspace/py.typed +0 -0
  484. bpy/ops/world/py.typed +0 -0
  485. bpy/path/py.typed +0 -0
  486. bpy/props/py.typed +0 -0
  487. bpy/types/py.typed +0 -0
  488. bpy/utils/previews/py.typed +0 -0
  489. bpy/utils/py.typed +0 -0
  490. bpy/utils/units/py.typed +0 -0
  491. bpy_extras/anim_utils/py.typed +0 -0
  492. bpy_extras/asset_utils/py.typed +0 -0
  493. bpy_extras/bmesh_utils/py.typed +0 -0
  494. bpy_extras/extensions/junction_module/py.typed +0 -0
  495. bpy_extras/extensions/py.typed +0 -0
  496. bpy_extras/id_map_utils/py.typed +0 -0
  497. bpy_extras/image_utils/py.typed +0 -0
  498. bpy_extras/io_utils/py.typed +0 -0
  499. bpy_extras/keyconfig_utils/py.typed +0 -0
  500. bpy_extras/mesh_utils/py.typed +0 -0
  501. bpy_extras/node_shader_utils/py.typed +0 -0
  502. bpy_extras/node_utils/py.typed +0 -0
  503. bpy_extras/object_utils/py.typed +0 -0
  504. bpy_extras/view3d_utils/py.typed +0 -0
  505. bpy_extras/wm_utils/progress_report/py.typed +0 -0
  506. bpy_extras/wm_utils/py.typed +0 -0
  507. fake_bpy_module-20240516.dist-info/RECORD +0 -618
  508. freestyle/chainingiterators/py.typed +0 -0
  509. freestyle/functions/py.typed +0 -0
  510. freestyle/predicates/py.typed +0 -0
  511. freestyle/shaders/py.typed +0 -0
  512. freestyle/types/py.typed +0 -0
  513. freestyle/utils/ContextFunctions/py.typed +0 -0
  514. freestyle/utils/py.typed +0 -0
  515. gpu/capabilities/py.typed +0 -0
  516. gpu/matrix/py.typed +0 -0
  517. gpu/platform/py.typed +0 -0
  518. gpu/select/py.typed +0 -0
  519. gpu/shader/py.typed +0 -0
  520. gpu/state/py.typed +0 -0
  521. gpu/texture/py.typed +0 -0
  522. gpu/types/py.typed +0 -0
  523. gpu_extras/batch/py.typed +0 -0
  524. gpu_extras/presets/py.typed +0 -0
  525. idprop/types/py.typed +0 -0
  526. imbuf/types/py.typed +0 -0
  527. mathutils/bvhtree/py.typed +0 -0
  528. mathutils/geometry/py.typed +0 -0
  529. mathutils/interpolate/py.typed +0 -0
  530. mathutils/kdtree/py.typed +0 -0
  531. mathutils/noise/py.typed +0 -0
  532. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/WHEEL +0 -0
  533. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/top_level.txt +0 -0
@@ -1,5 +1,6 @@
1
1
  import typing
2
2
  import bl_ui.utils
3
+ import bpy.types
3
4
  import bpy_types
4
5
 
5
6
  GenericType = typing.TypeVar("GenericType")
@@ -23,28 +24,46 @@ class RENDER_MT_framerate_presets(bpy_types.Menu, bpy_types._GenericUI):
23
24
  """ """
24
25
 
25
26
  def append(self, draw_func):
26
- """
27
+ """Append a draw function to this menu,
28
+ takes the same arguments as the menus draw function
27
29
 
28
- :param draw_func:
30
+ :param draw_func:
29
31
  """
30
32
  ...
31
33
 
32
- def as_pointer(self):
33
- """ """
34
+ def as_pointer(self) -> int:
35
+ """Returns the memory address which holds a pointer to Blender's internal data
36
+
37
+ :return: int (memory address).
38
+ :rtype: int
39
+ """
34
40
  ...
35
41
 
36
- def bl_rna_get_subclass(self):
37
- """ """
42
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
43
+ """
44
+
45
+ :return: The RNA type or default when not found.
46
+ :rtype: bpy.types.Struct
47
+ """
38
48
  ...
39
49
 
40
- def bl_rna_get_subclass_py(self):
41
- """ """
50
+ def bl_rna_get_subclass_py(self) -> typing.Any:
51
+ """
52
+
53
+ :return: The class or default when not found.
54
+ :rtype: typing.Any
55
+ """
42
56
  ...
43
57
 
44
58
  def draw(self, _context):
45
- """
59
+ """Define these on the subclass:
60
+ - preset_operator (string)
61
+ - preset_subdir (string)Optionally:
62
+ - preset_add_operator (string)
63
+ - preset_extensions (set of strings)
64
+ - preset_operator_defaults (dict of keyword args)
46
65
 
47
- :param _context:
66
+ :param _context:
48
67
  """
49
68
  ...
50
69
 
@@ -57,138 +76,224 @@ class RENDER_MT_framerate_presets(bpy_types.Menu, bpy_types._GenericUI):
57
76
  ...
58
77
 
59
78
  def draw_preset(self, _context):
60
- """
79
+ """Define these on the subclass:
80
+ - preset_operator (string)
81
+ - preset_subdir (string)Optionally:
82
+ - preset_add_operator (string)
83
+ - preset_extensions (set of strings)
84
+ - preset_operator_defaults (dict of keyword args)
61
85
 
62
- :param _context:
86
+ :param _context:
63
87
  """
64
88
  ...
65
89
 
66
- def driver_add(self):
67
- """ """
90
+ def driver_add(self) -> bpy.types.FCurve:
91
+ """Adds driver(s) to the given property
92
+
93
+ :return: The driver(s) added.
94
+ :rtype: bpy.types.FCurve
95
+ """
68
96
  ...
69
97
 
70
- def driver_remove(self):
71
- """ """
98
+ def driver_remove(self) -> bool:
99
+ """Remove driver(s) from the given property
100
+
101
+ :return: Success of driver removal.
102
+ :rtype: bool
103
+ """
72
104
  ...
73
105
 
74
106
  def get(self):
75
- """ """
107
+ """Returns the value of the custom property assigned to key or default
108
+ when not found (matches Python's dictionary function of the same name).
109
+
110
+ """
76
111
  ...
77
112
 
78
113
  def id_properties_clear(self):
79
- """ """
114
+ """
115
+
116
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
117
+ """
80
118
  ...
81
119
 
82
120
  def id_properties_ensure(self):
83
- """ """
121
+ """
122
+
123
+ :return: the parent group for an RNA struct's custom IDProperties.
124
+ """
84
125
  ...
85
126
 
86
127
  def id_properties_ui(self):
87
- """ """
128
+ """
129
+
130
+ :return: Return an object used to manage an IDProperty's UI data.
131
+ """
88
132
  ...
89
133
 
90
134
  def is_extended(self):
91
135
  """ """
92
136
  ...
93
137
 
94
- def is_property_hidden(self):
95
- """ """
138
+ def is_property_hidden(self) -> bool:
139
+ """Check if a property is hidden.
140
+
141
+ :return: True when the property is hidden.
142
+ :rtype: bool
143
+ """
96
144
  ...
97
145
 
98
- def is_property_overridable_library(self):
99
- """ """
146
+ def is_property_overridable_library(self) -> bool:
147
+ """Check if a property is overridable.
148
+
149
+ :return: True when the property is overridable.
150
+ :rtype: bool
151
+ """
100
152
  ...
101
153
 
102
- def is_property_readonly(self):
103
- """ """
154
+ def is_property_readonly(self) -> bool:
155
+ """Check if a property is readonly.
156
+
157
+ :return: True when the property is readonly (not writable).
158
+ :rtype: bool
159
+ """
104
160
  ...
105
161
 
106
- def is_property_set(self):
107
- """ """
162
+ def is_property_set(self) -> bool:
163
+ """Check if a property is set, use for testing operator properties.
164
+
165
+ :return: True when the property has been set.
166
+ :rtype: bool
167
+ """
108
168
  ...
109
169
 
110
170
  def items(self):
111
- """ """
171
+ """Returns the items of this objects custom properties (matches Python's
172
+ dictionary function of the same name).
173
+
174
+ :return: custom property key, value pairs.
175
+ """
112
176
  ...
113
177
 
114
- def keyframe_delete(self):
115
- """ """
178
+ def keyframe_delete(self) -> bool:
179
+ """Remove a keyframe from this properties fcurve.
180
+
181
+ :return: Success of keyframe deletion.
182
+ :rtype: bool
183
+ """
116
184
  ...
117
185
 
118
- def keyframe_insert(self):
119
- """ """
186
+ def keyframe_insert(self) -> bool:
187
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
188
+
189
+ :return: Success of keyframe insertion.
190
+ :rtype: bool
191
+ """
120
192
  ...
121
193
 
122
194
  def keys(self):
123
- """ """
195
+ """Returns the keys of this objects custom properties (matches Python's
196
+ dictionary function of the same name).
197
+
198
+ :return: custom property keys.
199
+ """
124
200
  ...
125
201
 
126
- def path_from_id(self):
127
- """ """
202
+ def path_from_id(self) -> str:
203
+ """Returns the data path from the ID to this object (string).
204
+
205
+ :return: The path from `bpy.types.bpy_struct.id_data`
206
+ to this struct and property (when given).
207
+ :rtype: str
208
+ """
128
209
  ...
129
210
 
130
211
  def path_menu(
131
212
  self,
132
- searchpaths,
133
- operator,
134
- props_default,
135
- prop_filepath,
136
- filter_ext,
137
- filter_path,
138
- display_name,
139
- add_operator,
140
- add_operator_props,
213
+ searchpaths: list[str],
214
+ operator: str,
215
+ props_default: dict = None,
216
+ prop_filepath: str = "filepath",
217
+ filter_ext: typing.Callable = None,
218
+ filter_path=None,
219
+ display_name: typing.Callable = None,
220
+ add_operator=None,
221
+ add_operator_props=None,
141
222
  ):
142
- """
223
+ """Populate a menu from a list of paths.
143
224
 
144
- :param searchpaths:
145
- :param operator:
146
- :param props_default:
147
- :param prop_filepath:
148
- :param filter_ext:
149
- :param filter_path:
150
- :param display_name:
151
- :param add_operator:
152
- :param add_operator_props:
225
+ :param searchpaths: Paths to scan.
226
+ :type searchpaths: list[str]
227
+ :param operator: The operator id to use with each file.
228
+ :type operator: str
229
+ :param props_default: Properties to assign to each operator.
230
+ :type props_default: dict
231
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
232
+ :type prop_filepath: str
233
+ :param filter_ext: Optional callback that takes the file extensions.
234
+
235
+ Returning false excludes the file from the list.
236
+ :type filter_ext: typing.Callable
237
+ :param filter_path:
238
+ :param display_name: Optional callback that takes the full path, returns the name to display.
239
+ :type display_name: typing.Callable
240
+ :param add_operator:
241
+ :param add_operator_props:
153
242
  """
154
243
  ...
155
244
 
156
245
  def path_resolve(self):
157
- """ """
246
+ """Returns the property from the path, raise an exception when not found."""
158
247
  ...
159
248
 
160
249
  def pop(self):
161
- """ """
250
+ """Remove and return the value of the custom property assigned to key or default
251
+ when not found (matches Python's dictionary function of the same name).
252
+
253
+ """
162
254
  ...
163
255
 
164
256
  def prepend(self, draw_func):
165
- """
257
+ """Prepend a draw function to this menu, takes the same arguments as
258
+ the menus draw function
166
259
 
167
- :param draw_func:
260
+ :param draw_func:
168
261
  """
169
262
  ...
170
263
 
171
- def property_overridable_library_set(self):
172
- """ """
264
+ def property_overridable_library_set(self) -> bool:
265
+ """Define a property as overridable or not (only for custom properties!).
266
+
267
+ :return: True when the overridable status of the property was successfully set.
268
+ :rtype: bool
269
+ """
173
270
  ...
174
271
 
175
272
  def property_unset(self):
176
- """ """
273
+ """Unset a property, will use default value afterward."""
177
274
  ...
178
275
 
179
276
  def remove(self, draw_func):
180
- """
277
+ """Remove a draw function that has been added to this menu
181
278
 
182
279
  :param draw_func:
183
280
  """
184
281
  ...
185
282
 
186
283
  def type_recast(self):
187
- """ """
284
+ """Return a new instance, this is needed because types
285
+ such as textures can be changed at runtime.
286
+
287
+ :return: a new instance of this object with the type initialized again.
288
+ """
188
289
  ...
189
290
 
190
291
  def values(self):
191
- """ """
292
+ """Returns the values of this objects custom properties (matches Python's
293
+ dictionary function of the same name).
294
+
295
+ :return: custom property values.
296
+ """
192
297
  ...
193
298
 
194
299
  class RenderOutputButtonsPanel:
@@ -237,22 +342,35 @@ class RENDER_PT_ffmpeg_presets(
237
342
  """ """
238
343
 
239
344
  def append(self, draw_func):
240
- """
345
+ """Append a draw function to this menu,
346
+ takes the same arguments as the menus draw function
241
347
 
242
- :param draw_func:
348
+ :param draw_func:
243
349
  """
244
350
  ...
245
351
 
246
- def as_pointer(self):
247
- """ """
352
+ def as_pointer(self) -> int:
353
+ """Returns the memory address which holds a pointer to Blender's internal data
354
+
355
+ :return: int (memory address).
356
+ :rtype: int
357
+ """
248
358
  ...
249
359
 
250
- def bl_rna_get_subclass(self):
251
- """ """
360
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
361
+ """
362
+
363
+ :return: The RNA type or default when not found.
364
+ :rtype: bpy.types.Struct
365
+ """
252
366
  ...
253
367
 
254
- def bl_rna_get_subclass_py(self):
255
- """ """
368
+ def bl_rna_get_subclass_py(self) -> typing.Any:
369
+ """
370
+
371
+ :return: The class or default when not found.
372
+ :rtype: typing.Any
373
+ """
256
374
  ...
257
375
 
258
376
  def draw(self, context):
@@ -262,7 +380,7 @@ class RENDER_PT_ffmpeg_presets(
262
380
  """
263
381
  ...
264
382
 
265
- def draw_menu(self, layout, text):
383
+ def draw_menu(self, layout, text=None):
266
384
  """
267
385
 
268
386
  :param layout:
@@ -277,132 +395,213 @@ class RENDER_PT_ffmpeg_presets(
277
395
  """
278
396
  ...
279
397
 
280
- def driver_add(self):
281
- """ """
398
+ def driver_add(self) -> bpy.types.FCurve:
399
+ """Adds driver(s) to the given property
400
+
401
+ :return: The driver(s) added.
402
+ :rtype: bpy.types.FCurve
403
+ """
282
404
  ...
283
405
 
284
- def driver_remove(self):
285
- """ """
406
+ def driver_remove(self) -> bool:
407
+ """Remove driver(s) from the given property
408
+
409
+ :return: Success of driver removal.
410
+ :rtype: bool
411
+ """
286
412
  ...
287
413
 
288
414
  def get(self):
289
- """ """
415
+ """Returns the value of the custom property assigned to key or default
416
+ when not found (matches Python's dictionary function of the same name).
417
+
418
+ """
290
419
  ...
291
420
 
292
421
  def id_properties_clear(self):
293
- """ """
422
+ """
423
+
424
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
425
+ """
294
426
  ...
295
427
 
296
428
  def id_properties_ensure(self):
297
- """ """
429
+ """
430
+
431
+ :return: the parent group for an RNA struct's custom IDProperties.
432
+ """
298
433
  ...
299
434
 
300
435
  def id_properties_ui(self):
301
- """ """
436
+ """
437
+
438
+ :return: Return an object used to manage an IDProperty's UI data.
439
+ """
302
440
  ...
303
441
 
304
442
  def is_extended(self):
305
443
  """ """
306
444
  ...
307
445
 
308
- def is_property_hidden(self):
309
- """ """
446
+ def is_property_hidden(self) -> bool:
447
+ """Check if a property is hidden.
448
+
449
+ :return: True when the property is hidden.
450
+ :rtype: bool
451
+ """
310
452
  ...
311
453
 
312
- def is_property_overridable_library(self):
313
- """ """
454
+ def is_property_overridable_library(self) -> bool:
455
+ """Check if a property is overridable.
456
+
457
+ :return: True when the property is overridable.
458
+ :rtype: bool
459
+ """
314
460
  ...
315
461
 
316
- def is_property_readonly(self):
317
- """ """
462
+ def is_property_readonly(self) -> bool:
463
+ """Check if a property is readonly.
464
+
465
+ :return: True when the property is readonly (not writable).
466
+ :rtype: bool
467
+ """
318
468
  ...
319
469
 
320
- def is_property_set(self):
321
- """ """
470
+ def is_property_set(self) -> bool:
471
+ """Check if a property is set, use for testing operator properties.
472
+
473
+ :return: True when the property has been set.
474
+ :rtype: bool
475
+ """
322
476
  ...
323
477
 
324
478
  def items(self):
325
- """ """
479
+ """Returns the items of this objects custom properties (matches Python's
480
+ dictionary function of the same name).
481
+
482
+ :return: custom property key, value pairs.
483
+ """
326
484
  ...
327
485
 
328
- def keyframe_delete(self):
329
- """ """
486
+ def keyframe_delete(self) -> bool:
487
+ """Remove a keyframe from this properties fcurve.
488
+
489
+ :return: Success of keyframe deletion.
490
+ :rtype: bool
491
+ """
330
492
  ...
331
493
 
332
- def keyframe_insert(self):
333
- """ """
494
+ def keyframe_insert(self) -> bool:
495
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
496
+
497
+ :return: Success of keyframe insertion.
498
+ :rtype: bool
499
+ """
334
500
  ...
335
501
 
336
502
  def keys(self):
337
- """ """
503
+ """Returns the keys of this objects custom properties (matches Python's
504
+ dictionary function of the same name).
505
+
506
+ :return: custom property keys.
507
+ """
338
508
  ...
339
509
 
340
- def path_from_id(self):
341
- """ """
510
+ def path_from_id(self) -> str:
511
+ """Returns the data path from the ID to this object (string).
512
+
513
+ :return: The path from `bpy.types.bpy_struct.id_data`
514
+ to this struct and property (when given).
515
+ :rtype: str
516
+ """
342
517
  ...
343
518
 
344
519
  def path_menu(
345
520
  self,
346
- searchpaths,
347
- operator,
348
- props_default,
349
- prop_filepath,
350
- filter_ext,
351
- filter_path,
352
- display_name,
353
- add_operator,
354
- add_operator_props,
521
+ searchpaths: list[str],
522
+ operator: str,
523
+ props_default: dict = None,
524
+ prop_filepath: str = "filepath",
525
+ filter_ext: typing.Callable = None,
526
+ filter_path=None,
527
+ display_name: typing.Callable = None,
528
+ add_operator=None,
529
+ add_operator_props=None,
355
530
  ):
356
- """
531
+ """Populate a menu from a list of paths.
357
532
 
358
- :param searchpaths:
359
- :param operator:
360
- :param props_default:
361
- :param prop_filepath:
362
- :param filter_ext:
363
- :param filter_path:
364
- :param display_name:
365
- :param add_operator:
366
- :param add_operator_props:
533
+ :param searchpaths: Paths to scan.
534
+ :type searchpaths: list[str]
535
+ :param operator: The operator id to use with each file.
536
+ :type operator: str
537
+ :param props_default: Properties to assign to each operator.
538
+ :type props_default: dict
539
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
540
+ :type prop_filepath: str
541
+ :param filter_ext: Optional callback that takes the file extensions.
542
+
543
+ Returning false excludes the file from the list.
544
+ :type filter_ext: typing.Callable
545
+ :param filter_path:
546
+ :param display_name: Optional callback that takes the full path, returns the name to display.
547
+ :type display_name: typing.Callable
548
+ :param add_operator:
549
+ :param add_operator_props:
367
550
  """
368
551
  ...
369
552
 
370
553
  def path_resolve(self):
371
- """ """
554
+ """Returns the property from the path, raise an exception when not found."""
372
555
  ...
373
556
 
374
557
  def pop(self):
375
- """ """
558
+ """Remove and return the value of the custom property assigned to key or default
559
+ when not found (matches Python's dictionary function of the same name).
560
+
561
+ """
376
562
  ...
377
563
 
378
564
  def prepend(self, draw_func):
379
- """
565
+ """Prepend a draw function to this menu, takes the same arguments as
566
+ the menus draw function
380
567
 
381
- :param draw_func:
568
+ :param draw_func:
382
569
  """
383
570
  ...
384
571
 
385
- def property_overridable_library_set(self):
386
- """ """
572
+ def property_overridable_library_set(self) -> bool:
573
+ """Define a property as overridable or not (only for custom properties!).
574
+
575
+ :return: True when the overridable status of the property was successfully set.
576
+ :rtype: bool
577
+ """
387
578
  ...
388
579
 
389
580
  def property_unset(self):
390
- """ """
581
+ """Unset a property, will use default value afterward."""
391
582
  ...
392
583
 
393
584
  def remove(self, draw_func):
394
- """
585
+ """Remove a draw function that has been added to this menu
395
586
 
396
587
  :param draw_func:
397
588
  """
398
589
  ...
399
590
 
400
591
  def type_recast(self):
401
- """ """
592
+ """Return a new instance, this is needed because types
593
+ such as textures can be changed at runtime.
594
+
595
+ :return: a new instance of this object with the type initialized again.
596
+ """
402
597
  ...
403
598
 
404
599
  def values(self):
405
- """ """
600
+ """Returns the values of this objects custom properties (matches Python's
601
+ dictionary function of the same name).
602
+
603
+ :return: custom property values.
604
+ """
406
605
  ...
407
606
 
408
607
  class RENDER_PT_format_presets(
@@ -435,22 +634,35 @@ class RENDER_PT_format_presets(
435
634
  """ """
436
635
 
437
636
  def append(self, draw_func):
438
- """
637
+ """Append a draw function to this menu,
638
+ takes the same arguments as the menus draw function
439
639
 
440
- :param draw_func:
640
+ :param draw_func:
441
641
  """
442
642
  ...
443
643
 
444
- def as_pointer(self):
445
- """ """
644
+ def as_pointer(self) -> int:
645
+ """Returns the memory address which holds a pointer to Blender's internal data
646
+
647
+ :return: int (memory address).
648
+ :rtype: int
649
+ """
446
650
  ...
447
651
 
448
- def bl_rna_get_subclass(self):
449
- """ """
652
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
653
+ """
654
+
655
+ :return: The RNA type or default when not found.
656
+ :rtype: bpy.types.Struct
657
+ """
450
658
  ...
451
659
 
452
- def bl_rna_get_subclass_py(self):
453
- """ """
660
+ def bl_rna_get_subclass_py(self) -> typing.Any:
661
+ """
662
+
663
+ :return: The class or default when not found.
664
+ :rtype: typing.Any
665
+ """
454
666
  ...
455
667
 
456
668
  def draw(self, context):
@@ -460,7 +672,7 @@ class RENDER_PT_format_presets(
460
672
  """
461
673
  ...
462
674
 
463
- def draw_menu(self, layout, text):
675
+ def draw_menu(self, layout, text=None):
464
676
  """
465
677
 
466
678
  :param layout:
@@ -475,132 +687,213 @@ class RENDER_PT_format_presets(
475
687
  """
476
688
  ...
477
689
 
478
- def driver_add(self):
479
- """ """
690
+ def driver_add(self) -> bpy.types.FCurve:
691
+ """Adds driver(s) to the given property
692
+
693
+ :return: The driver(s) added.
694
+ :rtype: bpy.types.FCurve
695
+ """
480
696
  ...
481
697
 
482
- def driver_remove(self):
483
- """ """
698
+ def driver_remove(self) -> bool:
699
+ """Remove driver(s) from the given property
700
+
701
+ :return: Success of driver removal.
702
+ :rtype: bool
703
+ """
484
704
  ...
485
705
 
486
706
  def get(self):
487
- """ """
707
+ """Returns the value of the custom property assigned to key or default
708
+ when not found (matches Python's dictionary function of the same name).
709
+
710
+ """
488
711
  ...
489
712
 
490
713
  def id_properties_clear(self):
491
- """ """
714
+ """
715
+
716
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
717
+ """
492
718
  ...
493
719
 
494
720
  def id_properties_ensure(self):
495
- """ """
721
+ """
722
+
723
+ :return: the parent group for an RNA struct's custom IDProperties.
724
+ """
496
725
  ...
497
726
 
498
727
  def id_properties_ui(self):
499
- """ """
728
+ """
729
+
730
+ :return: Return an object used to manage an IDProperty's UI data.
731
+ """
500
732
  ...
501
733
 
502
734
  def is_extended(self):
503
735
  """ """
504
736
  ...
505
737
 
506
- def is_property_hidden(self):
507
- """ """
738
+ def is_property_hidden(self) -> bool:
739
+ """Check if a property is hidden.
740
+
741
+ :return: True when the property is hidden.
742
+ :rtype: bool
743
+ """
508
744
  ...
509
745
 
510
- def is_property_overridable_library(self):
511
- """ """
746
+ def is_property_overridable_library(self) -> bool:
747
+ """Check if a property is overridable.
748
+
749
+ :return: True when the property is overridable.
750
+ :rtype: bool
751
+ """
512
752
  ...
513
753
 
514
- def is_property_readonly(self):
515
- """ """
754
+ def is_property_readonly(self) -> bool:
755
+ """Check if a property is readonly.
756
+
757
+ :return: True when the property is readonly (not writable).
758
+ :rtype: bool
759
+ """
516
760
  ...
517
761
 
518
- def is_property_set(self):
519
- """ """
762
+ def is_property_set(self) -> bool:
763
+ """Check if a property is set, use for testing operator properties.
764
+
765
+ :return: True when the property has been set.
766
+ :rtype: bool
767
+ """
520
768
  ...
521
769
 
522
770
  def items(self):
523
- """ """
771
+ """Returns the items of this objects custom properties (matches Python's
772
+ dictionary function of the same name).
773
+
774
+ :return: custom property key, value pairs.
775
+ """
524
776
  ...
525
777
 
526
- def keyframe_delete(self):
527
- """ """
778
+ def keyframe_delete(self) -> bool:
779
+ """Remove a keyframe from this properties fcurve.
780
+
781
+ :return: Success of keyframe deletion.
782
+ :rtype: bool
783
+ """
528
784
  ...
529
785
 
530
- def keyframe_insert(self):
531
- """ """
786
+ def keyframe_insert(self) -> bool:
787
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
788
+
789
+ :return: Success of keyframe insertion.
790
+ :rtype: bool
791
+ """
532
792
  ...
533
793
 
534
794
  def keys(self):
535
- """ """
795
+ """Returns the keys of this objects custom properties (matches Python's
796
+ dictionary function of the same name).
797
+
798
+ :return: custom property keys.
799
+ """
536
800
  ...
537
801
 
538
- def path_from_id(self):
539
- """ """
802
+ def path_from_id(self) -> str:
803
+ """Returns the data path from the ID to this object (string).
804
+
805
+ :return: The path from `bpy.types.bpy_struct.id_data`
806
+ to this struct and property (when given).
807
+ :rtype: str
808
+ """
540
809
  ...
541
810
 
542
811
  def path_menu(
543
812
  self,
544
- searchpaths,
545
- operator,
546
- props_default,
547
- prop_filepath,
548
- filter_ext,
549
- filter_path,
550
- display_name,
551
- add_operator,
552
- add_operator_props,
813
+ searchpaths: list[str],
814
+ operator: str,
815
+ props_default: dict = None,
816
+ prop_filepath: str = "filepath",
817
+ filter_ext: typing.Callable = None,
818
+ filter_path=None,
819
+ display_name: typing.Callable = None,
820
+ add_operator=None,
821
+ add_operator_props=None,
553
822
  ):
554
- """
823
+ """Populate a menu from a list of paths.
555
824
 
556
- :param searchpaths:
557
- :param operator:
558
- :param props_default:
559
- :param prop_filepath:
560
- :param filter_ext:
561
- :param filter_path:
562
- :param display_name:
563
- :param add_operator:
564
- :param add_operator_props:
825
+ :param searchpaths: Paths to scan.
826
+ :type searchpaths: list[str]
827
+ :param operator: The operator id to use with each file.
828
+ :type operator: str
829
+ :param props_default: Properties to assign to each operator.
830
+ :type props_default: dict
831
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
832
+ :type prop_filepath: str
833
+ :param filter_ext: Optional callback that takes the file extensions.
834
+
835
+ Returning false excludes the file from the list.
836
+ :type filter_ext: typing.Callable
837
+ :param filter_path:
838
+ :param display_name: Optional callback that takes the full path, returns the name to display.
839
+ :type display_name: typing.Callable
840
+ :param add_operator:
841
+ :param add_operator_props:
565
842
  """
566
843
  ...
567
844
 
568
845
  def path_resolve(self):
569
- """ """
846
+ """Returns the property from the path, raise an exception when not found."""
570
847
  ...
571
848
 
572
849
  def pop(self):
573
- """ """
850
+ """Remove and return the value of the custom property assigned to key or default
851
+ when not found (matches Python's dictionary function of the same name).
852
+
853
+ """
574
854
  ...
575
855
 
576
856
  def prepend(self, draw_func):
577
- """
857
+ """Prepend a draw function to this menu, takes the same arguments as
858
+ the menus draw function
578
859
 
579
- :param draw_func:
860
+ :param draw_func:
580
861
  """
581
862
  ...
582
863
 
583
- def property_overridable_library_set(self):
584
- """ """
864
+ def property_overridable_library_set(self) -> bool:
865
+ """Define a property as overridable or not (only for custom properties!).
866
+
867
+ :return: True when the overridable status of the property was successfully set.
868
+ :rtype: bool
869
+ """
585
870
  ...
586
871
 
587
872
  def property_unset(self):
588
- """ """
873
+ """Unset a property, will use default value afterward."""
589
874
  ...
590
875
 
591
876
  def remove(self, draw_func):
592
- """
877
+ """Remove a draw function that has been added to this menu
593
878
 
594
879
  :param draw_func:
595
880
  """
596
881
  ...
597
882
 
598
883
  def type_recast(self):
599
- """ """
884
+ """Return a new instance, this is needed because types
885
+ such as textures can be changed at runtime.
886
+
887
+ :return: a new instance of this object with the type initialized again.
888
+ """
600
889
  ...
601
890
 
602
891
  def values(self):
603
- """ """
892
+ """Returns the values of this objects custom properties (matches Python's
893
+ dictionary function of the same name).
894
+
895
+ :return: custom property values.
896
+ """
604
897
  ...
605
898
 
606
899
  class RENDER_UL_renderviews(bpy_types.UIList, bpy_types._GenericUI):
@@ -613,27 +906,40 @@ class RENDER_UL_renderviews(bpy_types.UIList, bpy_types._GenericUI):
613
906
  """ """
614
907
 
615
908
  def append(self, draw_func):
616
- """
909
+ """Append a draw function to this menu,
910
+ takes the same arguments as the menus draw function
617
911
 
618
- :param draw_func:
912
+ :param draw_func:
619
913
  """
620
914
  ...
621
915
 
622
- def as_pointer(self):
623
- """ """
624
- ...
625
-
626
- def bl_rna_get_subclass(self):
627
- """ """
628
- ...
916
+ def as_pointer(self) -> int:
917
+ """Returns the memory address which holds a pointer to Blender's internal data
629
918
 
630
- def bl_rna_get_subclass_py(self):
631
- """ """
919
+ :return: int (memory address).
920
+ :rtype: int
921
+ """
632
922
  ...
633
923
 
634
- def draw_item(
635
- self, _context, layout, _data, item, icon, _active_data, _active_propname, index
636
- ):
924
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
925
+ """
926
+
927
+ :return: The RNA type or default when not found.
928
+ :rtype: bpy.types.Struct
929
+ """
930
+ ...
931
+
932
+ def bl_rna_get_subclass_py(self) -> typing.Any:
933
+ """
934
+
935
+ :return: The class or default when not found.
936
+ :rtype: typing.Any
937
+ """
938
+ ...
939
+
940
+ def draw_item(
941
+ self, _context, layout, _data, item, icon, _active_data, _active_propname, index
942
+ ):
637
943
  """
638
944
 
639
945
  :param _context:
@@ -647,106 +953,179 @@ class RENDER_UL_renderviews(bpy_types.UIList, bpy_types._GenericUI):
647
953
  """
648
954
  ...
649
955
 
650
- def driver_add(self):
651
- """ """
956
+ def driver_add(self) -> bpy.types.FCurve:
957
+ """Adds driver(s) to the given property
958
+
959
+ :return: The driver(s) added.
960
+ :rtype: bpy.types.FCurve
961
+ """
652
962
  ...
653
963
 
654
- def driver_remove(self):
655
- """ """
964
+ def driver_remove(self) -> bool:
965
+ """Remove driver(s) from the given property
966
+
967
+ :return: Success of driver removal.
968
+ :rtype: bool
969
+ """
656
970
  ...
657
971
 
658
972
  def get(self):
659
- """ """
973
+ """Returns the value of the custom property assigned to key or default
974
+ when not found (matches Python's dictionary function of the same name).
975
+
976
+ """
660
977
  ...
661
978
 
662
979
  def id_properties_clear(self):
663
- """ """
980
+ """
981
+
982
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
983
+ """
664
984
  ...
665
985
 
666
986
  def id_properties_ensure(self):
667
- """ """
987
+ """
988
+
989
+ :return: the parent group for an RNA struct's custom IDProperties.
990
+ """
668
991
  ...
669
992
 
670
993
  def id_properties_ui(self):
671
- """ """
994
+ """
995
+
996
+ :return: Return an object used to manage an IDProperty's UI data.
997
+ """
672
998
  ...
673
999
 
674
1000
  def is_extended(self):
675
1001
  """ """
676
1002
  ...
677
1003
 
678
- def is_property_hidden(self):
679
- """ """
1004
+ def is_property_hidden(self) -> bool:
1005
+ """Check if a property is hidden.
1006
+
1007
+ :return: True when the property is hidden.
1008
+ :rtype: bool
1009
+ """
680
1010
  ...
681
1011
 
682
- def is_property_overridable_library(self):
683
- """ """
1012
+ def is_property_overridable_library(self) -> bool:
1013
+ """Check if a property is overridable.
1014
+
1015
+ :return: True when the property is overridable.
1016
+ :rtype: bool
1017
+ """
684
1018
  ...
685
1019
 
686
- def is_property_readonly(self):
687
- """ """
1020
+ def is_property_readonly(self) -> bool:
1021
+ """Check if a property is readonly.
1022
+
1023
+ :return: True when the property is readonly (not writable).
1024
+ :rtype: bool
1025
+ """
688
1026
  ...
689
1027
 
690
- def is_property_set(self):
691
- """ """
1028
+ def is_property_set(self) -> bool:
1029
+ """Check if a property is set, use for testing operator properties.
1030
+
1031
+ :return: True when the property has been set.
1032
+ :rtype: bool
1033
+ """
692
1034
  ...
693
1035
 
694
1036
  def items(self):
695
- """ """
1037
+ """Returns the items of this objects custom properties (matches Python's
1038
+ dictionary function of the same name).
1039
+
1040
+ :return: custom property key, value pairs.
1041
+ """
696
1042
  ...
697
1043
 
698
- def keyframe_delete(self):
699
- """ """
1044
+ def keyframe_delete(self) -> bool:
1045
+ """Remove a keyframe from this properties fcurve.
1046
+
1047
+ :return: Success of keyframe deletion.
1048
+ :rtype: bool
1049
+ """
700
1050
  ...
701
1051
 
702
- def keyframe_insert(self):
703
- """ """
1052
+ def keyframe_insert(self) -> bool:
1053
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1054
+
1055
+ :return: Success of keyframe insertion.
1056
+ :rtype: bool
1057
+ """
704
1058
  ...
705
1059
 
706
1060
  def keys(self):
707
- """ """
1061
+ """Returns the keys of this objects custom properties (matches Python's
1062
+ dictionary function of the same name).
1063
+
1064
+ :return: custom property keys.
1065
+ """
708
1066
  ...
709
1067
 
710
- def path_from_id(self):
711
- """ """
1068
+ def path_from_id(self) -> str:
1069
+ """Returns the data path from the ID to this object (string).
1070
+
1071
+ :return: The path from `bpy.types.bpy_struct.id_data`
1072
+ to this struct and property (when given).
1073
+ :rtype: str
1074
+ """
712
1075
  ...
713
1076
 
714
1077
  def path_resolve(self):
715
- """ """
1078
+ """Returns the property from the path, raise an exception when not found."""
716
1079
  ...
717
1080
 
718
1081
  def pop(self):
719
- """ """
1082
+ """Remove and return the value of the custom property assigned to key or default
1083
+ when not found (matches Python's dictionary function of the same name).
1084
+
1085
+ """
720
1086
  ...
721
1087
 
722
1088
  def prepend(self, draw_func):
723
- """
1089
+ """Prepend a draw function to this menu, takes the same arguments as
1090
+ the menus draw function
724
1091
 
725
- :param draw_func:
1092
+ :param draw_func:
726
1093
  """
727
1094
  ...
728
1095
 
729
- def property_overridable_library_set(self):
730
- """ """
1096
+ def property_overridable_library_set(self) -> bool:
1097
+ """Define a property as overridable or not (only for custom properties!).
1098
+
1099
+ :return: True when the overridable status of the property was successfully set.
1100
+ :rtype: bool
1101
+ """
731
1102
  ...
732
1103
 
733
1104
  def property_unset(self):
734
- """ """
1105
+ """Unset a property, will use default value afterward."""
735
1106
  ...
736
1107
 
737
1108
  def remove(self, draw_func):
738
- """
1109
+ """Remove a draw function that has been added to this menu
739
1110
 
740
1111
  :param draw_func:
741
1112
  """
742
1113
  ...
743
1114
 
744
1115
  def type_recast(self):
745
- """ """
1116
+ """Return a new instance, this is needed because types
1117
+ such as textures can be changed at runtime.
1118
+
1119
+ :return: a new instance of this object with the type initialized again.
1120
+ """
746
1121
  ...
747
1122
 
748
1123
  def values(self):
749
- """ """
1124
+ """Returns the values of this objects custom properties (matches Python's
1125
+ dictionary function of the same name).
1126
+
1127
+ :return: custom property values.
1128
+ """
750
1129
  ...
751
1130
 
752
1131
  class RENDER_PT_encoding(
@@ -782,22 +1161,35 @@ class RENDER_PT_encoding(
782
1161
  """ """
783
1162
 
784
1163
  def append(self, draw_func):
785
- """
1164
+ """Append a draw function to this menu,
1165
+ takes the same arguments as the menus draw function
786
1166
 
787
- :param draw_func:
1167
+ :param draw_func:
788
1168
  """
789
1169
  ...
790
1170
 
791
- def as_pointer(self):
792
- """ """
1171
+ def as_pointer(self) -> int:
1172
+ """Returns the memory address which holds a pointer to Blender's internal data
1173
+
1174
+ :return: int (memory address).
1175
+ :rtype: int
1176
+ """
793
1177
  ...
794
1178
 
795
- def bl_rna_get_subclass(self):
796
- """ """
1179
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1180
+ """
1181
+
1182
+ :return: The RNA type or default when not found.
1183
+ :rtype: bpy.types.Struct
1184
+ """
797
1185
  ...
798
1186
 
799
- def bl_rna_get_subclass_py(self):
800
- """ """
1187
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1188
+ """
1189
+
1190
+ :return: The class or default when not found.
1191
+ :rtype: typing.Any
1192
+ """
801
1193
  ...
802
1194
 
803
1195
  def draw(self, context):
@@ -814,72 +1206,129 @@ class RENDER_PT_encoding(
814
1206
  """
815
1207
  ...
816
1208
 
817
- def driver_add(self):
818
- """ """
1209
+ def driver_add(self) -> bpy.types.FCurve:
1210
+ """Adds driver(s) to the given property
1211
+
1212
+ :return: The driver(s) added.
1213
+ :rtype: bpy.types.FCurve
1214
+ """
819
1215
  ...
820
1216
 
821
- def driver_remove(self):
822
- """ """
1217
+ def driver_remove(self) -> bool:
1218
+ """Remove driver(s) from the given property
1219
+
1220
+ :return: Success of driver removal.
1221
+ :rtype: bool
1222
+ """
823
1223
  ...
824
1224
 
825
1225
  def get(self):
826
- """ """
1226
+ """Returns the value of the custom property assigned to key or default
1227
+ when not found (matches Python's dictionary function of the same name).
1228
+
1229
+ """
827
1230
  ...
828
1231
 
829
1232
  def id_properties_clear(self):
830
- """ """
1233
+ """
1234
+
1235
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1236
+ """
831
1237
  ...
832
1238
 
833
1239
  def id_properties_ensure(self):
834
- """ """
1240
+ """
1241
+
1242
+ :return: the parent group for an RNA struct's custom IDProperties.
1243
+ """
835
1244
  ...
836
1245
 
837
1246
  def id_properties_ui(self):
838
- """ """
1247
+ """
1248
+
1249
+ :return: Return an object used to manage an IDProperty's UI data.
1250
+ """
839
1251
  ...
840
1252
 
841
1253
  def is_extended(self):
842
1254
  """ """
843
1255
  ...
844
1256
 
845
- def is_property_hidden(self):
846
- """ """
1257
+ def is_property_hidden(self) -> bool:
1258
+ """Check if a property is hidden.
1259
+
1260
+ :return: True when the property is hidden.
1261
+ :rtype: bool
1262
+ """
847
1263
  ...
848
1264
 
849
- def is_property_overridable_library(self):
850
- """ """
1265
+ def is_property_overridable_library(self) -> bool:
1266
+ """Check if a property is overridable.
1267
+
1268
+ :return: True when the property is overridable.
1269
+ :rtype: bool
1270
+ """
851
1271
  ...
852
1272
 
853
- def is_property_readonly(self):
854
- """ """
1273
+ def is_property_readonly(self) -> bool:
1274
+ """Check if a property is readonly.
1275
+
1276
+ :return: True when the property is readonly (not writable).
1277
+ :rtype: bool
1278
+ """
855
1279
  ...
856
1280
 
857
- def is_property_set(self):
858
- """ """
1281
+ def is_property_set(self) -> bool:
1282
+ """Check if a property is set, use for testing operator properties.
1283
+
1284
+ :return: True when the property has been set.
1285
+ :rtype: bool
1286
+ """
859
1287
  ...
860
1288
 
861
1289
  def items(self):
862
- """ """
1290
+ """Returns the items of this objects custom properties (matches Python's
1291
+ dictionary function of the same name).
1292
+
1293
+ :return: custom property key, value pairs.
1294
+ """
863
1295
  ...
864
1296
 
865
- def keyframe_delete(self):
866
- """ """
1297
+ def keyframe_delete(self) -> bool:
1298
+ """Remove a keyframe from this properties fcurve.
1299
+
1300
+ :return: Success of keyframe deletion.
1301
+ :rtype: bool
1302
+ """
867
1303
  ...
868
1304
 
869
- def keyframe_insert(self):
870
- """ """
1305
+ def keyframe_insert(self) -> bool:
1306
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1307
+
1308
+ :return: Success of keyframe insertion.
1309
+ :rtype: bool
1310
+ """
871
1311
  ...
872
1312
 
873
1313
  def keys(self):
874
- """ """
1314
+ """Returns the keys of this objects custom properties (matches Python's
1315
+ dictionary function of the same name).
1316
+
1317
+ :return: custom property keys.
1318
+ """
875
1319
  ...
876
1320
 
877
- def path_from_id(self):
878
- """ """
1321
+ def path_from_id(self) -> str:
1322
+ """Returns the data path from the ID to this object (string).
1323
+
1324
+ :return: The path from `bpy.types.bpy_struct.id_data`
1325
+ to this struct and property (when given).
1326
+ :rtype: str
1327
+ """
879
1328
  ...
880
1329
 
881
1330
  def path_resolve(self):
882
- """ """
1331
+ """Returns the property from the path, raise an exception when not found."""
883
1332
  ...
884
1333
 
885
1334
  def poll(self, context):
@@ -890,37 +1339,53 @@ class RENDER_PT_encoding(
890
1339
  ...
891
1340
 
892
1341
  def pop(self):
893
- """ """
1342
+ """Remove and return the value of the custom property assigned to key or default
1343
+ when not found (matches Python's dictionary function of the same name).
1344
+
1345
+ """
894
1346
  ...
895
1347
 
896
1348
  def prepend(self, draw_func):
897
- """
1349
+ """Prepend a draw function to this menu, takes the same arguments as
1350
+ the menus draw function
898
1351
 
899
- :param draw_func:
1352
+ :param draw_func:
900
1353
  """
901
1354
  ...
902
1355
 
903
- def property_overridable_library_set(self):
904
- """ """
1356
+ def property_overridable_library_set(self) -> bool:
1357
+ """Define a property as overridable or not (only for custom properties!).
1358
+
1359
+ :return: True when the overridable status of the property was successfully set.
1360
+ :rtype: bool
1361
+ """
905
1362
  ...
906
1363
 
907
1364
  def property_unset(self):
908
- """ """
1365
+ """Unset a property, will use default value afterward."""
909
1366
  ...
910
1367
 
911
1368
  def remove(self, draw_func):
912
- """
1369
+ """Remove a draw function that has been added to this menu
913
1370
 
914
1371
  :param draw_func:
915
1372
  """
916
1373
  ...
917
1374
 
918
1375
  def type_recast(self):
919
- """ """
1376
+ """Return a new instance, this is needed because types
1377
+ such as textures can be changed at runtime.
1378
+
1379
+ :return: a new instance of this object with the type initialized again.
1380
+ """
920
1381
  ...
921
1382
 
922
1383
  def values(self):
923
- """ """
1384
+ """Returns the values of this objects custom properties (matches Python's
1385
+ dictionary function of the same name).
1386
+
1387
+ :return: custom property values.
1388
+ """
924
1389
  ...
925
1390
 
926
1391
  class RENDER_PT_encoding_audio(
@@ -953,22 +1418,35 @@ class RENDER_PT_encoding_audio(
953
1418
  """ """
954
1419
 
955
1420
  def append(self, draw_func):
956
- """
1421
+ """Append a draw function to this menu,
1422
+ takes the same arguments as the menus draw function
957
1423
 
958
- :param draw_func:
1424
+ :param draw_func:
959
1425
  """
960
1426
  ...
961
1427
 
962
- def as_pointer(self):
963
- """ """
1428
+ def as_pointer(self) -> int:
1429
+ """Returns the memory address which holds a pointer to Blender's internal data
1430
+
1431
+ :return: int (memory address).
1432
+ :rtype: int
1433
+ """
964
1434
  ...
965
1435
 
966
- def bl_rna_get_subclass(self):
967
- """ """
1436
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1437
+ """
1438
+
1439
+ :return: The RNA type or default when not found.
1440
+ :rtype: bpy.types.Struct
1441
+ """
968
1442
  ...
969
1443
 
970
- def bl_rna_get_subclass_py(self):
971
- """ """
1444
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1445
+ """
1446
+
1447
+ :return: The class or default when not found.
1448
+ :rtype: typing.Any
1449
+ """
972
1450
  ...
973
1451
 
974
1452
  def draw(self, context):
@@ -978,72 +1456,129 @@ class RENDER_PT_encoding_audio(
978
1456
  """
979
1457
  ...
980
1458
 
981
- def driver_add(self):
982
- """ """
1459
+ def driver_add(self) -> bpy.types.FCurve:
1460
+ """Adds driver(s) to the given property
1461
+
1462
+ :return: The driver(s) added.
1463
+ :rtype: bpy.types.FCurve
1464
+ """
983
1465
  ...
984
1466
 
985
- def driver_remove(self):
986
- """ """
1467
+ def driver_remove(self) -> bool:
1468
+ """Remove driver(s) from the given property
1469
+
1470
+ :return: Success of driver removal.
1471
+ :rtype: bool
1472
+ """
987
1473
  ...
988
1474
 
989
1475
  def get(self):
990
- """ """
1476
+ """Returns the value of the custom property assigned to key or default
1477
+ when not found (matches Python's dictionary function of the same name).
1478
+
1479
+ """
991
1480
  ...
992
1481
 
993
1482
  def id_properties_clear(self):
994
- """ """
1483
+ """
1484
+
1485
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1486
+ """
995
1487
  ...
996
1488
 
997
1489
  def id_properties_ensure(self):
998
- """ """
1490
+ """
1491
+
1492
+ :return: the parent group for an RNA struct's custom IDProperties.
1493
+ """
999
1494
  ...
1000
1495
 
1001
1496
  def id_properties_ui(self):
1002
- """ """
1497
+ """
1498
+
1499
+ :return: Return an object used to manage an IDProperty's UI data.
1500
+ """
1003
1501
  ...
1004
1502
 
1005
1503
  def is_extended(self):
1006
1504
  """ """
1007
1505
  ...
1008
1506
 
1009
- def is_property_hidden(self):
1010
- """ """
1507
+ def is_property_hidden(self) -> bool:
1508
+ """Check if a property is hidden.
1509
+
1510
+ :return: True when the property is hidden.
1511
+ :rtype: bool
1512
+ """
1011
1513
  ...
1012
1514
 
1013
- def is_property_overridable_library(self):
1014
- """ """
1515
+ def is_property_overridable_library(self) -> bool:
1516
+ """Check if a property is overridable.
1517
+
1518
+ :return: True when the property is overridable.
1519
+ :rtype: bool
1520
+ """
1015
1521
  ...
1016
1522
 
1017
- def is_property_readonly(self):
1018
- """ """
1523
+ def is_property_readonly(self) -> bool:
1524
+ """Check if a property is readonly.
1525
+
1526
+ :return: True when the property is readonly (not writable).
1527
+ :rtype: bool
1528
+ """
1019
1529
  ...
1020
1530
 
1021
- def is_property_set(self):
1022
- """ """
1531
+ def is_property_set(self) -> bool:
1532
+ """Check if a property is set, use for testing operator properties.
1533
+
1534
+ :return: True when the property has been set.
1535
+ :rtype: bool
1536
+ """
1023
1537
  ...
1024
1538
 
1025
1539
  def items(self):
1026
- """ """
1540
+ """Returns the items of this objects custom properties (matches Python's
1541
+ dictionary function of the same name).
1542
+
1543
+ :return: custom property key, value pairs.
1544
+ """
1027
1545
  ...
1028
1546
 
1029
- def keyframe_delete(self):
1030
- """ """
1547
+ def keyframe_delete(self) -> bool:
1548
+ """Remove a keyframe from this properties fcurve.
1549
+
1550
+ :return: Success of keyframe deletion.
1551
+ :rtype: bool
1552
+ """
1031
1553
  ...
1032
1554
 
1033
- def keyframe_insert(self):
1034
- """ """
1555
+ def keyframe_insert(self) -> bool:
1556
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1557
+
1558
+ :return: Success of keyframe insertion.
1559
+ :rtype: bool
1560
+ """
1035
1561
  ...
1036
1562
 
1037
1563
  def keys(self):
1038
- """ """
1564
+ """Returns the keys of this objects custom properties (matches Python's
1565
+ dictionary function of the same name).
1566
+
1567
+ :return: custom property keys.
1568
+ """
1039
1569
  ...
1040
1570
 
1041
- def path_from_id(self):
1042
- """ """
1571
+ def path_from_id(self) -> str:
1572
+ """Returns the data path from the ID to this object (string).
1573
+
1574
+ :return: The path from `bpy.types.bpy_struct.id_data`
1575
+ to this struct and property (when given).
1576
+ :rtype: str
1577
+ """
1043
1578
  ...
1044
1579
 
1045
1580
  def path_resolve(self):
1046
- """ """
1581
+ """Returns the property from the path, raise an exception when not found."""
1047
1582
  ...
1048
1583
 
1049
1584
  def poll(self, context):
@@ -1054,37 +1589,53 @@ class RENDER_PT_encoding_audio(
1054
1589
  ...
1055
1590
 
1056
1591
  def pop(self):
1057
- """ """
1592
+ """Remove and return the value of the custom property assigned to key or default
1593
+ when not found (matches Python's dictionary function of the same name).
1594
+
1595
+ """
1058
1596
  ...
1059
1597
 
1060
1598
  def prepend(self, draw_func):
1061
- """
1599
+ """Prepend a draw function to this menu, takes the same arguments as
1600
+ the menus draw function
1062
1601
 
1063
- :param draw_func:
1602
+ :param draw_func:
1064
1603
  """
1065
1604
  ...
1066
1605
 
1067
- def property_overridable_library_set(self):
1068
- """ """
1606
+ def property_overridable_library_set(self) -> bool:
1607
+ """Define a property as overridable or not (only for custom properties!).
1608
+
1609
+ :return: True when the overridable status of the property was successfully set.
1610
+ :rtype: bool
1611
+ """
1069
1612
  ...
1070
1613
 
1071
1614
  def property_unset(self):
1072
- """ """
1615
+ """Unset a property, will use default value afterward."""
1073
1616
  ...
1074
1617
 
1075
1618
  def remove(self, draw_func):
1076
- """
1619
+ """Remove a draw function that has been added to this menu
1077
1620
 
1078
1621
  :param draw_func:
1079
1622
  """
1080
1623
  ...
1081
1624
 
1082
1625
  def type_recast(self):
1083
- """ """
1626
+ """Return a new instance, this is needed because types
1627
+ such as textures can be changed at runtime.
1628
+
1629
+ :return: a new instance of this object with the type initialized again.
1630
+ """
1084
1631
  ...
1085
1632
 
1086
1633
  def values(self):
1087
- """ """
1634
+ """Returns the values of this objects custom properties (matches Python's
1635
+ dictionary function of the same name).
1636
+
1637
+ :return: custom property values.
1638
+ """
1088
1639
  ...
1089
1640
 
1090
1641
  class RENDER_PT_encoding_video(
@@ -1117,22 +1668,35 @@ class RENDER_PT_encoding_video(
1117
1668
  """ """
1118
1669
 
1119
1670
  def append(self, draw_func):
1120
- """
1671
+ """Append a draw function to this menu,
1672
+ takes the same arguments as the menus draw function
1121
1673
 
1122
- :param draw_func:
1674
+ :param draw_func:
1123
1675
  """
1124
1676
  ...
1125
1677
 
1126
- def as_pointer(self):
1127
- """ """
1678
+ def as_pointer(self) -> int:
1679
+ """Returns the memory address which holds a pointer to Blender's internal data
1680
+
1681
+ :return: int (memory address).
1682
+ :rtype: int
1683
+ """
1128
1684
  ...
1129
1685
 
1130
- def bl_rna_get_subclass(self):
1131
- """ """
1686
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1687
+ """
1688
+
1689
+ :return: The RNA type or default when not found.
1690
+ :rtype: bpy.types.Struct
1691
+ """
1132
1692
  ...
1133
1693
 
1134
- def bl_rna_get_subclass_py(self):
1135
- """ """
1694
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1695
+ """
1696
+
1697
+ :return: The class or default when not found.
1698
+ :rtype: typing.Any
1699
+ """
1136
1700
  ...
1137
1701
 
1138
1702
  def draw(self, context):
@@ -1143,78 +1707,135 @@ class RENDER_PT_encoding_video(
1143
1707
  ...
1144
1708
 
1145
1709
  def draw_vcodec(self, context):
1146
- """
1710
+ """Video codec options.
1147
1711
 
1148
1712
  :param context:
1149
1713
  """
1150
1714
  ...
1151
1715
 
1152
- def driver_add(self):
1153
- """ """
1716
+ def driver_add(self) -> bpy.types.FCurve:
1717
+ """Adds driver(s) to the given property
1718
+
1719
+ :return: The driver(s) added.
1720
+ :rtype: bpy.types.FCurve
1721
+ """
1154
1722
  ...
1155
1723
 
1156
- def driver_remove(self):
1157
- """ """
1724
+ def driver_remove(self) -> bool:
1725
+ """Remove driver(s) from the given property
1726
+
1727
+ :return: Success of driver removal.
1728
+ :rtype: bool
1729
+ """
1158
1730
  ...
1159
1731
 
1160
1732
  def get(self):
1161
- """ """
1162
- ...
1733
+ """Returns the value of the custom property assigned to key or default
1734
+ when not found (matches Python's dictionary function of the same name).
1735
+
1736
+ """
1737
+ ...
1163
1738
 
1164
1739
  def id_properties_clear(self):
1165
- """ """
1740
+ """
1741
+
1742
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1743
+ """
1166
1744
  ...
1167
1745
 
1168
1746
  def id_properties_ensure(self):
1169
- """ """
1747
+ """
1748
+
1749
+ :return: the parent group for an RNA struct's custom IDProperties.
1750
+ """
1170
1751
  ...
1171
1752
 
1172
1753
  def id_properties_ui(self):
1173
- """ """
1754
+ """
1755
+
1756
+ :return: Return an object used to manage an IDProperty's UI data.
1757
+ """
1174
1758
  ...
1175
1759
 
1176
1760
  def is_extended(self):
1177
1761
  """ """
1178
1762
  ...
1179
1763
 
1180
- def is_property_hidden(self):
1181
- """ """
1764
+ def is_property_hidden(self) -> bool:
1765
+ """Check if a property is hidden.
1766
+
1767
+ :return: True when the property is hidden.
1768
+ :rtype: bool
1769
+ """
1182
1770
  ...
1183
1771
 
1184
- def is_property_overridable_library(self):
1185
- """ """
1772
+ def is_property_overridable_library(self) -> bool:
1773
+ """Check if a property is overridable.
1774
+
1775
+ :return: True when the property is overridable.
1776
+ :rtype: bool
1777
+ """
1186
1778
  ...
1187
1779
 
1188
- def is_property_readonly(self):
1189
- """ """
1780
+ def is_property_readonly(self) -> bool:
1781
+ """Check if a property is readonly.
1782
+
1783
+ :return: True when the property is readonly (not writable).
1784
+ :rtype: bool
1785
+ """
1190
1786
  ...
1191
1787
 
1192
- def is_property_set(self):
1193
- """ """
1788
+ def is_property_set(self) -> bool:
1789
+ """Check if a property is set, use for testing operator properties.
1790
+
1791
+ :return: True when the property has been set.
1792
+ :rtype: bool
1793
+ """
1194
1794
  ...
1195
1795
 
1196
1796
  def items(self):
1197
- """ """
1797
+ """Returns the items of this objects custom properties (matches Python's
1798
+ dictionary function of the same name).
1799
+
1800
+ :return: custom property key, value pairs.
1801
+ """
1198
1802
  ...
1199
1803
 
1200
- def keyframe_delete(self):
1201
- """ """
1804
+ def keyframe_delete(self) -> bool:
1805
+ """Remove a keyframe from this properties fcurve.
1806
+
1807
+ :return: Success of keyframe deletion.
1808
+ :rtype: bool
1809
+ """
1202
1810
  ...
1203
1811
 
1204
- def keyframe_insert(self):
1205
- """ """
1812
+ def keyframe_insert(self) -> bool:
1813
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1814
+
1815
+ :return: Success of keyframe insertion.
1816
+ :rtype: bool
1817
+ """
1206
1818
  ...
1207
1819
 
1208
1820
  def keys(self):
1209
- """ """
1821
+ """Returns the keys of this objects custom properties (matches Python's
1822
+ dictionary function of the same name).
1823
+
1824
+ :return: custom property keys.
1825
+ """
1210
1826
  ...
1211
1827
 
1212
- def path_from_id(self):
1213
- """ """
1828
+ def path_from_id(self) -> str:
1829
+ """Returns the data path from the ID to this object (string).
1830
+
1831
+ :return: The path from `bpy.types.bpy_struct.id_data`
1832
+ to this struct and property (when given).
1833
+ :rtype: str
1834
+ """
1214
1835
  ...
1215
1836
 
1216
1837
  def path_resolve(self):
1217
- """ """
1838
+ """Returns the property from the path, raise an exception when not found."""
1218
1839
  ...
1219
1840
 
1220
1841
  def poll(self, context):
@@ -1225,37 +1846,53 @@ class RENDER_PT_encoding_video(
1225
1846
  ...
1226
1847
 
1227
1848
  def pop(self):
1228
- """ """
1849
+ """Remove and return the value of the custom property assigned to key or default
1850
+ when not found (matches Python's dictionary function of the same name).
1851
+
1852
+ """
1229
1853
  ...
1230
1854
 
1231
1855
  def prepend(self, draw_func):
1232
- """
1856
+ """Prepend a draw function to this menu, takes the same arguments as
1857
+ the menus draw function
1233
1858
 
1234
- :param draw_func:
1859
+ :param draw_func:
1235
1860
  """
1236
1861
  ...
1237
1862
 
1238
- def property_overridable_library_set(self):
1239
- """ """
1863
+ def property_overridable_library_set(self) -> bool:
1864
+ """Define a property as overridable or not (only for custom properties!).
1865
+
1866
+ :return: True when the overridable status of the property was successfully set.
1867
+ :rtype: bool
1868
+ """
1240
1869
  ...
1241
1870
 
1242
1871
  def property_unset(self):
1243
- """ """
1872
+ """Unset a property, will use default value afterward."""
1244
1873
  ...
1245
1874
 
1246
1875
  def remove(self, draw_func):
1247
- """
1876
+ """Remove a draw function that has been added to this menu
1248
1877
 
1249
1878
  :param draw_func:
1250
1879
  """
1251
1880
  ...
1252
1881
 
1253
1882
  def type_recast(self):
1254
- """ """
1883
+ """Return a new instance, this is needed because types
1884
+ such as textures can be changed at runtime.
1885
+
1886
+ :return: a new instance of this object with the type initialized again.
1887
+ """
1255
1888
  ...
1256
1889
 
1257
1890
  def values(self):
1258
- """ """
1891
+ """Returns the values of this objects custom properties (matches Python's
1892
+ dictionary function of the same name).
1893
+
1894
+ :return: custom property values.
1895
+ """
1259
1896
  ...
1260
1897
 
1261
1898
  class RENDER_PT_format(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._GenericUI):
@@ -1283,22 +1920,35 @@ class RENDER_PT_format(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._Gen
1283
1920
  """ """
1284
1921
 
1285
1922
  def append(self, draw_func):
1286
- """
1923
+ """Append a draw function to this menu,
1924
+ takes the same arguments as the menus draw function
1287
1925
 
1288
- :param draw_func:
1926
+ :param draw_func:
1289
1927
  """
1290
1928
  ...
1291
1929
 
1292
- def as_pointer(self):
1293
- """ """
1930
+ def as_pointer(self) -> int:
1931
+ """Returns the memory address which holds a pointer to Blender's internal data
1932
+
1933
+ :return: int (memory address).
1934
+ :rtype: int
1935
+ """
1294
1936
  ...
1295
1937
 
1296
- def bl_rna_get_subclass(self):
1297
- """ """
1938
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1939
+ """
1940
+
1941
+ :return: The RNA type or default when not found.
1942
+ :rtype: bpy.types.Struct
1943
+ """
1298
1944
  ...
1299
1945
 
1300
- def bl_rna_get_subclass_py(self):
1301
- """ """
1946
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1947
+ """
1948
+
1949
+ :return: The class or default when not found.
1950
+ :rtype: typing.Any
1951
+ """
1302
1952
  ...
1303
1953
 
1304
1954
  def draw(self, context):
@@ -1323,72 +1973,129 @@ class RENDER_PT_format(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._Gen
1323
1973
  """
1324
1974
  ...
1325
1975
 
1326
- def driver_add(self):
1327
- """ """
1976
+ def driver_add(self) -> bpy.types.FCurve:
1977
+ """Adds driver(s) to the given property
1978
+
1979
+ :return: The driver(s) added.
1980
+ :rtype: bpy.types.FCurve
1981
+ """
1328
1982
  ...
1329
1983
 
1330
- def driver_remove(self):
1331
- """ """
1984
+ def driver_remove(self) -> bool:
1985
+ """Remove driver(s) from the given property
1986
+
1987
+ :return: Success of driver removal.
1988
+ :rtype: bool
1989
+ """
1332
1990
  ...
1333
1991
 
1334
1992
  def get(self):
1335
- """ """
1993
+ """Returns the value of the custom property assigned to key or default
1994
+ when not found (matches Python's dictionary function of the same name).
1995
+
1996
+ """
1336
1997
  ...
1337
1998
 
1338
1999
  def id_properties_clear(self):
1339
- """ """
2000
+ """
2001
+
2002
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2003
+ """
1340
2004
  ...
1341
2005
 
1342
2006
  def id_properties_ensure(self):
1343
- """ """
2007
+ """
2008
+
2009
+ :return: the parent group for an RNA struct's custom IDProperties.
2010
+ """
1344
2011
  ...
1345
2012
 
1346
2013
  def id_properties_ui(self):
1347
- """ """
2014
+ """
2015
+
2016
+ :return: Return an object used to manage an IDProperty's UI data.
2017
+ """
1348
2018
  ...
1349
2019
 
1350
2020
  def is_extended(self):
1351
2021
  """ """
1352
2022
  ...
1353
2023
 
1354
- def is_property_hidden(self):
1355
- """ """
2024
+ def is_property_hidden(self) -> bool:
2025
+ """Check if a property is hidden.
2026
+
2027
+ :return: True when the property is hidden.
2028
+ :rtype: bool
2029
+ """
1356
2030
  ...
1357
2031
 
1358
- def is_property_overridable_library(self):
1359
- """ """
2032
+ def is_property_overridable_library(self) -> bool:
2033
+ """Check if a property is overridable.
2034
+
2035
+ :return: True when the property is overridable.
2036
+ :rtype: bool
2037
+ """
1360
2038
  ...
1361
2039
 
1362
- def is_property_readonly(self):
1363
- """ """
2040
+ def is_property_readonly(self) -> bool:
2041
+ """Check if a property is readonly.
2042
+
2043
+ :return: True when the property is readonly (not writable).
2044
+ :rtype: bool
2045
+ """
1364
2046
  ...
1365
2047
 
1366
- def is_property_set(self):
1367
- """ """
2048
+ def is_property_set(self) -> bool:
2049
+ """Check if a property is set, use for testing operator properties.
2050
+
2051
+ :return: True when the property has been set.
2052
+ :rtype: bool
2053
+ """
1368
2054
  ...
1369
2055
 
1370
2056
  def items(self):
1371
- """ """
2057
+ """Returns the items of this objects custom properties (matches Python's
2058
+ dictionary function of the same name).
2059
+
2060
+ :return: custom property key, value pairs.
2061
+ """
1372
2062
  ...
1373
2063
 
1374
- def keyframe_delete(self):
1375
- """ """
2064
+ def keyframe_delete(self) -> bool:
2065
+ """Remove a keyframe from this properties fcurve.
2066
+
2067
+ :return: Success of keyframe deletion.
2068
+ :rtype: bool
2069
+ """
1376
2070
  ...
1377
2071
 
1378
- def keyframe_insert(self):
1379
- """ """
2072
+ def keyframe_insert(self) -> bool:
2073
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2074
+
2075
+ :return: Success of keyframe insertion.
2076
+ :rtype: bool
2077
+ """
1380
2078
  ...
1381
2079
 
1382
2080
  def keys(self):
1383
- """ """
2081
+ """Returns the keys of this objects custom properties (matches Python's
2082
+ dictionary function of the same name).
2083
+
2084
+ :return: custom property keys.
2085
+ """
1384
2086
  ...
1385
2087
 
1386
- def path_from_id(self):
1387
- """ """
2088
+ def path_from_id(self) -> str:
2089
+ """Returns the data path from the ID to this object (string).
2090
+
2091
+ :return: The path from `bpy.types.bpy_struct.id_data`
2092
+ to this struct and property (when given).
2093
+ :rtype: str
2094
+ """
1388
2095
  ...
1389
2096
 
1390
2097
  def path_resolve(self):
1391
- """ """
2098
+ """Returns the property from the path, raise an exception when not found."""
1392
2099
  ...
1393
2100
 
1394
2101
  def poll(self, context):
@@ -1399,37 +2106,53 @@ class RENDER_PT_format(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._Gen
1399
2106
  ...
1400
2107
 
1401
2108
  def pop(self):
1402
- """ """
2109
+ """Remove and return the value of the custom property assigned to key or default
2110
+ when not found (matches Python's dictionary function of the same name).
2111
+
2112
+ """
1403
2113
  ...
1404
2114
 
1405
2115
  def prepend(self, draw_func):
1406
- """
2116
+ """Prepend a draw function to this menu, takes the same arguments as
2117
+ the menus draw function
1407
2118
 
1408
- :param draw_func:
2119
+ :param draw_func:
1409
2120
  """
1410
2121
  ...
1411
2122
 
1412
- def property_overridable_library_set(self):
1413
- """ """
2123
+ def property_overridable_library_set(self) -> bool:
2124
+ """Define a property as overridable or not (only for custom properties!).
2125
+
2126
+ :return: True when the overridable status of the property was successfully set.
2127
+ :rtype: bool
2128
+ """
1414
2129
  ...
1415
2130
 
1416
2131
  def property_unset(self):
1417
- """ """
2132
+ """Unset a property, will use default value afterward."""
1418
2133
  ...
1419
2134
 
1420
2135
  def remove(self, draw_func):
1421
- """
2136
+ """Remove a draw function that has been added to this menu
1422
2137
 
1423
2138
  :param draw_func:
1424
2139
  """
1425
2140
  ...
1426
2141
 
1427
2142
  def type_recast(self):
1428
- """ """
2143
+ """Return a new instance, this is needed because types
2144
+ such as textures can be changed at runtime.
2145
+
2146
+ :return: a new instance of this object with the type initialized again.
2147
+ """
1429
2148
  ...
1430
2149
 
1431
2150
  def values(self):
1432
- """ """
2151
+ """Returns the values of this objects custom properties (matches Python's
2152
+ dictionary function of the same name).
2153
+
2154
+ :return: custom property values.
2155
+ """
1433
2156
  ...
1434
2157
 
1435
2158
  class RENDER_PT_frame_range(
@@ -1459,22 +2182,35 @@ class RENDER_PT_frame_range(
1459
2182
  """ """
1460
2183
 
1461
2184
  def append(self, draw_func):
1462
- """
2185
+ """Append a draw function to this menu,
2186
+ takes the same arguments as the menus draw function
1463
2187
 
1464
- :param draw_func:
2188
+ :param draw_func:
1465
2189
  """
1466
2190
  ...
1467
2191
 
1468
- def as_pointer(self):
1469
- """ """
2192
+ def as_pointer(self) -> int:
2193
+ """Returns the memory address which holds a pointer to Blender's internal data
2194
+
2195
+ :return: int (memory address).
2196
+ :rtype: int
2197
+ """
1470
2198
  ...
1471
2199
 
1472
- def bl_rna_get_subclass(self):
1473
- """ """
2200
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2201
+ """
2202
+
2203
+ :return: The RNA type or default when not found.
2204
+ :rtype: bpy.types.Struct
2205
+ """
1474
2206
  ...
1475
2207
 
1476
- def bl_rna_get_subclass_py(self):
1477
- """ """
2208
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2209
+ """
2210
+
2211
+ :return: The class or default when not found.
2212
+ :rtype: typing.Any
2213
+ """
1478
2214
  ...
1479
2215
 
1480
2216
  def draw(self, context):
@@ -1484,72 +2220,129 @@ class RENDER_PT_frame_range(
1484
2220
  """
1485
2221
  ...
1486
2222
 
1487
- def driver_add(self):
1488
- """ """
2223
+ def driver_add(self) -> bpy.types.FCurve:
2224
+ """Adds driver(s) to the given property
2225
+
2226
+ :return: The driver(s) added.
2227
+ :rtype: bpy.types.FCurve
2228
+ """
1489
2229
  ...
1490
2230
 
1491
- def driver_remove(self):
1492
- """ """
2231
+ def driver_remove(self) -> bool:
2232
+ """Remove driver(s) from the given property
2233
+
2234
+ :return: Success of driver removal.
2235
+ :rtype: bool
2236
+ """
1493
2237
  ...
1494
2238
 
1495
2239
  def get(self):
1496
- """ """
2240
+ """Returns the value of the custom property assigned to key or default
2241
+ when not found (matches Python's dictionary function of the same name).
2242
+
2243
+ """
1497
2244
  ...
1498
2245
 
1499
2246
  def id_properties_clear(self):
1500
- """ """
2247
+ """
2248
+
2249
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2250
+ """
1501
2251
  ...
1502
2252
 
1503
2253
  def id_properties_ensure(self):
1504
- """ """
2254
+ """
2255
+
2256
+ :return: the parent group for an RNA struct's custom IDProperties.
2257
+ """
1505
2258
  ...
1506
2259
 
1507
2260
  def id_properties_ui(self):
1508
- """ """
2261
+ """
2262
+
2263
+ :return: Return an object used to manage an IDProperty's UI data.
2264
+ """
1509
2265
  ...
1510
2266
 
1511
2267
  def is_extended(self):
1512
2268
  """ """
1513
2269
  ...
1514
2270
 
1515
- def is_property_hidden(self):
1516
- """ """
2271
+ def is_property_hidden(self) -> bool:
2272
+ """Check if a property is hidden.
2273
+
2274
+ :return: True when the property is hidden.
2275
+ :rtype: bool
2276
+ """
1517
2277
  ...
1518
2278
 
1519
- def is_property_overridable_library(self):
1520
- """ """
2279
+ def is_property_overridable_library(self) -> bool:
2280
+ """Check if a property is overridable.
2281
+
2282
+ :return: True when the property is overridable.
2283
+ :rtype: bool
2284
+ """
1521
2285
  ...
1522
2286
 
1523
- def is_property_readonly(self):
1524
- """ """
2287
+ def is_property_readonly(self) -> bool:
2288
+ """Check if a property is readonly.
2289
+
2290
+ :return: True when the property is readonly (not writable).
2291
+ :rtype: bool
2292
+ """
1525
2293
  ...
1526
2294
 
1527
- def is_property_set(self):
1528
- """ """
2295
+ def is_property_set(self) -> bool:
2296
+ """Check if a property is set, use for testing operator properties.
2297
+
2298
+ :return: True when the property has been set.
2299
+ :rtype: bool
2300
+ """
1529
2301
  ...
1530
2302
 
1531
2303
  def items(self):
1532
- """ """
2304
+ """Returns the items of this objects custom properties (matches Python's
2305
+ dictionary function of the same name).
2306
+
2307
+ :return: custom property key, value pairs.
2308
+ """
1533
2309
  ...
1534
2310
 
1535
- def keyframe_delete(self):
1536
- """ """
2311
+ def keyframe_delete(self) -> bool:
2312
+ """Remove a keyframe from this properties fcurve.
2313
+
2314
+ :return: Success of keyframe deletion.
2315
+ :rtype: bool
2316
+ """
1537
2317
  ...
1538
2318
 
1539
- def keyframe_insert(self):
1540
- """ """
2319
+ def keyframe_insert(self) -> bool:
2320
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2321
+
2322
+ :return: Success of keyframe insertion.
2323
+ :rtype: bool
2324
+ """
1541
2325
  ...
1542
2326
 
1543
2327
  def keys(self):
1544
- """ """
2328
+ """Returns the keys of this objects custom properties (matches Python's
2329
+ dictionary function of the same name).
2330
+
2331
+ :return: custom property keys.
2332
+ """
1545
2333
  ...
1546
2334
 
1547
- def path_from_id(self):
1548
- """ """
2335
+ def path_from_id(self) -> str:
2336
+ """Returns the data path from the ID to this object (string).
2337
+
2338
+ :return: The path from `bpy.types.bpy_struct.id_data`
2339
+ to this struct and property (when given).
2340
+ :rtype: str
2341
+ """
1549
2342
  ...
1550
2343
 
1551
2344
  def path_resolve(self):
1552
- """ """
2345
+ """Returns the property from the path, raise an exception when not found."""
1553
2346
  ...
1554
2347
 
1555
2348
  def poll(self, context):
@@ -1560,37 +2353,53 @@ class RENDER_PT_frame_range(
1560
2353
  ...
1561
2354
 
1562
2355
  def pop(self):
1563
- """ """
2356
+ """Remove and return the value of the custom property assigned to key or default
2357
+ when not found (matches Python's dictionary function of the same name).
2358
+
2359
+ """
1564
2360
  ...
1565
2361
 
1566
2362
  def prepend(self, draw_func):
1567
- """
2363
+ """Prepend a draw function to this menu, takes the same arguments as
2364
+ the menus draw function
1568
2365
 
1569
- :param draw_func:
2366
+ :param draw_func:
1570
2367
  """
1571
2368
  ...
1572
2369
 
1573
- def property_overridable_library_set(self):
1574
- """ """
2370
+ def property_overridable_library_set(self) -> bool:
2371
+ """Define a property as overridable or not (only for custom properties!).
2372
+
2373
+ :return: True when the overridable status of the property was successfully set.
2374
+ :rtype: bool
2375
+ """
1575
2376
  ...
1576
2377
 
1577
2378
  def property_unset(self):
1578
- """ """
2379
+ """Unset a property, will use default value afterward."""
1579
2380
  ...
1580
2381
 
1581
2382
  def remove(self, draw_func):
1582
- """
2383
+ """Remove a draw function that has been added to this menu
1583
2384
 
1584
2385
  :param draw_func:
1585
2386
  """
1586
2387
  ...
1587
2388
 
1588
2389
  def type_recast(self):
1589
- """ """
2390
+ """Return a new instance, this is needed because types
2391
+ such as textures can be changed at runtime.
2392
+
2393
+ :return: a new instance of this object with the type initialized again.
2394
+ """
1590
2395
  ...
1591
2396
 
1592
2397
  def values(self):
1593
- """ """
2398
+ """Returns the values of this objects custom properties (matches Python's
2399
+ dictionary function of the same name).
2400
+
2401
+ :return: custom property values.
2402
+ """
1594
2403
  ...
1595
2404
 
1596
2405
  class RENDER_PT_output(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._GenericUI):
@@ -1618,22 +2427,35 @@ class RENDER_PT_output(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._Gen
1618
2427
  """ """
1619
2428
 
1620
2429
  def append(self, draw_func):
1621
- """
2430
+ """Append a draw function to this menu,
2431
+ takes the same arguments as the menus draw function
1622
2432
 
1623
- :param draw_func:
2433
+ :param draw_func:
1624
2434
  """
1625
2435
  ...
1626
2436
 
1627
- def as_pointer(self):
1628
- """ """
2437
+ def as_pointer(self) -> int:
2438
+ """Returns the memory address which holds a pointer to Blender's internal data
2439
+
2440
+ :return: int (memory address).
2441
+ :rtype: int
2442
+ """
1629
2443
  ...
1630
2444
 
1631
- def bl_rna_get_subclass(self):
1632
- """ """
2445
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2446
+ """
2447
+
2448
+ :return: The RNA type or default when not found.
2449
+ :rtype: bpy.types.Struct
2450
+ """
1633
2451
  ...
1634
2452
 
1635
- def bl_rna_get_subclass_py(self):
1636
- """ """
2453
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2454
+ """
2455
+
2456
+ :return: The class or default when not found.
2457
+ :rtype: typing.Any
2458
+ """
1637
2459
  ...
1638
2460
 
1639
2461
  def draw(self, context):
@@ -1643,72 +2465,129 @@ class RENDER_PT_output(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._Gen
1643
2465
  """
1644
2466
  ...
1645
2467
 
1646
- def driver_add(self):
1647
- """ """
2468
+ def driver_add(self) -> bpy.types.FCurve:
2469
+ """Adds driver(s) to the given property
2470
+
2471
+ :return: The driver(s) added.
2472
+ :rtype: bpy.types.FCurve
2473
+ """
1648
2474
  ...
1649
2475
 
1650
- def driver_remove(self):
1651
- """ """
2476
+ def driver_remove(self) -> bool:
2477
+ """Remove driver(s) from the given property
2478
+
2479
+ :return: Success of driver removal.
2480
+ :rtype: bool
2481
+ """
1652
2482
  ...
1653
2483
 
1654
2484
  def get(self):
1655
- """ """
2485
+ """Returns the value of the custom property assigned to key or default
2486
+ when not found (matches Python's dictionary function of the same name).
2487
+
2488
+ """
1656
2489
  ...
1657
2490
 
1658
2491
  def id_properties_clear(self):
1659
- """ """
2492
+ """
2493
+
2494
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2495
+ """
1660
2496
  ...
1661
2497
 
1662
2498
  def id_properties_ensure(self):
1663
- """ """
2499
+ """
2500
+
2501
+ :return: the parent group for an RNA struct's custom IDProperties.
2502
+ """
1664
2503
  ...
1665
2504
 
1666
2505
  def id_properties_ui(self):
1667
- """ """
2506
+ """
2507
+
2508
+ :return: Return an object used to manage an IDProperty's UI data.
2509
+ """
1668
2510
  ...
1669
2511
 
1670
2512
  def is_extended(self):
1671
2513
  """ """
1672
2514
  ...
1673
2515
 
1674
- def is_property_hidden(self):
1675
- """ """
2516
+ def is_property_hidden(self) -> bool:
2517
+ """Check if a property is hidden.
2518
+
2519
+ :return: True when the property is hidden.
2520
+ :rtype: bool
2521
+ """
1676
2522
  ...
1677
2523
 
1678
- def is_property_overridable_library(self):
1679
- """ """
2524
+ def is_property_overridable_library(self) -> bool:
2525
+ """Check if a property is overridable.
2526
+
2527
+ :return: True when the property is overridable.
2528
+ :rtype: bool
2529
+ """
1680
2530
  ...
1681
2531
 
1682
- def is_property_readonly(self):
1683
- """ """
2532
+ def is_property_readonly(self) -> bool:
2533
+ """Check if a property is readonly.
2534
+
2535
+ :return: True when the property is readonly (not writable).
2536
+ :rtype: bool
2537
+ """
1684
2538
  ...
1685
2539
 
1686
- def is_property_set(self):
1687
- """ """
2540
+ def is_property_set(self) -> bool:
2541
+ """Check if a property is set, use for testing operator properties.
2542
+
2543
+ :return: True when the property has been set.
2544
+ :rtype: bool
2545
+ """
1688
2546
  ...
1689
2547
 
1690
2548
  def items(self):
1691
- """ """
2549
+ """Returns the items of this objects custom properties (matches Python's
2550
+ dictionary function of the same name).
2551
+
2552
+ :return: custom property key, value pairs.
2553
+ """
1692
2554
  ...
1693
2555
 
1694
- def keyframe_delete(self):
1695
- """ """
2556
+ def keyframe_delete(self) -> bool:
2557
+ """Remove a keyframe from this properties fcurve.
2558
+
2559
+ :return: Success of keyframe deletion.
2560
+ :rtype: bool
2561
+ """
1696
2562
  ...
1697
2563
 
1698
- def keyframe_insert(self):
1699
- """ """
2564
+ def keyframe_insert(self) -> bool:
2565
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2566
+
2567
+ :return: Success of keyframe insertion.
2568
+ :rtype: bool
2569
+ """
1700
2570
  ...
1701
2571
 
1702
2572
  def keys(self):
1703
- """ """
2573
+ """Returns the keys of this objects custom properties (matches Python's
2574
+ dictionary function of the same name).
2575
+
2576
+ :return: custom property keys.
2577
+ """
1704
2578
  ...
1705
2579
 
1706
- def path_from_id(self):
1707
- """ """
2580
+ def path_from_id(self) -> str:
2581
+ """Returns the data path from the ID to this object (string).
2582
+
2583
+ :return: The path from `bpy.types.bpy_struct.id_data`
2584
+ to this struct and property (when given).
2585
+ :rtype: str
2586
+ """
1708
2587
  ...
1709
2588
 
1710
2589
  def path_resolve(self):
1711
- """ """
2590
+ """Returns the property from the path, raise an exception when not found."""
1712
2591
  ...
1713
2592
 
1714
2593
  def poll(self, context):
@@ -1719,37 +2598,53 @@ class RENDER_PT_output(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._Gen
1719
2598
  ...
1720
2599
 
1721
2600
  def pop(self):
1722
- """ """
2601
+ """Remove and return the value of the custom property assigned to key or default
2602
+ when not found (matches Python's dictionary function of the same name).
2603
+
2604
+ """
1723
2605
  ...
1724
2606
 
1725
2607
  def prepend(self, draw_func):
1726
- """
2608
+ """Prepend a draw function to this menu, takes the same arguments as
2609
+ the menus draw function
1727
2610
 
1728
- :param draw_func:
2611
+ :param draw_func:
1729
2612
  """
1730
2613
  ...
1731
2614
 
1732
- def property_overridable_library_set(self):
1733
- """ """
2615
+ def property_overridable_library_set(self) -> bool:
2616
+ """Define a property as overridable or not (only for custom properties!).
2617
+
2618
+ :return: True when the overridable status of the property was successfully set.
2619
+ :rtype: bool
2620
+ """
1734
2621
  ...
1735
2622
 
1736
2623
  def property_unset(self):
1737
- """ """
2624
+ """Unset a property, will use default value afterward."""
1738
2625
  ...
1739
2626
 
1740
2627
  def remove(self, draw_func):
1741
- """
2628
+ """Remove a draw function that has been added to this menu
1742
2629
 
1743
2630
  :param draw_func:
1744
2631
  """
1745
2632
  ...
1746
2633
 
1747
2634
  def type_recast(self):
1748
- """ """
2635
+ """Return a new instance, this is needed because types
2636
+ such as textures can be changed at runtime.
2637
+
2638
+ :return: a new instance of this object with the type initialized again.
2639
+ """
1749
2640
  ...
1750
2641
 
1751
2642
  def values(self):
1752
- """ """
2643
+ """Returns the values of this objects custom properties (matches Python's
2644
+ dictionary function of the same name).
2645
+
2646
+ :return: custom property values.
2647
+ """
1753
2648
  ...
1754
2649
 
1755
2650
  class RENDER_PT_output_color_management(
@@ -1785,22 +2680,35 @@ class RENDER_PT_output_color_management(
1785
2680
  """ """
1786
2681
 
1787
2682
  def append(self, draw_func):
1788
- """
2683
+ """Append a draw function to this menu,
2684
+ takes the same arguments as the menus draw function
1789
2685
 
1790
- :param draw_func:
2686
+ :param draw_func:
1791
2687
  """
1792
2688
  ...
1793
2689
 
1794
- def as_pointer(self):
1795
- """ """
2690
+ def as_pointer(self) -> int:
2691
+ """Returns the memory address which holds a pointer to Blender's internal data
2692
+
2693
+ :return: int (memory address).
2694
+ :rtype: int
2695
+ """
1796
2696
  ...
1797
2697
 
1798
- def bl_rna_get_subclass(self):
1799
- """ """
2698
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2699
+ """
2700
+
2701
+ :return: The RNA type or default when not found.
2702
+ :rtype: bpy.types.Struct
2703
+ """
1800
2704
  ...
1801
2705
 
1802
- def bl_rna_get_subclass_py(self):
1803
- """ """
2706
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2707
+ """
2708
+
2709
+ :return: The class or default when not found.
2710
+ :rtype: typing.Any
2711
+ """
1804
2712
  ...
1805
2713
 
1806
2714
  def draw(self, context):
@@ -1810,72 +2718,129 @@ class RENDER_PT_output_color_management(
1810
2718
  """
1811
2719
  ...
1812
2720
 
1813
- def driver_add(self):
1814
- """ """
2721
+ def driver_add(self) -> bpy.types.FCurve:
2722
+ """Adds driver(s) to the given property
2723
+
2724
+ :return: The driver(s) added.
2725
+ :rtype: bpy.types.FCurve
2726
+ """
1815
2727
  ...
1816
2728
 
1817
- def driver_remove(self):
1818
- """ """
2729
+ def driver_remove(self) -> bool:
2730
+ """Remove driver(s) from the given property
2731
+
2732
+ :return: Success of driver removal.
2733
+ :rtype: bool
2734
+ """
1819
2735
  ...
1820
2736
 
1821
2737
  def get(self):
1822
- """ """
2738
+ """Returns the value of the custom property assigned to key or default
2739
+ when not found (matches Python's dictionary function of the same name).
2740
+
2741
+ """
1823
2742
  ...
1824
2743
 
1825
2744
  def id_properties_clear(self):
1826
- """ """
2745
+ """
2746
+
2747
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2748
+ """
1827
2749
  ...
1828
2750
 
1829
2751
  def id_properties_ensure(self):
1830
- """ """
2752
+ """
2753
+
2754
+ :return: the parent group for an RNA struct's custom IDProperties.
2755
+ """
1831
2756
  ...
1832
2757
 
1833
2758
  def id_properties_ui(self):
1834
- """ """
2759
+ """
2760
+
2761
+ :return: Return an object used to manage an IDProperty's UI data.
2762
+ """
1835
2763
  ...
1836
2764
 
1837
2765
  def is_extended(self):
1838
2766
  """ """
1839
2767
  ...
1840
2768
 
1841
- def is_property_hidden(self):
1842
- """ """
2769
+ def is_property_hidden(self) -> bool:
2770
+ """Check if a property is hidden.
2771
+
2772
+ :return: True when the property is hidden.
2773
+ :rtype: bool
2774
+ """
1843
2775
  ...
1844
2776
 
1845
- def is_property_overridable_library(self):
1846
- """ """
2777
+ def is_property_overridable_library(self) -> bool:
2778
+ """Check if a property is overridable.
2779
+
2780
+ :return: True when the property is overridable.
2781
+ :rtype: bool
2782
+ """
1847
2783
  ...
1848
2784
 
1849
- def is_property_readonly(self):
1850
- """ """
2785
+ def is_property_readonly(self) -> bool:
2786
+ """Check if a property is readonly.
2787
+
2788
+ :return: True when the property is readonly (not writable).
2789
+ :rtype: bool
2790
+ """
1851
2791
  ...
1852
2792
 
1853
- def is_property_set(self):
1854
- """ """
2793
+ def is_property_set(self) -> bool:
2794
+ """Check if a property is set, use for testing operator properties.
2795
+
2796
+ :return: True when the property has been set.
2797
+ :rtype: bool
2798
+ """
1855
2799
  ...
1856
2800
 
1857
2801
  def items(self):
1858
- """ """
2802
+ """Returns the items of this objects custom properties (matches Python's
2803
+ dictionary function of the same name).
2804
+
2805
+ :return: custom property key, value pairs.
2806
+ """
1859
2807
  ...
1860
2808
 
1861
- def keyframe_delete(self):
1862
- """ """
2809
+ def keyframe_delete(self) -> bool:
2810
+ """Remove a keyframe from this properties fcurve.
2811
+
2812
+ :return: Success of keyframe deletion.
2813
+ :rtype: bool
2814
+ """
1863
2815
  ...
1864
2816
 
1865
- def keyframe_insert(self):
1866
- """ """
2817
+ def keyframe_insert(self) -> bool:
2818
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2819
+
2820
+ :return: Success of keyframe insertion.
2821
+ :rtype: bool
2822
+ """
1867
2823
  ...
1868
2824
 
1869
2825
  def keys(self):
1870
- """ """
2826
+ """Returns the keys of this objects custom properties (matches Python's
2827
+ dictionary function of the same name).
2828
+
2829
+ :return: custom property keys.
2830
+ """
1871
2831
  ...
1872
2832
 
1873
- def path_from_id(self):
1874
- """ """
2833
+ def path_from_id(self) -> str:
2834
+ """Returns the data path from the ID to this object (string).
2835
+
2836
+ :return: The path from `bpy.types.bpy_struct.id_data`
2837
+ to this struct and property (when given).
2838
+ :rtype: str
2839
+ """
1875
2840
  ...
1876
2841
 
1877
2842
  def path_resolve(self):
1878
- """ """
2843
+ """Returns the property from the path, raise an exception when not found."""
1879
2844
  ...
1880
2845
 
1881
2846
  def poll(self, context):
@@ -1886,37 +2851,53 @@ class RENDER_PT_output_color_management(
1886
2851
  ...
1887
2852
 
1888
2853
  def pop(self):
1889
- """ """
2854
+ """Remove and return the value of the custom property assigned to key or default
2855
+ when not found (matches Python's dictionary function of the same name).
2856
+
2857
+ """
1890
2858
  ...
1891
2859
 
1892
2860
  def prepend(self, draw_func):
1893
- """
2861
+ """Prepend a draw function to this menu, takes the same arguments as
2862
+ the menus draw function
1894
2863
 
1895
- :param draw_func:
2864
+ :param draw_func:
1896
2865
  """
1897
2866
  ...
1898
2867
 
1899
- def property_overridable_library_set(self):
1900
- """ """
2868
+ def property_overridable_library_set(self) -> bool:
2869
+ """Define a property as overridable or not (only for custom properties!).
2870
+
2871
+ :return: True when the overridable status of the property was successfully set.
2872
+ :rtype: bool
2873
+ """
1901
2874
  ...
1902
2875
 
1903
2876
  def property_unset(self):
1904
- """ """
2877
+ """Unset a property, will use default value afterward."""
1905
2878
  ...
1906
2879
 
1907
2880
  def remove(self, draw_func):
1908
- """
2881
+ """Remove a draw function that has been added to this menu
1909
2882
 
1910
2883
  :param draw_func:
1911
2884
  """
1912
2885
  ...
1913
2886
 
1914
2887
  def type_recast(self):
1915
- """ """
2888
+ """Return a new instance, this is needed because types
2889
+ such as textures can be changed at runtime.
2890
+
2891
+ :return: a new instance of this object with the type initialized again.
2892
+ """
1916
2893
  ...
1917
2894
 
1918
2895
  def values(self):
1919
- """ """
2896
+ """Returns the values of this objects custom properties (matches Python's
2897
+ dictionary function of the same name).
2898
+
2899
+ :return: custom property values.
2900
+ """
1920
2901
  ...
1921
2902
 
1922
2903
  class RENDER_PT_output_views(
@@ -1949,22 +2930,35 @@ class RENDER_PT_output_views(
1949
2930
  """ """
1950
2931
 
1951
2932
  def append(self, draw_func):
1952
- """
2933
+ """Append a draw function to this menu,
2934
+ takes the same arguments as the menus draw function
1953
2935
 
1954
- :param draw_func:
2936
+ :param draw_func:
1955
2937
  """
1956
2938
  ...
1957
2939
 
1958
- def as_pointer(self):
1959
- """ """
2940
+ def as_pointer(self) -> int:
2941
+ """Returns the memory address which holds a pointer to Blender's internal data
2942
+
2943
+ :return: int (memory address).
2944
+ :rtype: int
2945
+ """
1960
2946
  ...
1961
2947
 
1962
- def bl_rna_get_subclass(self):
1963
- """ """
2948
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2949
+ """
2950
+
2951
+ :return: The RNA type or default when not found.
2952
+ :rtype: bpy.types.Struct
2953
+ """
1964
2954
  ...
1965
2955
 
1966
- def bl_rna_get_subclass_py(self):
1967
- """ """
2956
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2957
+ """
2958
+
2959
+ :return: The class or default when not found.
2960
+ :rtype: typing.Any
2961
+ """
1968
2962
  ...
1969
2963
 
1970
2964
  def draw(self, context):
@@ -1974,72 +2968,129 @@ class RENDER_PT_output_views(
1974
2968
  """
1975
2969
  ...
1976
2970
 
1977
- def driver_add(self):
1978
- """ """
2971
+ def driver_add(self) -> bpy.types.FCurve:
2972
+ """Adds driver(s) to the given property
2973
+
2974
+ :return: The driver(s) added.
2975
+ :rtype: bpy.types.FCurve
2976
+ """
1979
2977
  ...
1980
2978
 
1981
- def driver_remove(self):
1982
- """ """
2979
+ def driver_remove(self) -> bool:
2980
+ """Remove driver(s) from the given property
2981
+
2982
+ :return: Success of driver removal.
2983
+ :rtype: bool
2984
+ """
1983
2985
  ...
1984
2986
 
1985
2987
  def get(self):
1986
- """ """
2988
+ """Returns the value of the custom property assigned to key or default
2989
+ when not found (matches Python's dictionary function of the same name).
2990
+
2991
+ """
1987
2992
  ...
1988
2993
 
1989
2994
  def id_properties_clear(self):
1990
- """ """
2995
+ """
2996
+
2997
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2998
+ """
1991
2999
  ...
1992
3000
 
1993
3001
  def id_properties_ensure(self):
1994
- """ """
3002
+ """
3003
+
3004
+ :return: the parent group for an RNA struct's custom IDProperties.
3005
+ """
1995
3006
  ...
1996
3007
 
1997
3008
  def id_properties_ui(self):
1998
- """ """
3009
+ """
3010
+
3011
+ :return: Return an object used to manage an IDProperty's UI data.
3012
+ """
1999
3013
  ...
2000
3014
 
2001
3015
  def is_extended(self):
2002
3016
  """ """
2003
3017
  ...
2004
3018
 
2005
- def is_property_hidden(self):
2006
- """ """
2007
- ...
3019
+ def is_property_hidden(self) -> bool:
3020
+ """Check if a property is hidden.
3021
+
3022
+ :return: True when the property is hidden.
3023
+ :rtype: bool
3024
+ """
3025
+ ...
3026
+
3027
+ def is_property_overridable_library(self) -> bool:
3028
+ """Check if a property is overridable.
3029
+
3030
+ :return: True when the property is overridable.
3031
+ :rtype: bool
3032
+ """
3033
+ ...
3034
+
3035
+ def is_property_readonly(self) -> bool:
3036
+ """Check if a property is readonly.
2008
3037
 
2009
- def is_property_overridable_library(self):
2010
- """ """
3038
+ :return: True when the property is readonly (not writable).
3039
+ :rtype: bool
3040
+ """
2011
3041
  ...
2012
3042
 
2013
- def is_property_readonly(self):
2014
- """ """
2015
- ...
3043
+ def is_property_set(self) -> bool:
3044
+ """Check if a property is set, use for testing operator properties.
2016
3045
 
2017
- def is_property_set(self):
2018
- """ """
3046
+ :return: True when the property has been set.
3047
+ :rtype: bool
3048
+ """
2019
3049
  ...
2020
3050
 
2021
3051
  def items(self):
2022
- """ """
3052
+ """Returns the items of this objects custom properties (matches Python's
3053
+ dictionary function of the same name).
3054
+
3055
+ :return: custom property key, value pairs.
3056
+ """
2023
3057
  ...
2024
3058
 
2025
- def keyframe_delete(self):
2026
- """ """
3059
+ def keyframe_delete(self) -> bool:
3060
+ """Remove a keyframe from this properties fcurve.
3061
+
3062
+ :return: Success of keyframe deletion.
3063
+ :rtype: bool
3064
+ """
2027
3065
  ...
2028
3066
 
2029
- def keyframe_insert(self):
2030
- """ """
3067
+ def keyframe_insert(self) -> bool:
3068
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3069
+
3070
+ :return: Success of keyframe insertion.
3071
+ :rtype: bool
3072
+ """
2031
3073
  ...
2032
3074
 
2033
3075
  def keys(self):
2034
- """ """
3076
+ """Returns the keys of this objects custom properties (matches Python's
3077
+ dictionary function of the same name).
3078
+
3079
+ :return: custom property keys.
3080
+ """
2035
3081
  ...
2036
3082
 
2037
- def path_from_id(self):
2038
- """ """
3083
+ def path_from_id(self) -> str:
3084
+ """Returns the data path from the ID to this object (string).
3085
+
3086
+ :return: The path from `bpy.types.bpy_struct.id_data`
3087
+ to this struct and property (when given).
3088
+ :rtype: str
3089
+ """
2039
3090
  ...
2040
3091
 
2041
3092
  def path_resolve(self):
2042
- """ """
3093
+ """Returns the property from the path, raise an exception when not found."""
2043
3094
  ...
2044
3095
 
2045
3096
  def poll(self, context):
@@ -2050,37 +3101,53 @@ class RENDER_PT_output_views(
2050
3101
  ...
2051
3102
 
2052
3103
  def pop(self):
2053
- """ """
3104
+ """Remove and return the value of the custom property assigned to key or default
3105
+ when not found (matches Python's dictionary function of the same name).
3106
+
3107
+ """
2054
3108
  ...
2055
3109
 
2056
3110
  def prepend(self, draw_func):
2057
- """
3111
+ """Prepend a draw function to this menu, takes the same arguments as
3112
+ the menus draw function
2058
3113
 
2059
- :param draw_func:
3114
+ :param draw_func:
2060
3115
  """
2061
3116
  ...
2062
3117
 
2063
- def property_overridable_library_set(self):
2064
- """ """
3118
+ def property_overridable_library_set(self) -> bool:
3119
+ """Define a property as overridable or not (only for custom properties!).
3120
+
3121
+ :return: True when the overridable status of the property was successfully set.
3122
+ :rtype: bool
3123
+ """
2065
3124
  ...
2066
3125
 
2067
3126
  def property_unset(self):
2068
- """ """
3127
+ """Unset a property, will use default value afterward."""
2069
3128
  ...
2070
3129
 
2071
3130
  def remove(self, draw_func):
2072
- """
3131
+ """Remove a draw function that has been added to this menu
2073
3132
 
2074
3133
  :param draw_func:
2075
3134
  """
2076
3135
  ...
2077
3136
 
2078
3137
  def type_recast(self):
2079
- """ """
3138
+ """Return a new instance, this is needed because types
3139
+ such as textures can be changed at runtime.
3140
+
3141
+ :return: a new instance of this object with the type initialized again.
3142
+ """
2080
3143
  ...
2081
3144
 
2082
3145
  def values(self):
2083
- """ """
3146
+ """Returns the values of this objects custom properties (matches Python's
3147
+ dictionary function of the same name).
3148
+
3149
+ :return: custom property values.
3150
+ """
2084
3151
  ...
2085
3152
 
2086
3153
  class RENDER_PT_post_processing(
@@ -2113,22 +3180,35 @@ class RENDER_PT_post_processing(
2113
3180
  """ """
2114
3181
 
2115
3182
  def append(self, draw_func):
2116
- """
3183
+ """Append a draw function to this menu,
3184
+ takes the same arguments as the menus draw function
2117
3185
 
2118
- :param draw_func:
3186
+ :param draw_func:
2119
3187
  """
2120
3188
  ...
2121
3189
 
2122
- def as_pointer(self):
2123
- """ """
3190
+ def as_pointer(self) -> int:
3191
+ """Returns the memory address which holds a pointer to Blender's internal data
3192
+
3193
+ :return: int (memory address).
3194
+ :rtype: int
3195
+ """
2124
3196
  ...
2125
3197
 
2126
- def bl_rna_get_subclass(self):
2127
- """ """
3198
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3199
+ """
3200
+
3201
+ :return: The RNA type or default when not found.
3202
+ :rtype: bpy.types.Struct
3203
+ """
2128
3204
  ...
2129
3205
 
2130
- def bl_rna_get_subclass_py(self):
2131
- """ """
3206
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3207
+ """
3208
+
3209
+ :return: The class or default when not found.
3210
+ :rtype: typing.Any
3211
+ """
2132
3212
  ...
2133
3213
 
2134
3214
  def draw(self, context):
@@ -2138,72 +3218,129 @@ class RENDER_PT_post_processing(
2138
3218
  """
2139
3219
  ...
2140
3220
 
2141
- def driver_add(self):
2142
- """ """
3221
+ def driver_add(self) -> bpy.types.FCurve:
3222
+ """Adds driver(s) to the given property
3223
+
3224
+ :return: The driver(s) added.
3225
+ :rtype: bpy.types.FCurve
3226
+ """
2143
3227
  ...
2144
3228
 
2145
- def driver_remove(self):
2146
- """ """
3229
+ def driver_remove(self) -> bool:
3230
+ """Remove driver(s) from the given property
3231
+
3232
+ :return: Success of driver removal.
3233
+ :rtype: bool
3234
+ """
2147
3235
  ...
2148
3236
 
2149
3237
  def get(self):
2150
- """ """
3238
+ """Returns the value of the custom property assigned to key or default
3239
+ when not found (matches Python's dictionary function of the same name).
3240
+
3241
+ """
2151
3242
  ...
2152
3243
 
2153
3244
  def id_properties_clear(self):
2154
- """ """
3245
+ """
3246
+
3247
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3248
+ """
2155
3249
  ...
2156
3250
 
2157
3251
  def id_properties_ensure(self):
2158
- """ """
3252
+ """
3253
+
3254
+ :return: the parent group for an RNA struct's custom IDProperties.
3255
+ """
2159
3256
  ...
2160
3257
 
2161
3258
  def id_properties_ui(self):
2162
- """ """
3259
+ """
3260
+
3261
+ :return: Return an object used to manage an IDProperty's UI data.
3262
+ """
2163
3263
  ...
2164
3264
 
2165
3265
  def is_extended(self):
2166
3266
  """ """
2167
3267
  ...
2168
3268
 
2169
- def is_property_hidden(self):
2170
- """ """
3269
+ def is_property_hidden(self) -> bool:
3270
+ """Check if a property is hidden.
3271
+
3272
+ :return: True when the property is hidden.
3273
+ :rtype: bool
3274
+ """
2171
3275
  ...
2172
3276
 
2173
- def is_property_overridable_library(self):
2174
- """ """
3277
+ def is_property_overridable_library(self) -> bool:
3278
+ """Check if a property is overridable.
3279
+
3280
+ :return: True when the property is overridable.
3281
+ :rtype: bool
3282
+ """
2175
3283
  ...
2176
3284
 
2177
- def is_property_readonly(self):
2178
- """ """
3285
+ def is_property_readonly(self) -> bool:
3286
+ """Check if a property is readonly.
3287
+
3288
+ :return: True when the property is readonly (not writable).
3289
+ :rtype: bool
3290
+ """
2179
3291
  ...
2180
3292
 
2181
- def is_property_set(self):
2182
- """ """
3293
+ def is_property_set(self) -> bool:
3294
+ """Check if a property is set, use for testing operator properties.
3295
+
3296
+ :return: True when the property has been set.
3297
+ :rtype: bool
3298
+ """
2183
3299
  ...
2184
3300
 
2185
3301
  def items(self):
2186
- """ """
3302
+ """Returns the items of this objects custom properties (matches Python's
3303
+ dictionary function of the same name).
3304
+
3305
+ :return: custom property key, value pairs.
3306
+ """
2187
3307
  ...
2188
3308
 
2189
- def keyframe_delete(self):
2190
- """ """
3309
+ def keyframe_delete(self) -> bool:
3310
+ """Remove a keyframe from this properties fcurve.
3311
+
3312
+ :return: Success of keyframe deletion.
3313
+ :rtype: bool
3314
+ """
2191
3315
  ...
2192
3316
 
2193
- def keyframe_insert(self):
2194
- """ """
3317
+ def keyframe_insert(self) -> bool:
3318
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3319
+
3320
+ :return: Success of keyframe insertion.
3321
+ :rtype: bool
3322
+ """
2195
3323
  ...
2196
3324
 
2197
3325
  def keys(self):
2198
- """ """
3326
+ """Returns the keys of this objects custom properties (matches Python's
3327
+ dictionary function of the same name).
3328
+
3329
+ :return: custom property keys.
3330
+ """
2199
3331
  ...
2200
3332
 
2201
- def path_from_id(self):
2202
- """ """
3333
+ def path_from_id(self) -> str:
3334
+ """Returns the data path from the ID to this object (string).
3335
+
3336
+ :return: The path from `bpy.types.bpy_struct.id_data`
3337
+ to this struct and property (when given).
3338
+ :rtype: str
3339
+ """
2203
3340
  ...
2204
3341
 
2205
3342
  def path_resolve(self):
2206
- """ """
3343
+ """Returns the property from the path, raise an exception when not found."""
2207
3344
  ...
2208
3345
 
2209
3346
  def poll(self, context):
@@ -2214,37 +3351,53 @@ class RENDER_PT_post_processing(
2214
3351
  ...
2215
3352
 
2216
3353
  def pop(self):
2217
- """ """
3354
+ """Remove and return the value of the custom property assigned to key or default
3355
+ when not found (matches Python's dictionary function of the same name).
3356
+
3357
+ """
2218
3358
  ...
2219
3359
 
2220
3360
  def prepend(self, draw_func):
2221
- """
3361
+ """Prepend a draw function to this menu, takes the same arguments as
3362
+ the menus draw function
2222
3363
 
2223
- :param draw_func:
3364
+ :param draw_func:
2224
3365
  """
2225
3366
  ...
2226
3367
 
2227
- def property_overridable_library_set(self):
2228
- """ """
3368
+ def property_overridable_library_set(self) -> bool:
3369
+ """Define a property as overridable or not (only for custom properties!).
3370
+
3371
+ :return: True when the overridable status of the property was successfully set.
3372
+ :rtype: bool
3373
+ """
2229
3374
  ...
2230
3375
 
2231
3376
  def property_unset(self):
2232
- """ """
3377
+ """Unset a property, will use default value afterward."""
2233
3378
  ...
2234
3379
 
2235
3380
  def remove(self, draw_func):
2236
- """
3381
+ """Remove a draw function that has been added to this menu
2237
3382
 
2238
3383
  :param draw_func:
2239
3384
  """
2240
3385
  ...
2241
3386
 
2242
3387
  def type_recast(self):
2243
- """ """
3388
+ """Return a new instance, this is needed because types
3389
+ such as textures can be changed at runtime.
3390
+
3391
+ :return: a new instance of this object with the type initialized again.
3392
+ """
2244
3393
  ...
2245
3394
 
2246
3395
  def values(self):
2247
- """ """
3396
+ """Returns the values of this objects custom properties (matches Python's
3397
+ dictionary function of the same name).
3398
+
3399
+ :return: custom property values.
3400
+ """
2248
3401
  ...
2249
3402
 
2250
3403
  class RENDER_PT_stamp(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._GenericUI):
@@ -2275,22 +3428,35 @@ class RENDER_PT_stamp(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._Gene
2275
3428
  """ """
2276
3429
 
2277
3430
  def append(self, draw_func):
2278
- """
3431
+ """Append a draw function to this menu,
3432
+ takes the same arguments as the menus draw function
2279
3433
 
2280
- :param draw_func:
3434
+ :param draw_func:
2281
3435
  """
2282
3436
  ...
2283
3437
 
2284
- def as_pointer(self):
2285
- """ """
3438
+ def as_pointer(self) -> int:
3439
+ """Returns the memory address which holds a pointer to Blender's internal data
3440
+
3441
+ :return: int (memory address).
3442
+ :rtype: int
3443
+ """
2286
3444
  ...
2287
3445
 
2288
- def bl_rna_get_subclass(self):
2289
- """ """
3446
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3447
+ """
3448
+
3449
+ :return: The RNA type or default when not found.
3450
+ :rtype: bpy.types.Struct
3451
+ """
2290
3452
  ...
2291
3453
 
2292
- def bl_rna_get_subclass_py(self):
2293
- """ """
3454
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3455
+ """
3456
+
3457
+ :return: The class or default when not found.
3458
+ :rtype: typing.Any
3459
+ """
2294
3460
  ...
2295
3461
 
2296
3462
  def draw(self, context):
@@ -2300,72 +3466,129 @@ class RENDER_PT_stamp(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._Gene
2300
3466
  """
2301
3467
  ...
2302
3468
 
2303
- def driver_add(self):
2304
- """ """
3469
+ def driver_add(self) -> bpy.types.FCurve:
3470
+ """Adds driver(s) to the given property
3471
+
3472
+ :return: The driver(s) added.
3473
+ :rtype: bpy.types.FCurve
3474
+ """
2305
3475
  ...
2306
3476
 
2307
- def driver_remove(self):
2308
- """ """
3477
+ def driver_remove(self) -> bool:
3478
+ """Remove driver(s) from the given property
3479
+
3480
+ :return: Success of driver removal.
3481
+ :rtype: bool
3482
+ """
2309
3483
  ...
2310
3484
 
2311
3485
  def get(self):
2312
- """ """
3486
+ """Returns the value of the custom property assigned to key or default
3487
+ when not found (matches Python's dictionary function of the same name).
3488
+
3489
+ """
2313
3490
  ...
2314
3491
 
2315
3492
  def id_properties_clear(self):
2316
- """ """
3493
+ """
3494
+
3495
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3496
+ """
2317
3497
  ...
2318
3498
 
2319
3499
  def id_properties_ensure(self):
2320
- """ """
3500
+ """
3501
+
3502
+ :return: the parent group for an RNA struct's custom IDProperties.
3503
+ """
2321
3504
  ...
2322
3505
 
2323
3506
  def id_properties_ui(self):
2324
- """ """
3507
+ """
3508
+
3509
+ :return: Return an object used to manage an IDProperty's UI data.
3510
+ """
2325
3511
  ...
2326
3512
 
2327
3513
  def is_extended(self):
2328
3514
  """ """
2329
3515
  ...
2330
3516
 
2331
- def is_property_hidden(self):
2332
- """ """
3517
+ def is_property_hidden(self) -> bool:
3518
+ """Check if a property is hidden.
3519
+
3520
+ :return: True when the property is hidden.
3521
+ :rtype: bool
3522
+ """
2333
3523
  ...
2334
3524
 
2335
- def is_property_overridable_library(self):
2336
- """ """
3525
+ def is_property_overridable_library(self) -> bool:
3526
+ """Check if a property is overridable.
3527
+
3528
+ :return: True when the property is overridable.
3529
+ :rtype: bool
3530
+ """
2337
3531
  ...
2338
3532
 
2339
- def is_property_readonly(self):
2340
- """ """
3533
+ def is_property_readonly(self) -> bool:
3534
+ """Check if a property is readonly.
3535
+
3536
+ :return: True when the property is readonly (not writable).
3537
+ :rtype: bool
3538
+ """
2341
3539
  ...
2342
3540
 
2343
- def is_property_set(self):
2344
- """ """
3541
+ def is_property_set(self) -> bool:
3542
+ """Check if a property is set, use for testing operator properties.
3543
+
3544
+ :return: True when the property has been set.
3545
+ :rtype: bool
3546
+ """
2345
3547
  ...
2346
3548
 
2347
3549
  def items(self):
2348
- """ """
3550
+ """Returns the items of this objects custom properties (matches Python's
3551
+ dictionary function of the same name).
3552
+
3553
+ :return: custom property key, value pairs.
3554
+ """
2349
3555
  ...
2350
3556
 
2351
- def keyframe_delete(self):
2352
- """ """
3557
+ def keyframe_delete(self) -> bool:
3558
+ """Remove a keyframe from this properties fcurve.
3559
+
3560
+ :return: Success of keyframe deletion.
3561
+ :rtype: bool
3562
+ """
2353
3563
  ...
2354
3564
 
2355
- def keyframe_insert(self):
2356
- """ """
3565
+ def keyframe_insert(self) -> bool:
3566
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3567
+
3568
+ :return: Success of keyframe insertion.
3569
+ :rtype: bool
3570
+ """
2357
3571
  ...
2358
3572
 
2359
3573
  def keys(self):
2360
- """ """
3574
+ """Returns the keys of this objects custom properties (matches Python's
3575
+ dictionary function of the same name).
3576
+
3577
+ :return: custom property keys.
3578
+ """
2361
3579
  ...
2362
3580
 
2363
- def path_from_id(self):
2364
- """ """
3581
+ def path_from_id(self) -> str:
3582
+ """Returns the data path from the ID to this object (string).
3583
+
3584
+ :return: The path from `bpy.types.bpy_struct.id_data`
3585
+ to this struct and property (when given).
3586
+ :rtype: str
3587
+ """
2365
3588
  ...
2366
3589
 
2367
3590
  def path_resolve(self):
2368
- """ """
3591
+ """Returns the property from the path, raise an exception when not found."""
2369
3592
  ...
2370
3593
 
2371
3594
  def poll(self, context):
@@ -2376,37 +3599,53 @@ class RENDER_PT_stamp(bpy_types.Panel, RenderOutputButtonsPanel, bpy_types._Gene
2376
3599
  ...
2377
3600
 
2378
3601
  def pop(self):
2379
- """ """
3602
+ """Remove and return the value of the custom property assigned to key or default
3603
+ when not found (matches Python's dictionary function of the same name).
3604
+
3605
+ """
2380
3606
  ...
2381
3607
 
2382
3608
  def prepend(self, draw_func):
2383
- """
3609
+ """Prepend a draw function to this menu, takes the same arguments as
3610
+ the menus draw function
2384
3611
 
2385
- :param draw_func:
3612
+ :param draw_func:
2386
3613
  """
2387
3614
  ...
2388
3615
 
2389
- def property_overridable_library_set(self):
2390
- """ """
3616
+ def property_overridable_library_set(self) -> bool:
3617
+ """Define a property as overridable or not (only for custom properties!).
3618
+
3619
+ :return: True when the overridable status of the property was successfully set.
3620
+ :rtype: bool
3621
+ """
2391
3622
  ...
2392
3623
 
2393
3624
  def property_unset(self):
2394
- """ """
3625
+ """Unset a property, will use default value afterward."""
2395
3626
  ...
2396
3627
 
2397
3628
  def remove(self, draw_func):
2398
- """
3629
+ """Remove a draw function that has been added to this menu
2399
3630
 
2400
3631
  :param draw_func:
2401
3632
  """
2402
3633
  ...
2403
3634
 
2404
3635
  def type_recast(self):
2405
- """ """
3636
+ """Return a new instance, this is needed because types
3637
+ such as textures can be changed at runtime.
3638
+
3639
+ :return: a new instance of this object with the type initialized again.
3640
+ """
2406
3641
  ...
2407
3642
 
2408
3643
  def values(self):
2409
- """ """
3644
+ """Returns the values of this objects custom properties (matches Python's
3645
+ dictionary function of the same name).
3646
+
3647
+ :return: custom property values.
3648
+ """
2410
3649
  ...
2411
3650
 
2412
3651
  class RENDER_PT_stamp_burn(
@@ -2442,22 +3681,35 @@ class RENDER_PT_stamp_burn(
2442
3681
  """ """
2443
3682
 
2444
3683
  def append(self, draw_func):
2445
- """
3684
+ """Append a draw function to this menu,
3685
+ takes the same arguments as the menus draw function
2446
3686
 
2447
- :param draw_func:
3687
+ :param draw_func:
2448
3688
  """
2449
3689
  ...
2450
3690
 
2451
- def as_pointer(self):
2452
- """ """
3691
+ def as_pointer(self) -> int:
3692
+ """Returns the memory address which holds a pointer to Blender's internal data
3693
+
3694
+ :return: int (memory address).
3695
+ :rtype: int
3696
+ """
2453
3697
  ...
2454
3698
 
2455
- def bl_rna_get_subclass(self):
2456
- """ """
3699
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3700
+ """
3701
+
3702
+ :return: The RNA type or default when not found.
3703
+ :rtype: bpy.types.Struct
3704
+ """
2457
3705
  ...
2458
3706
 
2459
- def bl_rna_get_subclass_py(self):
2460
- """ """
3707
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3708
+ """
3709
+
3710
+ :return: The class or default when not found.
3711
+ :rtype: typing.Any
3712
+ """
2461
3713
  ...
2462
3714
 
2463
3715
  def draw(self, context):
@@ -2474,72 +3726,129 @@ class RENDER_PT_stamp_burn(
2474
3726
  """
2475
3727
  ...
2476
3728
 
2477
- def driver_add(self):
2478
- """ """
3729
+ def driver_add(self) -> bpy.types.FCurve:
3730
+ """Adds driver(s) to the given property
3731
+
3732
+ :return: The driver(s) added.
3733
+ :rtype: bpy.types.FCurve
3734
+ """
2479
3735
  ...
2480
3736
 
2481
- def driver_remove(self):
2482
- """ """
3737
+ def driver_remove(self) -> bool:
3738
+ """Remove driver(s) from the given property
3739
+
3740
+ :return: Success of driver removal.
3741
+ :rtype: bool
3742
+ """
2483
3743
  ...
2484
3744
 
2485
3745
  def get(self):
2486
- """ """
3746
+ """Returns the value of the custom property assigned to key or default
3747
+ when not found (matches Python's dictionary function of the same name).
3748
+
3749
+ """
2487
3750
  ...
2488
3751
 
2489
3752
  def id_properties_clear(self):
2490
- """ """
3753
+ """
3754
+
3755
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3756
+ """
2491
3757
  ...
2492
3758
 
2493
3759
  def id_properties_ensure(self):
2494
- """ """
3760
+ """
3761
+
3762
+ :return: the parent group for an RNA struct's custom IDProperties.
3763
+ """
2495
3764
  ...
2496
3765
 
2497
3766
  def id_properties_ui(self):
2498
- """ """
3767
+ """
3768
+
3769
+ :return: Return an object used to manage an IDProperty's UI data.
3770
+ """
2499
3771
  ...
2500
3772
 
2501
3773
  def is_extended(self):
2502
3774
  """ """
2503
3775
  ...
2504
3776
 
2505
- def is_property_hidden(self):
2506
- """ """
3777
+ def is_property_hidden(self) -> bool:
3778
+ """Check if a property is hidden.
3779
+
3780
+ :return: True when the property is hidden.
3781
+ :rtype: bool
3782
+ """
2507
3783
  ...
2508
3784
 
2509
- def is_property_overridable_library(self):
2510
- """ """
3785
+ def is_property_overridable_library(self) -> bool:
3786
+ """Check if a property is overridable.
3787
+
3788
+ :return: True when the property is overridable.
3789
+ :rtype: bool
3790
+ """
2511
3791
  ...
2512
3792
 
2513
- def is_property_readonly(self):
2514
- """ """
3793
+ def is_property_readonly(self) -> bool:
3794
+ """Check if a property is readonly.
3795
+
3796
+ :return: True when the property is readonly (not writable).
3797
+ :rtype: bool
3798
+ """
2515
3799
  ...
2516
3800
 
2517
- def is_property_set(self):
2518
- """ """
3801
+ def is_property_set(self) -> bool:
3802
+ """Check if a property is set, use for testing operator properties.
3803
+
3804
+ :return: True when the property has been set.
3805
+ :rtype: bool
3806
+ """
2519
3807
  ...
2520
3808
 
2521
3809
  def items(self):
2522
- """ """
3810
+ """Returns the items of this objects custom properties (matches Python's
3811
+ dictionary function of the same name).
3812
+
3813
+ :return: custom property key, value pairs.
3814
+ """
2523
3815
  ...
2524
3816
 
2525
- def keyframe_delete(self):
2526
- """ """
3817
+ def keyframe_delete(self) -> bool:
3818
+ """Remove a keyframe from this properties fcurve.
3819
+
3820
+ :return: Success of keyframe deletion.
3821
+ :rtype: bool
3822
+ """
2527
3823
  ...
2528
3824
 
2529
- def keyframe_insert(self):
2530
- """ """
3825
+ def keyframe_insert(self) -> bool:
3826
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3827
+
3828
+ :return: Success of keyframe insertion.
3829
+ :rtype: bool
3830
+ """
3831
+ ...
3832
+
3833
+ def keys(self):
3834
+ """Returns the keys of this objects custom properties (matches Python's
3835
+ dictionary function of the same name).
3836
+
3837
+ :return: custom property keys.
3838
+ """
2531
3839
  ...
2532
3840
 
2533
- def keys(self):
2534
- """ """
2535
- ...
3841
+ def path_from_id(self) -> str:
3842
+ """Returns the data path from the ID to this object (string).
2536
3843
 
2537
- def path_from_id(self):
2538
- """ """
3844
+ :return: The path from `bpy.types.bpy_struct.id_data`
3845
+ to this struct and property (when given).
3846
+ :rtype: str
3847
+ """
2539
3848
  ...
2540
3849
 
2541
3850
  def path_resolve(self):
2542
- """ """
3851
+ """Returns the property from the path, raise an exception when not found."""
2543
3852
  ...
2544
3853
 
2545
3854
  def poll(self, context):
@@ -2550,37 +3859,53 @@ class RENDER_PT_stamp_burn(
2550
3859
  ...
2551
3860
 
2552
3861
  def pop(self):
2553
- """ """
3862
+ """Remove and return the value of the custom property assigned to key or default
3863
+ when not found (matches Python's dictionary function of the same name).
3864
+
3865
+ """
2554
3866
  ...
2555
3867
 
2556
3868
  def prepend(self, draw_func):
2557
- """
3869
+ """Prepend a draw function to this menu, takes the same arguments as
3870
+ the menus draw function
2558
3871
 
2559
- :param draw_func:
3872
+ :param draw_func:
2560
3873
  """
2561
3874
  ...
2562
3875
 
2563
- def property_overridable_library_set(self):
2564
- """ """
3876
+ def property_overridable_library_set(self) -> bool:
3877
+ """Define a property as overridable or not (only for custom properties!).
3878
+
3879
+ :return: True when the overridable status of the property was successfully set.
3880
+ :rtype: bool
3881
+ """
2565
3882
  ...
2566
3883
 
2567
3884
  def property_unset(self):
2568
- """ """
3885
+ """Unset a property, will use default value afterward."""
2569
3886
  ...
2570
3887
 
2571
3888
  def remove(self, draw_func):
2572
- """
3889
+ """Remove a draw function that has been added to this menu
2573
3890
 
2574
3891
  :param draw_func:
2575
3892
  """
2576
3893
  ...
2577
3894
 
2578
3895
  def type_recast(self):
2579
- """ """
3896
+ """Return a new instance, this is needed because types
3897
+ such as textures can be changed at runtime.
3898
+
3899
+ :return: a new instance of this object with the type initialized again.
3900
+ """
2580
3901
  ...
2581
3902
 
2582
3903
  def values(self):
2583
- """ """
3904
+ """Returns the values of this objects custom properties (matches Python's
3905
+ dictionary function of the same name).
3906
+
3907
+ :return: custom property values.
3908
+ """
2584
3909
  ...
2585
3910
 
2586
3911
  class RENDER_PT_stamp_note(
@@ -2616,22 +3941,35 @@ class RENDER_PT_stamp_note(
2616
3941
  """ """
2617
3942
 
2618
3943
  def append(self, draw_func):
2619
- """
3944
+ """Append a draw function to this menu,
3945
+ takes the same arguments as the menus draw function
2620
3946
 
2621
- :param draw_func:
3947
+ :param draw_func:
2622
3948
  """
2623
3949
  ...
2624
3950
 
2625
- def as_pointer(self):
2626
- """ """
3951
+ def as_pointer(self) -> int:
3952
+ """Returns the memory address which holds a pointer to Blender's internal data
3953
+
3954
+ :return: int (memory address).
3955
+ :rtype: int
3956
+ """
2627
3957
  ...
2628
3958
 
2629
- def bl_rna_get_subclass(self):
2630
- """ """
3959
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3960
+ """
3961
+
3962
+ :return: The RNA type or default when not found.
3963
+ :rtype: bpy.types.Struct
3964
+ """
2631
3965
  ...
2632
3966
 
2633
- def bl_rna_get_subclass_py(self):
2634
- """ """
3967
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3968
+ """
3969
+
3970
+ :return: The class or default when not found.
3971
+ :rtype: typing.Any
3972
+ """
2635
3973
  ...
2636
3974
 
2637
3975
  def draw(self, context):
@@ -2648,72 +3986,129 @@ class RENDER_PT_stamp_note(
2648
3986
  """
2649
3987
  ...
2650
3988
 
2651
- def driver_add(self):
2652
- """ """
3989
+ def driver_add(self) -> bpy.types.FCurve:
3990
+ """Adds driver(s) to the given property
3991
+
3992
+ :return: The driver(s) added.
3993
+ :rtype: bpy.types.FCurve
3994
+ """
2653
3995
  ...
2654
3996
 
2655
- def driver_remove(self):
2656
- """ """
3997
+ def driver_remove(self) -> bool:
3998
+ """Remove driver(s) from the given property
3999
+
4000
+ :return: Success of driver removal.
4001
+ :rtype: bool
4002
+ """
2657
4003
  ...
2658
4004
 
2659
4005
  def get(self):
2660
- """ """
4006
+ """Returns the value of the custom property assigned to key or default
4007
+ when not found (matches Python's dictionary function of the same name).
4008
+
4009
+ """
2661
4010
  ...
2662
4011
 
2663
4012
  def id_properties_clear(self):
2664
- """ """
4013
+ """
4014
+
4015
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
4016
+ """
2665
4017
  ...
2666
4018
 
2667
4019
  def id_properties_ensure(self):
2668
- """ """
4020
+ """
4021
+
4022
+ :return: the parent group for an RNA struct's custom IDProperties.
4023
+ """
2669
4024
  ...
2670
4025
 
2671
4026
  def id_properties_ui(self):
2672
- """ """
4027
+ """
4028
+
4029
+ :return: Return an object used to manage an IDProperty's UI data.
4030
+ """
2673
4031
  ...
2674
4032
 
2675
4033
  def is_extended(self):
2676
4034
  """ """
2677
4035
  ...
2678
4036
 
2679
- def is_property_hidden(self):
2680
- """ """
4037
+ def is_property_hidden(self) -> bool:
4038
+ """Check if a property is hidden.
4039
+
4040
+ :return: True when the property is hidden.
4041
+ :rtype: bool
4042
+ """
2681
4043
  ...
2682
4044
 
2683
- def is_property_overridable_library(self):
2684
- """ """
4045
+ def is_property_overridable_library(self) -> bool:
4046
+ """Check if a property is overridable.
4047
+
4048
+ :return: True when the property is overridable.
4049
+ :rtype: bool
4050
+ """
2685
4051
  ...
2686
4052
 
2687
- def is_property_readonly(self):
2688
- """ """
4053
+ def is_property_readonly(self) -> bool:
4054
+ """Check if a property is readonly.
4055
+
4056
+ :return: True when the property is readonly (not writable).
4057
+ :rtype: bool
4058
+ """
2689
4059
  ...
2690
4060
 
2691
- def is_property_set(self):
2692
- """ """
4061
+ def is_property_set(self) -> bool:
4062
+ """Check if a property is set, use for testing operator properties.
4063
+
4064
+ :return: True when the property has been set.
4065
+ :rtype: bool
4066
+ """
2693
4067
  ...
2694
4068
 
2695
4069
  def items(self):
2696
- """ """
4070
+ """Returns the items of this objects custom properties (matches Python's
4071
+ dictionary function of the same name).
4072
+
4073
+ :return: custom property key, value pairs.
4074
+ """
2697
4075
  ...
2698
4076
 
2699
- def keyframe_delete(self):
2700
- """ """
4077
+ def keyframe_delete(self) -> bool:
4078
+ """Remove a keyframe from this properties fcurve.
4079
+
4080
+ :return: Success of keyframe deletion.
4081
+ :rtype: bool
4082
+ """
2701
4083
  ...
2702
4084
 
2703
- def keyframe_insert(self):
2704
- """ """
4085
+ def keyframe_insert(self) -> bool:
4086
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
4087
+
4088
+ :return: Success of keyframe insertion.
4089
+ :rtype: bool
4090
+ """
2705
4091
  ...
2706
4092
 
2707
4093
  def keys(self):
2708
- """ """
4094
+ """Returns the keys of this objects custom properties (matches Python's
4095
+ dictionary function of the same name).
4096
+
4097
+ :return: custom property keys.
4098
+ """
2709
4099
  ...
2710
4100
 
2711
- def path_from_id(self):
2712
- """ """
4101
+ def path_from_id(self) -> str:
4102
+ """Returns the data path from the ID to this object (string).
4103
+
4104
+ :return: The path from `bpy.types.bpy_struct.id_data`
4105
+ to this struct and property (when given).
4106
+ :rtype: str
4107
+ """
2713
4108
  ...
2714
4109
 
2715
4110
  def path_resolve(self):
2716
- """ """
4111
+ """Returns the property from the path, raise an exception when not found."""
2717
4112
  ...
2718
4113
 
2719
4114
  def poll(self, context):
@@ -2724,37 +4119,53 @@ class RENDER_PT_stamp_note(
2724
4119
  ...
2725
4120
 
2726
4121
  def pop(self):
2727
- """ """
4122
+ """Remove and return the value of the custom property assigned to key or default
4123
+ when not found (matches Python's dictionary function of the same name).
4124
+
4125
+ """
2728
4126
  ...
2729
4127
 
2730
4128
  def prepend(self, draw_func):
2731
- """
4129
+ """Prepend a draw function to this menu, takes the same arguments as
4130
+ the menus draw function
2732
4131
 
2733
- :param draw_func:
4132
+ :param draw_func:
2734
4133
  """
2735
4134
  ...
2736
4135
 
2737
- def property_overridable_library_set(self):
2738
- """ """
4136
+ def property_overridable_library_set(self) -> bool:
4137
+ """Define a property as overridable or not (only for custom properties!).
4138
+
4139
+ :return: True when the overridable status of the property was successfully set.
4140
+ :rtype: bool
4141
+ """
2739
4142
  ...
2740
4143
 
2741
4144
  def property_unset(self):
2742
- """ """
4145
+ """Unset a property, will use default value afterward."""
2743
4146
  ...
2744
4147
 
2745
4148
  def remove(self, draw_func):
2746
- """
4149
+ """Remove a draw function that has been added to this menu
2747
4150
 
2748
4151
  :param draw_func:
2749
4152
  """
2750
4153
  ...
2751
4154
 
2752
4155
  def type_recast(self):
2753
- """ """
4156
+ """Return a new instance, this is needed because types
4157
+ such as textures can be changed at runtime.
4158
+
4159
+ :return: a new instance of this object with the type initialized again.
4160
+ """
2754
4161
  ...
2755
4162
 
2756
4163
  def values(self):
2757
- """ """
4164
+ """Returns the values of this objects custom properties (matches Python's
4165
+ dictionary function of the same name).
4166
+
4167
+ :return: custom property values.
4168
+ """
2758
4169
  ...
2759
4170
 
2760
4171
  class RENDER_PT_stereoscopy(
@@ -2787,22 +4198,35 @@ class RENDER_PT_stereoscopy(
2787
4198
  """ """
2788
4199
 
2789
4200
  def append(self, draw_func):
2790
- """
4201
+ """Append a draw function to this menu,
4202
+ takes the same arguments as the menus draw function
2791
4203
 
2792
- :param draw_func:
4204
+ :param draw_func:
2793
4205
  """
2794
4206
  ...
2795
4207
 
2796
- def as_pointer(self):
2797
- """ """
4208
+ def as_pointer(self) -> int:
4209
+ """Returns the memory address which holds a pointer to Blender's internal data
4210
+
4211
+ :return: int (memory address).
4212
+ :rtype: int
4213
+ """
2798
4214
  ...
2799
4215
 
2800
- def bl_rna_get_subclass(self):
2801
- """ """
4216
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
4217
+ """
4218
+
4219
+ :return: The RNA type or default when not found.
4220
+ :rtype: bpy.types.Struct
4221
+ """
2802
4222
  ...
2803
4223
 
2804
- def bl_rna_get_subclass_py(self):
2805
- """ """
4224
+ def bl_rna_get_subclass_py(self) -> typing.Any:
4225
+ """
4226
+
4227
+ :return: The class or default when not found.
4228
+ :rtype: typing.Any
4229
+ """
2806
4230
  ...
2807
4231
 
2808
4232
  def draw(self, context):
@@ -2819,72 +4243,129 @@ class RENDER_PT_stereoscopy(
2819
4243
  """
2820
4244
  ...
2821
4245
 
2822
- def driver_add(self):
2823
- """ """
4246
+ def driver_add(self) -> bpy.types.FCurve:
4247
+ """Adds driver(s) to the given property
4248
+
4249
+ :return: The driver(s) added.
4250
+ :rtype: bpy.types.FCurve
4251
+ """
2824
4252
  ...
2825
4253
 
2826
- def driver_remove(self):
2827
- """ """
4254
+ def driver_remove(self) -> bool:
4255
+ """Remove driver(s) from the given property
4256
+
4257
+ :return: Success of driver removal.
4258
+ :rtype: bool
4259
+ """
2828
4260
  ...
2829
4261
 
2830
4262
  def get(self):
2831
- """ """
4263
+ """Returns the value of the custom property assigned to key or default
4264
+ when not found (matches Python's dictionary function of the same name).
4265
+
4266
+ """
2832
4267
  ...
2833
4268
 
2834
4269
  def id_properties_clear(self):
2835
- """ """
4270
+ """
4271
+
4272
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
4273
+ """
2836
4274
  ...
2837
4275
 
2838
4276
  def id_properties_ensure(self):
2839
- """ """
4277
+ """
4278
+
4279
+ :return: the parent group for an RNA struct's custom IDProperties.
4280
+ """
2840
4281
  ...
2841
4282
 
2842
4283
  def id_properties_ui(self):
2843
- """ """
4284
+ """
4285
+
4286
+ :return: Return an object used to manage an IDProperty's UI data.
4287
+ """
2844
4288
  ...
2845
4289
 
2846
4290
  def is_extended(self):
2847
4291
  """ """
2848
4292
  ...
2849
4293
 
2850
- def is_property_hidden(self):
2851
- """ """
4294
+ def is_property_hidden(self) -> bool:
4295
+ """Check if a property is hidden.
4296
+
4297
+ :return: True when the property is hidden.
4298
+ :rtype: bool
4299
+ """
2852
4300
  ...
2853
4301
 
2854
- def is_property_overridable_library(self):
2855
- """ """
4302
+ def is_property_overridable_library(self) -> bool:
4303
+ """Check if a property is overridable.
4304
+
4305
+ :return: True when the property is overridable.
4306
+ :rtype: bool
4307
+ """
2856
4308
  ...
2857
4309
 
2858
- def is_property_readonly(self):
2859
- """ """
4310
+ def is_property_readonly(self) -> bool:
4311
+ """Check if a property is readonly.
4312
+
4313
+ :return: True when the property is readonly (not writable).
4314
+ :rtype: bool
4315
+ """
2860
4316
  ...
2861
4317
 
2862
- def is_property_set(self):
2863
- """ """
4318
+ def is_property_set(self) -> bool:
4319
+ """Check if a property is set, use for testing operator properties.
4320
+
4321
+ :return: True when the property has been set.
4322
+ :rtype: bool
4323
+ """
2864
4324
  ...
2865
4325
 
2866
4326
  def items(self):
2867
- """ """
4327
+ """Returns the items of this objects custom properties (matches Python's
4328
+ dictionary function of the same name).
4329
+
4330
+ :return: custom property key, value pairs.
4331
+ """
2868
4332
  ...
2869
4333
 
2870
- def keyframe_delete(self):
2871
- """ """
4334
+ def keyframe_delete(self) -> bool:
4335
+ """Remove a keyframe from this properties fcurve.
4336
+
4337
+ :return: Success of keyframe deletion.
4338
+ :rtype: bool
4339
+ """
2872
4340
  ...
2873
4341
 
2874
- def keyframe_insert(self):
2875
- """ """
4342
+ def keyframe_insert(self) -> bool:
4343
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
4344
+
4345
+ :return: Success of keyframe insertion.
4346
+ :rtype: bool
4347
+ """
2876
4348
  ...
2877
4349
 
2878
4350
  def keys(self):
2879
- """ """
4351
+ """Returns the keys of this objects custom properties (matches Python's
4352
+ dictionary function of the same name).
4353
+
4354
+ :return: custom property keys.
4355
+ """
2880
4356
  ...
2881
4357
 
2882
- def path_from_id(self):
2883
- """ """
4358
+ def path_from_id(self) -> str:
4359
+ """Returns the data path from the ID to this object (string).
4360
+
4361
+ :return: The path from `bpy.types.bpy_struct.id_data`
4362
+ to this struct and property (when given).
4363
+ :rtype: str
4364
+ """
2884
4365
  ...
2885
4366
 
2886
4367
  def path_resolve(self):
2887
- """ """
4368
+ """Returns the property from the path, raise an exception when not found."""
2888
4369
  ...
2889
4370
 
2890
4371
  def poll(self, context):
@@ -2895,37 +4376,53 @@ class RENDER_PT_stereoscopy(
2895
4376
  ...
2896
4377
 
2897
4378
  def pop(self):
2898
- """ """
4379
+ """Remove and return the value of the custom property assigned to key or default
4380
+ when not found (matches Python's dictionary function of the same name).
4381
+
4382
+ """
2899
4383
  ...
2900
4384
 
2901
4385
  def prepend(self, draw_func):
2902
- """
4386
+ """Prepend a draw function to this menu, takes the same arguments as
4387
+ the menus draw function
2903
4388
 
2904
- :param draw_func:
4389
+ :param draw_func:
2905
4390
  """
2906
4391
  ...
2907
4392
 
2908
- def property_overridable_library_set(self):
2909
- """ """
4393
+ def property_overridable_library_set(self) -> bool:
4394
+ """Define a property as overridable or not (only for custom properties!).
4395
+
4396
+ :return: True when the overridable status of the property was successfully set.
4397
+ :rtype: bool
4398
+ """
2910
4399
  ...
2911
4400
 
2912
4401
  def property_unset(self):
2913
- """ """
4402
+ """Unset a property, will use default value afterward."""
2914
4403
  ...
2915
4404
 
2916
4405
  def remove(self, draw_func):
2917
- """
4406
+ """Remove a draw function that has been added to this menu
2918
4407
 
2919
4408
  :param draw_func:
2920
4409
  """
2921
4410
  ...
2922
4411
 
2923
4412
  def type_recast(self):
2924
- """ """
4413
+ """Return a new instance, this is needed because types
4414
+ such as textures can be changed at runtime.
4415
+
4416
+ :return: a new instance of this object with the type initialized again.
4417
+ """
2925
4418
  ...
2926
4419
 
2927
4420
  def values(self):
2928
- """ """
4421
+ """Returns the values of this objects custom properties (matches Python's
4422
+ dictionary function of the same name).
4423
+
4424
+ :return: custom property values.
4425
+ """
2929
4426
  ...
2930
4427
 
2931
4428
  class RENDER_PT_time_stretching(
@@ -2961,22 +4458,35 @@ class RENDER_PT_time_stretching(
2961
4458
  """ """
2962
4459
 
2963
4460
  def append(self, draw_func):
2964
- """
4461
+ """Append a draw function to this menu,
4462
+ takes the same arguments as the menus draw function
2965
4463
 
2966
- :param draw_func:
4464
+ :param draw_func:
2967
4465
  """
2968
4466
  ...
2969
4467
 
2970
- def as_pointer(self):
2971
- """ """
4468
+ def as_pointer(self) -> int:
4469
+ """Returns the memory address which holds a pointer to Blender's internal data
4470
+
4471
+ :return: int (memory address).
4472
+ :rtype: int
4473
+ """
2972
4474
  ...
2973
4475
 
2974
- def bl_rna_get_subclass(self):
2975
- """ """
4476
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
4477
+ """
4478
+
4479
+ :return: The RNA type or default when not found.
4480
+ :rtype: bpy.types.Struct
4481
+ """
2976
4482
  ...
2977
4483
 
2978
- def bl_rna_get_subclass_py(self):
2979
- """ """
4484
+ def bl_rna_get_subclass_py(self) -> typing.Any:
4485
+ """
4486
+
4487
+ :return: The class or default when not found.
4488
+ :rtype: typing.Any
4489
+ """
2980
4490
  ...
2981
4491
 
2982
4492
  def draw(self, context):
@@ -2986,72 +4496,129 @@ class RENDER_PT_time_stretching(
2986
4496
  """
2987
4497
  ...
2988
4498
 
2989
- def driver_add(self):
2990
- """ """
4499
+ def driver_add(self) -> bpy.types.FCurve:
4500
+ """Adds driver(s) to the given property
4501
+
4502
+ :return: The driver(s) added.
4503
+ :rtype: bpy.types.FCurve
4504
+ """
2991
4505
  ...
2992
4506
 
2993
- def driver_remove(self):
2994
- """ """
4507
+ def driver_remove(self) -> bool:
4508
+ """Remove driver(s) from the given property
4509
+
4510
+ :return: Success of driver removal.
4511
+ :rtype: bool
4512
+ """
2995
4513
  ...
2996
4514
 
2997
4515
  def get(self):
2998
- """ """
4516
+ """Returns the value of the custom property assigned to key or default
4517
+ when not found (matches Python's dictionary function of the same name).
4518
+
4519
+ """
2999
4520
  ...
3000
4521
 
3001
4522
  def id_properties_clear(self):
3002
- """ """
4523
+ """
4524
+
4525
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
4526
+ """
3003
4527
  ...
3004
4528
 
3005
4529
  def id_properties_ensure(self):
3006
- """ """
4530
+ """
4531
+
4532
+ :return: the parent group for an RNA struct's custom IDProperties.
4533
+ """
3007
4534
  ...
3008
4535
 
3009
4536
  def id_properties_ui(self):
3010
- """ """
4537
+ """
4538
+
4539
+ :return: Return an object used to manage an IDProperty's UI data.
4540
+ """
3011
4541
  ...
3012
4542
 
3013
4543
  def is_extended(self):
3014
4544
  """ """
3015
4545
  ...
3016
4546
 
3017
- def is_property_hidden(self):
3018
- """ """
4547
+ def is_property_hidden(self) -> bool:
4548
+ """Check if a property is hidden.
4549
+
4550
+ :return: True when the property is hidden.
4551
+ :rtype: bool
4552
+ """
3019
4553
  ...
3020
4554
 
3021
- def is_property_overridable_library(self):
3022
- """ """
4555
+ def is_property_overridable_library(self) -> bool:
4556
+ """Check if a property is overridable.
4557
+
4558
+ :return: True when the property is overridable.
4559
+ :rtype: bool
4560
+ """
3023
4561
  ...
3024
4562
 
3025
- def is_property_readonly(self):
3026
- """ """
4563
+ def is_property_readonly(self) -> bool:
4564
+ """Check if a property is readonly.
4565
+
4566
+ :return: True when the property is readonly (not writable).
4567
+ :rtype: bool
4568
+ """
3027
4569
  ...
3028
4570
 
3029
- def is_property_set(self):
3030
- """ """
4571
+ def is_property_set(self) -> bool:
4572
+ """Check if a property is set, use for testing operator properties.
4573
+
4574
+ :return: True when the property has been set.
4575
+ :rtype: bool
4576
+ """
3031
4577
  ...
3032
4578
 
3033
4579
  def items(self):
3034
- """ """
4580
+ """Returns the items of this objects custom properties (matches Python's
4581
+ dictionary function of the same name).
4582
+
4583
+ :return: custom property key, value pairs.
4584
+ """
3035
4585
  ...
3036
4586
 
3037
- def keyframe_delete(self):
3038
- """ """
4587
+ def keyframe_delete(self) -> bool:
4588
+ """Remove a keyframe from this properties fcurve.
4589
+
4590
+ :return: Success of keyframe deletion.
4591
+ :rtype: bool
4592
+ """
3039
4593
  ...
3040
4594
 
3041
- def keyframe_insert(self):
3042
- """ """
4595
+ def keyframe_insert(self) -> bool:
4596
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
4597
+
4598
+ :return: Success of keyframe insertion.
4599
+ :rtype: bool
4600
+ """
3043
4601
  ...
3044
4602
 
3045
4603
  def keys(self):
3046
- """ """
4604
+ """Returns the keys of this objects custom properties (matches Python's
4605
+ dictionary function of the same name).
4606
+
4607
+ :return: custom property keys.
4608
+ """
3047
4609
  ...
3048
4610
 
3049
- def path_from_id(self):
3050
- """ """
4611
+ def path_from_id(self) -> str:
4612
+ """Returns the data path from the ID to this object (string).
4613
+
4614
+ :return: The path from `bpy.types.bpy_struct.id_data`
4615
+ to this struct and property (when given).
4616
+ :rtype: str
4617
+ """
3051
4618
  ...
3052
4619
 
3053
4620
  def path_resolve(self):
3054
- """ """
4621
+ """Returns the property from the path, raise an exception when not found."""
3055
4622
  ...
3056
4623
 
3057
4624
  def poll(self, context):
@@ -3062,35 +4629,51 @@ class RENDER_PT_time_stretching(
3062
4629
  ...
3063
4630
 
3064
4631
  def pop(self):
3065
- """ """
4632
+ """Remove and return the value of the custom property assigned to key or default
4633
+ when not found (matches Python's dictionary function of the same name).
4634
+
4635
+ """
3066
4636
  ...
3067
4637
 
3068
4638
  def prepend(self, draw_func):
3069
- """
4639
+ """Prepend a draw function to this menu, takes the same arguments as
4640
+ the menus draw function
3070
4641
 
3071
- :param draw_func:
4642
+ :param draw_func:
3072
4643
  """
3073
4644
  ...
3074
4645
 
3075
- def property_overridable_library_set(self):
3076
- """ """
4646
+ def property_overridable_library_set(self) -> bool:
4647
+ """Define a property as overridable or not (only for custom properties!).
4648
+
4649
+ :return: True when the overridable status of the property was successfully set.
4650
+ :rtype: bool
4651
+ """
3077
4652
  ...
3078
4653
 
3079
4654
  def property_unset(self):
3080
- """ """
4655
+ """Unset a property, will use default value afterward."""
3081
4656
  ...
3082
4657
 
3083
4658
  def remove(self, draw_func):
3084
- """
4659
+ """Remove a draw function that has been added to this menu
3085
4660
 
3086
4661
  :param draw_func:
3087
4662
  """
3088
4663
  ...
3089
4664
 
3090
4665
  def type_recast(self):
3091
- """ """
4666
+ """Return a new instance, this is needed because types
4667
+ such as textures can be changed at runtime.
4668
+
4669
+ :return: a new instance of this object with the type initialized again.
4670
+ """
3092
4671
  ...
3093
4672
 
3094
4673
  def values(self):
3095
- """ """
4674
+ """Returns the values of this objects custom properties (matches Python's
4675
+ dictionary function of the same name).
4676
+
4677
+ :return: custom property values.
4678
+ """
3096
4679
  ...