Blender V5.3
gpu_py_storagebuffer.cc File Reference
#include <Python.h>
#include "BLI_math_base_c.hh"
#include "BLI_string_utf8.hh"
#include "BLI_vector.hh"
#include "MEM_guardedalloc.h"
#include "GPU_context.hh"
#include "GPU_storage_buffer.hh"
#include "GPU_texture.hh"
#include "../generic/python_compat.hh"
#include "gpu_py.hh"
#include "gpu_py_buffer.hh"
#include "gpu_py_storagebuffer.hh"

Go to the source code of this file.

Namespaces

namespace  blender
 BMesh Iterators.

Functions

Public API
PyObject * blender::BPyGPUStorageBuf_CreatePyObject (gpu::StorageBuf *ssbo)

gpu::StorageBuf Common Utilities

#define BPYGPU_STORAGEBUF_CHECK_OBJ(bpygpu)
static int blender::pygpu_storagebuffer_valid_check (BPyGPUStorageBuf *bpygpu_ssbo)
static size_t blender::pygpu_storagebuffer_padded_size (const Py_buffer &pybuffer)
static const void * blender::pygpu_storagebuffer_data_padded (const Py_buffer &pybuffer, Vector< uchar > &r_padded_data)

gpu::StorageBuf Type

static PyGetSetDef blender::pygpu_storagebuffer__tp_getseters []
static PyMethodDef blender::pygpu_storagebuffer__tp_methods []
PyTypeObject blender::BPyGPUStorageBuf_Type
static PyObject * blender::pygpu_storagebuffer__tp_new (PyTypeObject *, PyObject *args, PyObject *kwds)
 blender::PyDoc_STRVAR (pygpu_storagebuffer_update_doc, ".. method:: update(data)\n" "\n" " Update the data of the storage buffer object.\n" "\n" " :param data: Data to fill the buffer.\n" " :type data: Buffer\n")
static PyObject * blender::pygpu_storagebuffer_update (BPyGPUStorageBuf *self, PyObject *obj)
 blender::PyDoc_STRVAR (pygpu_storagebuffer_clear_to_zero_doc, ".. method:: clear_to_zero()\n" "\n" " Clear the storage buffer data to zero.\n")
static PyObject * blender::pygpu_storagebuffer_clear_to_zero (BPyGPUStorageBuf *self)
 blender::PyDoc_STRVAR (pygpu_storagebuffer_read_doc, ".. method:: read()\n" "\n" " Read back the contents of the storage buffer.\n" " This waits until all GPU operations are finished, performing the necessary " "synchronization.\n" "\n" " :return: The Buffer with the read data.\n" " :rtype: :class:`gpu.types.Buffer`\n")
static PyObject * blender::pygpu_storagebuffer_read (BPyGPUStorageBuf *self)
static void blender::BPyGPUStorageBuf__tp_dealloc (BPyGPUStorageBuf *self)
 blender::PyDoc_STRVAR (pygpu_storagebuffer__tp_doc, ".. class:: GPUStorageBuf\n" "\n" " This object gives access to storage buffers.\n" "\n" " .. method:: __init__(data)\n" "\n" " :param data: Data to fill the buffer.\n" " :type data: Buffer\n")

Detailed Description

This file defines the storage buffer functionalities of the 'gpu' module

  • Use bpygpu_ for local API.
  • Use BPyGPU for public API.

Definition in file gpu_py_storagebuffer.cc.

Macro Definition Documentation

◆ BPYGPU_STORAGEBUF_CHECK_OBJ

#define BPYGPU_STORAGEBUF_CHECK_OBJ ( bpygpu)
Value:
{ \
if (pygpu_storagebuffer_valid_check(bpygpu) == -1) [[unlikely]] { \
return nullptr; \
} \
} \
((void)0)

Definition at line 53 of file gpu_py_storagebuffer.cc.

Referenced by blender::pygpu_storagebuffer_clear_to_zero(), blender::pygpu_storagebuffer_read(), and blender::pygpu_storagebuffer_update().