PyAPI: buffer protocol support for mathutils types

Adding buffer protocol support increases the speed of copying a Vector
(3D) array into a `numpy.array` by up to x3.8.

Ref !144401
This commit is contained in:
Oxicid
2025-08-16 06:14:19 +00:00
committed by Campbell Barton
parent ebfa7edeb1
commit b856b6010e
8 changed files with 402 additions and 6 deletions

View File

@@ -499,6 +499,7 @@ static PyObject *Vector_resize(VectorObject *self, PyObject *value)
if (UNLIKELY(BaseMathObject_Prepare_ForResize(self, "Vector.resize()") == -1)) {
/* An exception has been raised. */
return nullptr;
}
@@ -1595,6 +1596,59 @@ static PyObject *Vector_str(VectorObject *self)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Vector Type: Buffer Protocol
* \{ */
static int Vector_getbuffer(PyObject *obj, Py_buffer *view, int flags)
{
VectorObject *self = (VectorObject *)obj;
if (UNLIKELY(BaseMath_Prepare_ForBufferAccess(self, view, flags) == -1)) {
return -1;
}
if (UNLIKELY(BaseMath_ReadCallback(self) == -1)) {
return -1;
}
memset(view, 0, sizeof(*view));
view->obj = (PyObject *)self;
view->buf = (void *)self->vec;
view->len = Py_ssize_t(self->vec_num * sizeof(float));
view->itemsize = sizeof(float);
view->ndim = 1;
if ((flags & PyBUF_WRITABLE) == 0) {
view->readonly = 1;
}
if (flags & PyBUF_FORMAT) {
view->format = (char *)"f";
}
self->flag |= BASE_MATH_FLAG_HAS_BUFFER_VIEW;
Py_INCREF(self);
return 0;
}
static void Vector_releasebuffer(PyObject * /*exporter*/, Py_buffer *view)
{
VectorObject *self = (VectorObject *)view->obj;
self->flag &= ~BASE_MATH_FLAG_HAS_BUFFER_VIEW;
if (view->readonly == 0) {
if (UNLIKELY(BaseMath_WriteCallback(self) == -1)) {
PyErr_Print();
}
}
}
static PyBufferProcs Vector_as_buffer = {
(getbufferproc)Vector_getbuffer,
(releasebufferproc)Vector_releasebuffer,
};
/** \} */
/* -------------------------------------------------------------------- */
/** \name Vector Type: Rich Compare
* \{ */
@@ -3411,7 +3465,7 @@ PyTypeObject vector_Type = {
/*tp_str*/ (reprfunc)Vector_str,
/*tp_getattro*/ nullptr,
/*tp_setattro*/ nullptr,
/*tp_as_buffer*/ nullptr,
/*tp_as_buffer*/ &Vector_as_buffer,
/*tp_flags*/ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
/*tp_doc*/ vector_doc,
/*tp_traverse*/ (traverseproc)BaseMathObject_traverse,