2023-08-16 00:20:26 +10:00
|
|
|
# SPDX-FileCopyrightText: 2018-2023 Blender Authors
|
2023-06-15 13:09:04 +10:00
|
|
|
#
|
2022-02-11 09:07:11 +11:00
|
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
2018-10-26 12:38:04 +11:00
|
|
|
|
|
|
|
__all__ = (
|
2018-11-07 15:45:28 +01:00
|
|
|
"batch_for_shader",
|
2018-10-26 12:38:04 +11:00
|
|
|
)
|
|
|
|
|
|
|
|
|
PyAPI: use keyword only arguments
Use keyword only arguments for the following functions.
- addon_utils.module_bl_info 2nd arg `info_basis`.
- addon_utils.modules 1st `module_cache`, 2nd arg `refresh`.
- addon_utils.modules_refresh 1st arg `module_cache`.
- bl_app_template_utils.activate 1nd arg `template_id`.
- bl_app_template_utils.import_from_id 2nd arg `ignore_not_found`.
- bl_app_template_utils.import_from_path 2nd arg `ignore_not_found`.
- bl_keymap_utils.keymap_from_toolbar.generate 2nd & 3rd args `use_fallback_keys` & `use_reset`.
- bl_keymap_utils.platform_helpers.keyconfig_data_oskey_from_ctrl 2nd arg `filter_fn`.
- bl_ui_utils.bug_report_url.url_prefill_from_blender 1st arg `addon_info`.
- bmesh.types.BMFace.copy 1st & 2nd args `verts`, `edges`.
- bmesh.types.BMesh.calc_volume 1st arg `signed`.
- bmesh.types.BMesh.from_mesh 2nd..4th args `face_normals`, `use_shape_key`, `shape_key_index`.
- bmesh.types.BMesh.from_object 3rd & 4th args `cage`, `face_normals`.
- bmesh.types.BMesh.transform 2nd arg `filter`.
- bmesh.types.BMesh.update_edit_mesh 2nd & 3rd args `loop_triangles`, `destructive`.
- bmesh.types.{BMVertSeq,BMEdgeSeq,BMFaceSeq}.sort 1st & 2nd arg `key`, `reverse`.
- bmesh.utils.face_split 4th..6th args `coords`, `use_exist`, `example`.
- bpy.data.libraries.load 2nd..4th args `link`, `relative`, `assets_only`.
- bpy.data.user_map 1st..3rd args `subset`, `key_types, `value_types`.
- bpy.msgbus.subscribe_rna 5th arg `options`.
- bpy.path.abspath 2nd & 3rd args `start` & `library`.
- bpy.path.clean_name 2nd arg `replace`.
- bpy.path.ensure_ext 3rd arg `case_sensitive`.
- bpy.path.module_names 2nd arg `recursive`.
- bpy.path.relpath 2nd arg `start`.
- bpy.types.EditBone.transform 2nd & 3rd arg `scale`, `roll`.
- bpy.types.Operator.as_keywords 1st arg `ignore`.
- bpy.types.Struct.{keyframe_insert,keyframe_delete} 2nd..5th args `index`, `frame`, `group`, `options`.
- bpy.types.WindowManager.popup_menu 2nd & 3rd arg `title`, `icon`.
- bpy.types.WindowManager.popup_menu_pie 3rd & 4th arg `title`, `icon`.
- bpy.utils.app_template_paths 1st arg `subdir`.
- bpy.utils.app_template_paths 1st arg `subdir`.
- bpy.utils.blend_paths 1st..3rd args `absolute`, `packed`, `local`.
- bpy.utils.execfile 2nd arg `mod`.
- bpy.utils.keyconfig_set 2nd arg `report`.
- bpy.utils.load_scripts 1st & 2nd `reload_scripts` & `refresh_scripts`.
- bpy.utils.preset_find 3rd & 4th args `display_name`, `ext`.
- bpy.utils.resource_path 2nd & 3rd arg `major`, `minor`.
- bpy.utils.script_paths 1st..4th args `subdir`, `user_pref`, `check_all`, `use_user`.
- bpy.utils.smpte_from_frame 2nd & 3rd args `fps`, `fps_base`.
- bpy.utils.smpte_from_seconds 2nd & 3rd args `fps`, `fps_base`.
- bpy.utils.system_resource 2nd arg `subdir`.
- bpy.utils.time_from_frame 2nd & 3rd args `fps`, `fps_base`.
- bpy.utils.time_to_frame 2nd & 3rd args `fps`, `fps_base`.
- bpy.utils.units.to_string 4th..6th `precision`, `split_unit`, `compatible_unit`.
- bpy.utils.units.to_value 4th arg `str_ref_unit`.
- bpy.utils.user_resource 2nd & 3rd args `subdir`, `create`
- bpy_extras.view3d_utils.location_3d_to_region_2d 4th arg `default`.
- bpy_extras.view3d_utils.region_2d_to_origin_3d 4th arg `clamp`.
- gpu.offscreen.unbind 1st arg `restore`.
- gpu_extras.batch.batch_for_shader 4th arg `indices`.
- gpu_extras.batch.presets.draw_circle_2d 4th arg `segments`.
- gpu_extras.presets.draw_circle_2d 4th arg `segments`.
- imbuf.types.ImBuf.resize 2nd arg `resize`.
- imbuf.write 2nd arg `filepath`.
- mathutils.kdtree.KDTree.find 2nd arg `filter`.
- nodeitems_utils.NodeCategory 3rd & 4th arg `descriptions`, `items`.
- nodeitems_utils.NodeItem 2nd..4th args `label`, `settings`, `poll`.
- nodeitems_utils.NodeItemCustom 1st & 2nd arg `poll`, `draw`.
- rna_prop_ui.draw 5th arg `use_edit`.
- rna_prop_ui.rna_idprop_ui_get 2nd arg `create`.
- rna_prop_ui.rna_idprop_ui_prop_clear 3rd arg `remove`.
- rna_prop_ui.rna_idprop_ui_prop_get 3rd arg `create`.
- rna_xml.xml2rna 2nd arg `root_rna`.
- rna_xml.xml_file_write 4th arg `skip_typemap`.
2021-06-08 18:03:14 +10:00
|
|
|
def batch_for_shader(shader, type, content, *, indices=None):
|
2018-10-26 12:38:04 +11:00
|
|
|
"""
|
|
|
|
Return a batch already configured and compatible with the shader.
|
|
|
|
|
|
|
|
:arg shader: shader for which a compatible format will be computed.
|
|
|
|
:type shader: :class:`gpu.types.GPUShader`
|
|
|
|
:arg type: "'POINTS', 'LINES', 'TRIS' or 'LINES_ADJ'".
|
|
|
|
:type type: str
|
|
|
|
:arg content: Maps the name of the shader attribute with the data to fill the vertex buffer.
|
|
|
|
:type content: dict
|
|
|
|
:return: compatible batch
|
2023-04-15 21:03:47 -04:00
|
|
|
:rtype: :class:`gpu.types.GPUBatch`
|
2018-10-26 12:38:04 +11:00
|
|
|
"""
|
|
|
|
from gpu.types import (
|
|
|
|
GPUBatch,
|
|
|
|
GPUIndexBuf,
|
|
|
|
GPUVertBuf,
|
2022-09-01 08:21:10 -03:00
|
|
|
GPUVertFormat,
|
2018-10-26 12:38:04 +11:00
|
|
|
)
|
|
|
|
|
2022-09-01 08:21:10 -03:00
|
|
|
def recommended_comp_type(attr_type):
|
|
|
|
if attr_type in {'FLOAT', 'VEC2', 'VEC3', 'VEC4', 'MAT3', 'MAT4'}:
|
|
|
|
return 'F32'
|
|
|
|
if attr_type in {'UINT', 'UVEC2', 'UVEC3', 'UVEC4'}:
|
|
|
|
return 'U32'
|
|
|
|
# `attr_type` in {'INT', 'IVEC2', 'IVEC3', 'IVEC4', 'BOOL'}.
|
|
|
|
return 'I32'
|
|
|
|
|
|
|
|
def recommended_attr_len(attr_name):
|
|
|
|
attr_len = 1
|
|
|
|
try:
|
2022-10-21 14:24:18 -03:00
|
|
|
item = content[attr_name][0]
|
2022-09-01 08:21:10 -03:00
|
|
|
while True:
|
|
|
|
attr_len *= len(item)
|
|
|
|
item = item[0]
|
2022-10-21 14:24:18 -03:00
|
|
|
except (TypeError, IndexError):
|
2022-09-01 08:21:10 -03:00
|
|
|
pass
|
|
|
|
return attr_len
|
|
|
|
|
|
|
|
def recommended_fetch_mode(comp_type):
|
|
|
|
if comp_type == 'F32':
|
|
|
|
return 'FLOAT'
|
|
|
|
return 'INT'
|
|
|
|
|
2018-10-26 12:38:04 +11:00
|
|
|
for data in content.values():
|
|
|
|
vbo_len = len(data)
|
|
|
|
break
|
|
|
|
else:
|
|
|
|
raise ValueError("Empty 'content'")
|
|
|
|
|
2022-09-01 08:21:10 -03:00
|
|
|
vbo_format = GPUVertFormat()
|
|
|
|
attrs_info = shader.attrs_info_get()
|
|
|
|
for name, attr_type in attrs_info:
|
|
|
|
comp_type = recommended_comp_type(attr_type)
|
|
|
|
attr_len = recommended_attr_len(name)
|
|
|
|
vbo_format.attr_add(id=name, comp_type=comp_type, len=attr_len, fetch_mode=recommended_fetch_mode(comp_type))
|
|
|
|
|
2018-10-26 12:38:04 +11:00
|
|
|
vbo = GPUVertBuf(vbo_format, vbo_len)
|
|
|
|
|
|
|
|
for id, data in content.items():
|
|
|
|
if len(data) != vbo_len:
|
|
|
|
raise ValueError("Length mismatch for 'content' values")
|
|
|
|
vbo.attr_fill(id, data)
|
|
|
|
|
|
|
|
if indices is None:
|
|
|
|
return GPUBatch(type=type, buf=vbo)
|
|
|
|
else:
|
|
|
|
ibo = GPUIndexBuf(type=type, seq=indices)
|
|
|
|
return GPUBatch(type=type, buf=vbo, elem=ibo)
|