Differential D8826 Diff 33936 source/blender/python/gpu/gpu_py_uniformbuffer.c

Changeset View

Standalone View

source/blender/python/gpu/gpu_py_uniformbuffer.c

This file was added.

				/*
				* This program is free software; you can redistribute it and/or
				* modify it under the terms of the GNU General Public License
				* as published by the Free Software Foundation; either version 2
				* of the License, or (at your option) any later version.
				*
				* This program is distributed in the hope that it will be useful,
				* but WITHOUT ANY WARRANTY; without even the implied warranty of
				* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
				* GNU General Public License for more details.
				*
				* You should have received a copy of the GNU General Public License
				* along with this program; if not, write to the Free Software Foundation,
				* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
				*/

				/** \file
				* \ingroup bpygpu
				*
				* This file defines the uniform buffer functionalities of the 'gpu' module
				*
				* - Use ``bpygpu_`` for local API.
				* - Use ``BPyGPU`` for public API.
				*/

				#include <Python.h>

				#include "GPU_context.h"
				#include "GPU_texture.h"
				#include "GPU_uniform_buffer.h"

				#include "../generic/py_capi_utils.h"

				#include "gpu_py.h"
				#include "gpu_py_api.h"
				#include "gpu_py_buffer.h"

				#include "gpu_py_uniformbuffer.h" /* own include */

				/* -------------------------------------------------------------------- */
				/** \name GPUUniformBuf Common Utilities
				* \{ */

				static int py_uniformbuffer_valid_check(BPyGPUUniformBuf *bpygpu_ub)
				{
				if (UNLIKELY(bpygpu_ub->ubo == NULL)) {
				PyErr_SetString(PyExc_ReferenceError,
				"GPU uniform buffer was freed, no further access is valid");
				return -1;
				}
				return 0;
				}

				#define PY_UNIFORMBUF_CHECK_OBJ(bpygpu) \
				{ \
				if (UNLIKELY(py_uniformbuffer_valid_check(bpygpu) == -1)) { \
				return NULL; \
				} \
				} \
				((void)0)

				/** \} */

				/* -------------------------------------------------------------------- */
				/** \name GPUUniformBuf Type
				* \{ */

				static PyObject py_uniformbuffer_new(PyTypeObject UNUSED(self), PyObject args, PyObject kwds)
				{
				BPYGPU_IS_INIT_OR_ERROR_OBJ;

				GPUUniformBuf *ubo = NULL;
				PyBuffer *pybuffer_obj;
				char err_out[256] = "unknown error. See console";
				campbellbartonUnsubmitted Done Inline Actions Don't use `py_` or `Py` prefix for Blender API's, same with other functions here. campbellbarton: Don't use `py_` or `Py` prefix for Blender API's, same with other functions here.

				static const char *_keywords[] = {"data", NULL};
				static _PyArg_Parser _parser = {"O!:GPUUniformBuf.__new__", _keywords, 0};
				if (!_PyArg_ParseTupleAndKeywordsFast(args, kwds, &_parser, &BPyGPU_BufferType, &pybuffer_obj)) {
				return NULL;
				}

				if (GPU_context_active_get()) {
				ubo = GPU_uniformbuf_create_ex(
				bpygpu_Buffer_size(pybuffer_obj), pybuffer_obj->buf.asvoid, "python_uniformbuffer");
				}
				else {
				strncpy(err_out, "No active GPU context found", 256);
				}

				if (ubo == NULL) {
				PyErr_Format(PyExc_RuntimeError, "GPUUniformBuf.__new__(...) failed with '%s'", err_out);
				return NULL;
				}
				campbellbartonUnsubmitted Done Inline Actions Use `BLI_strncpy`, use `sizeof(err_out)`. campbellbarton: Use `BLI_strncpy`, use `sizeof(err_out)`.

				return BPyGPUUniformBuf_CreatePyObject(ubo);
				}

				PyDoc_STRVAR(py_uniformbuffer_update_doc,
				".. method::update(data)\n"
				"\n"
				" Update the data of the uniform buffer object.\n");
				static PyObject py_uniformbuffer_update(BPyGPUUniformBuf self, PyObject *obj)
				{
				PY_UNIFORMBUF_CHECK_OBJ(self);

				if (!BPyGPU_Buffer_Check(obj)) {
				return NULL;
				}

				GPU_uniformbuf_update(self->ubo, ((PyBuffer *)obj)->buf.asvoid);
				Py_RETURN_NONE;
				}

				PyDoc_STRVAR(py_uniformbuffer_free_doc,
				".. method::free()\n"
				"\n"
				" Free the uniform buffer object.\n"
				" The uniform buffer object will no longer be accessible.\n");
				static PyObject py_uniformbuffer_free(BPyGPUUniformBuf self)
				{
				PY_UNIFORMBUF_CHECK_OBJ(self);

				GPU_uniformbuf_free(self->ubo);
				self->ubo = NULL;
				Py_RETURN_NONE;
				}

				static void BPyGPUUniformBuf__tp_dealloc(BPyGPUUniformBuf *self)
				{
				if (self->ubo) {
				GPU_uniformbuf_free(self->ubo);
				}
				Py_TYPE(self)->tp_free((PyObject *)self);
				}

				static PyGetSetDef py_uniformbuffer_getseters[] = {
				{NULL, NULL, NULL, NULL, NULL} /* Sentinel */
				};

				static struct PyMethodDef py_uniformbuffer_methods[] = {
				{"update", (PyCFunction)py_uniformbuffer_update, METH_O, py_uniformbuffer_update_doc},
				{"free", (PyCFunction)py_uniformbuffer_free, METH_NOARGS, py_uniformbuffer_free_doc},
				{NULL, NULL, 0, NULL},
				};

				PyDoc_STRVAR(py_uniformbuffer_doc,
				".. class:: GPUUniformBuf(data)\n"
				"\n"
				" This object gives access to off uniform buffers.\n"
				"\n"
				" :arg data: Buffer object.\n"
				" :type data: `Buffer`\n");
				PyTypeObject BPyGPUUniformBuf_Type = {
				PyVarObject_HEAD_INIT(NULL, 0).tp_name = "GPUUniformBuf",
				.tp_basicsize = sizeof(BPyGPUUniformBuf),
				.tp_dealloc = (destructor)BPyGPUUniformBuf__tp_dealloc,
				.tp_flags = Py_TPFLAGS_DEFAULT,
				.tp_doc = py_uniformbuffer_doc,
				.tp_methods = py_uniformbuffer_methods,
				.tp_getset = py_uniformbuffer_getseters,
				.tp_new = py_uniformbuffer_new,
				};

				/** \} */

				/* -------------------------------------------------------------------- */
				/** \name Public API
				* \{ */

				PyObject BPyGPUUniformBuf_CreatePyObject(GPUUniformBuf ubo)
				{
				BPyGPUUniformBuf *self;

				self = PyObject_New(BPyGPUUniformBuf, &BPyGPUUniformBuf_Type);
				self->ubo = ubo;

				return (PyObject *)self;
				}

				/** \} */

				#undef PY_UNIFORMBUF_CHECK_OBJ