3bcfb151c1
Replace plain-text type information with the type syntax used for Python's type annotations as it's more concise, especially for callbacks which often didn't include useful type information. Note that this change only applies to inline doc-strings, generated doc-strings from RNA need to be updated separately. Details: - Many minor corrections were made when "list" was incorrectly used instead of "sequence". - Some type information wasn't defined in the doc-strings and has been added. - Verbose type info would benefit from support for type aliases.
81 lines
2.5 KiB
Python
81 lines
2.5 KiB
Python
# SPDX-FileCopyrightText: 2018-2023 Blender Authors
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
__all__ = (
|
|
"batch_for_shader",
|
|
)
|
|
|
|
|
|
def batch_for_shader(shader, type, content, *, indices=None):
|
|
"""
|
|
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.
|
|
For the dictionary values see documentation for :class:`gpu.types.GPUVertBuf.attr_fill` data argument.
|
|
:type content: dict[str, Buffer | Sequence[float] | Sequence[int] | \
|
|
Sequence[Sequence[float]] | Sequence[Sequence[int]]]
|
|
:return: compatible batch
|
|
:rtype: :class:`gpu.types.GPUBatch`
|
|
"""
|
|
from gpu.types import (
|
|
GPUBatch,
|
|
GPUIndexBuf,
|
|
GPUVertBuf,
|
|
GPUVertFormat,
|
|
)
|
|
|
|
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:
|
|
item = content[attr_name][0]
|
|
while True:
|
|
attr_len *= len(item)
|
|
item = item[0]
|
|
except (TypeError, IndexError):
|
|
pass
|
|
return attr_len
|
|
|
|
def recommended_fetch_mode(comp_type):
|
|
if comp_type == 'F32':
|
|
return 'FLOAT'
|
|
return 'INT'
|
|
|
|
for data in content.values():
|
|
vbo_len = len(data)
|
|
break
|
|
else:
|
|
raise ValueError("Empty 'content'")
|
|
|
|
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))
|
|
|
|
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)
|