gpu_py_buffer.cc File Reference

#include <Python.h>
#include <algorithm>
#include "BLI_utildefines.h"
#include "MEM_guardedalloc.h"
#include "GPU_texture.hh"
#include "../generic/py_capi_utils.hh"
#include "gpu_py.hh"
#include "gpu_py_buffer.hh"

Go to the source code of this file.

Macros
#define	PYGPU_BUFFER_PROTOCOL
#define	MAX_DIMENSIONS   64

Functions
Utility Functions
static Py_ssize_t	pygpu_buffer_dimensions_tot_elem (const Py_ssize_t *shape, Py_ssize_t shape_len)
static bool	pygpu_buffer_dimensions_tot_len_compare (const Py_ssize_t *shape_a, const Py_ssize_t shape_a_len, const Py_ssize_t *shape_b, const Py_ssize_t shape_b_len)
static bool	pygpu_buffer_pyobj_as_shape (PyObject *shape_obj, Py_ssize_t r_shape[MAX_DIMENSIONS], Py_ssize_t *r_shape_len)
static const char *	pygpu_buffer_formatstr (eGPUDataFormat data_format)

BPyGPUBuffer API
static PyMethodDef	pygpu_buffer__tp_methods []
static PyGetSetDef	pygpu_buffer_getseters []
static PySequenceMethods	pygpu_buffer__tp_as_sequence
static PyMappingMethods	pygpu_buffer__tp_as_mapping
static PyBufferProcs	pygpu_buffer__tp_as_buffer
PyTypeObject	BPyGPU_BufferType
static BPyGPUBuffer *	pygpu_buffer_make_from_data (PyObject *parent, const eGPUDataFormat format, const int shape_len, const Py_ssize_t *shape, void *buf)
static PyObject *	pygpu_buffer__sq_item (BPyGPUBuffer *self, Py_ssize_t i)
static PyObject *	pygpu_buffer_to_list (BPyGPUBuffer *self)
static PyObject *	pygpu_buffer_to_list_recursive (BPyGPUBuffer *self)
static PyObject *	pygpu_buffer_dimensions_get (BPyGPUBuffer *self, void *)
static int	pygpu_buffer_dimensions_set (BPyGPUBuffer *self, PyObject *value, void *)
static int	pygpu_buffer__tp_traverse (BPyGPUBuffer *self, visitproc visit, void *arg)
static int	pygpu_buffer__tp_clear (BPyGPUBuffer *self)
static void	pygpu_buffer__tp_dealloc (BPyGPUBuffer *self)
static PyObject *	pygpu_buffer__tp_repr (BPyGPUBuffer *self)
static int	pygpu_buffer__sq_ass_item (BPyGPUBuffer *self, Py_ssize_t i, PyObject *v)
static int	pygpu_buffer_ass_slice (BPyGPUBuffer *self, Py_ssize_t begin, Py_ssize_t end, PyObject *seq)
static PyObject *	pygpu_buffer__tp_new (PyTypeObject *, PyObject *args, PyObject *kwds)
static int	pygpu_buffer__tp_is_gc (BPyGPUBuffer *self)
static Py_ssize_t	pygpu_buffer__sq_length (BPyGPUBuffer *self)
static PyObject *	pygpu_buffer_slice (BPyGPUBuffer *self, Py_ssize_t begin, Py_ssize_t end)
static PyObject *	pygpu_buffer__mp_subscript (BPyGPUBuffer *self, PyObject *item)
static int	pygpu_buffer__mp_ass_subscript (BPyGPUBuffer *self, PyObject *item, PyObject *value)
static void	pygpu_buffer_strides_calc (const eGPUDataFormat format, const int shape_len, const Py_ssize_t *shape, Py_ssize_t *r_strides)
static int	pygpu_buffer__bf_getbuffer (BPyGPUBuffer *self, Py_buffer *view, int flags)
static void	pygpu_buffer__bf_releasebuffer (PyObject *, Py_buffer *view)
	PyDoc_STRVAR (pygpu_buffer__tp_doc, ".. class:: Buffer(format, dimensions, data)\n" "\n" " For Python access to GPU functions requiring a pointer.\n" "\n" " :arg format: Format type to interpret the buffer.\n" " Possible values are ``FLOAT``, ``INT``, ``UINT``, ``UBYTE``, ``UINT_24_8`` & " "``10_11_11_REV``.\n" " ``UINT_24_8`` is deprecated, use ``FLOAT`` instead.\n" " :type format: str\n" " :arg dimensions: Array describing the dimensions.\n" " :type dimensions: int\n" " :arg data: Optional data array.\n" " :type data: Buffer | Sequence[float] | Sequence[int]\n")
static size_t	pygpu_buffer_calc_size (const int format, const int shape_len, const Py_ssize_t *shape)
size_t	bpygpu_Buffer_size (BPyGPUBuffer *buffer)
BPyGPUBuffer *	BPyGPU_Buffer_CreatePyObject (const int format, const Py_ssize_t *shape, const int shape_len, void *buffer)

Detailed Description

This file defines the gpu.state API.

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

Definition in file gpu_py_buffer.cc.

Macro Definition Documentation

MAX_DIMENSIONS

#define MAX_DIMENSIONS   64

Definition at line 31 of file gpu_py_buffer.cc.

Referenced by column_vector_multiplication(), pygpu_buffer__tp_new(), pygpu_buffer_dimensions_set(), pygpu_buffer_pyobj_as_shape(), row_vector_multiplication(), Vector_angle(), Vector_matmul(), Vector_reflect(), Vector_rotation_difference(), Vector_swizzle_get(), and Vector_swizzle_set().

PYGPU_BUFFER_PROTOCOL

#define PYGPU_BUFFER_PROTOCOL

Definition at line 30 of file gpu_py_buffer.cc.

Function Documentation

BPyGPU_Buffer_CreatePyObject()

BPyGPUBuffer * BPyGPU_Buffer_CreatePyObject ( int format, const Py_ssize_t * shape, int shape_len, void * buffer )

nodiscard

Create a buffer object

Parameters

shape	An array of shape_len integers representing the size of each dimension.
buffer	When not NULL holds a contiguous buffer with the correct format from which the buffer will be initialized

Definition at line 758 of file gpu_py_buffer.cc.

References MEM_callocN(), pygpu_buffer_calc_size(), pygpu_buffer_make_from_data(), and size().

Referenced by pygpu_buffer__tp_new(), pygpu_framebuffer_read_color(), pygpu_framebuffer_read_depth(), and pygpu_texture_read().

bpygpu_Buffer_size()

size_t bpygpu_Buffer_size ( BPyGPUBuffer * buffer )

nodiscard

Definition at line 753 of file gpu_py_buffer.cc.

References BPyGPUBuffer::format, pygpu_buffer_calc_size(), BPyGPUBuffer::shape, and BPyGPUBuffer::shape_len.

Referenced by pygpu_buffer__bf_getbuffer(), pygpu_framebuffer_read_color(), pygpu_framebuffer_read_depth(), and pygpu_texture__tp_new().

PyDoc_STRVAR()

PyDoc_STRVAR	(	pygpu_buffer__tp_doc	,
		".. class:: Buffer(format, dimensions, data)\n" "\n" " For Python access to GPU functions requiring a pointer.\n" "\n" " :arg format: Format type to interpret the buffer.\n" " Possible values are ``FLOAT``	,
		``INT``	,
		``UINT``	,
		``UBYTE``	,
		``UINT_24_8`` &" "``10_11_11_REV``.\n" " ``UINT_24_8`` is	deprecated,
		use ``FLOAT`` instead.\n" " :type format:str\n" " :arg dimensions:Array describing the dimensions.\n" " :type dimensions:int\n" " :arg data:Optional data array.\n" " :type data:Buffer|Sequence|Sequence\n"	[float][int] )

pygpu_buffer__bf_getbuffer()

int pygpu_buffer__bf_getbuffer ( BPyGPUBuffer * self, Py_buffer * view, int flags )

static

Definition at line 629 of file gpu_py_buffer.cc.

References bpygpu_Buffer_size(), GPU_texture_dataformat_size(), MEM_malloc_arrayN(), pygpu_buffer_formatstr(), pygpu_buffer_strides_calc(), self, UNLIKELY, and view.

pygpu_buffer__bf_releasebuffer()

void pygpu_buffer__bf_releasebuffer ( PyObject * , Py_buffer * view )

static

Definition at line 662 of file gpu_py_buffer.cc.

References MEM_SAFE_FREE, and view.

pygpu_buffer__mp_ass_subscript()

int pygpu_buffer__mp_ass_subscript ( BPyGPUBuffer * self, PyObject * item, PyObject * value )

static

Definition at line 530 of file gpu_py_buffer.cc.

References i, pygpu_buffer__sq_ass_item(), pygpu_buffer_ass_slice(), self, and step.

pygpu_buffer__mp_subscript()

PyObject * pygpu_buffer__mp_subscript ( BPyGPUBuffer * self, PyObject * item )

static

Definition at line 494 of file gpu_py_buffer.cc.

References i, pygpu_buffer__sq_item(), pygpu_buffer_slice(), self, and step.

pygpu_buffer__sq_ass_item()

int pygpu_buffer__sq_ass_item ( BPyGPUBuffer * self, Py_ssize_t i, PyObject * v )

static

Definition at line 459 of file gpu_py_buffer.cc.

References GPU_DATA_10_11_11_REV, GPU_DATA_FLOAT, GPU_DATA_INT, GPU_DATA_UBYTE, GPU_DATA_UINT, GPU_DATA_UINT_24_8_DEPRECATED, i, Py_DECREF(), pygpu_buffer__sq_item(), pygpu_buffer_ass_slice(), ret, self, and v.

Referenced by pygpu_buffer__mp_ass_subscript(), and pygpu_buffer_ass_slice().

pygpu_buffer__sq_item()

PyObject * pygpu_buffer__sq_item ( BPyGPUBuffer * self, Py_ssize_t i )

static

Definition at line 167 of file gpu_py_buffer.cc.

References GPU_DATA_10_11_11_REV, GPU_DATA_FLOAT, GPU_DATA_INT, GPU_DATA_UBYTE, GPU_DATA_UINT, GPU_DATA_UINT_24_8_DEPRECATED, GPU_texture_dataformat_size(), i, pygpu_buffer_formatstr(), pygpu_buffer_make_from_data(), and self.

Referenced by pygpu_buffer__mp_subscript(), pygpu_buffer__sq_ass_item(), pygpu_buffer_slice(), pygpu_buffer_to_list(), and pygpu_buffer_to_list_recursive().

pygpu_buffer__sq_length()

Py_ssize_t pygpu_buffer__sq_length ( BPyGPUBuffer * self )

static

Definition at line 437 of file gpu_py_buffer.cc.

References self.

pygpu_buffer__tp_clear()

int pygpu_buffer__tp_clear ( BPyGPUBuffer * self )

static

Definition at line 283 of file gpu_py_buffer.cc.

References self.

pygpu_buffer__tp_dealloc()

void pygpu_buffer__tp_dealloc ( BPyGPUBuffer * self )

static

Definition at line 292 of file gpu_py_buffer.cc.

References MEM_freeN(), and self.

pygpu_buffer__tp_is_gc()

int pygpu_buffer__tp_is_gc ( BPyGPUBuffer * self )

static

Definition at line 430 of file gpu_py_buffer.cc.

References self.

pygpu_buffer__tp_new()

PyObject * pygpu_buffer__tp_new ( PyTypeObject * , PyObject * args, PyObject * kwds )

static

Definition at line 368 of file gpu_py_buffer.cc.

References BPyGPU_Buffer_CreatePyObject(), bpygpu_dataformat_items, BPYGPU_IS_INIT_OR_ERROR_OBJ, GPU_DATA_FLOAT, GPU_DATA_UINT_24_8_DEPRECATED, init(), MAX_DIMENSIONS, Py_DECREF(), PyC_ParseStringEnum(), pygpu_buffer_ass_slice(), pygpu_buffer_dimensions_tot_len_compare(), pygpu_buffer_make_from_data(), pygpu_buffer_pyobj_as_shape(), and PyC_StringEnum::value_found.

pygpu_buffer__tp_repr()

PyObject * pygpu_buffer__tp_repr ( BPyGPUBuffer * self )

static

Definition at line 307 of file gpu_py_buffer.cc.

References bpygpu_dataformat_items, Py_DECREF(), PyC_StringEnum_FindIDFromValue(), pygpu_buffer_to_list_recursive(), and self.

pygpu_buffer__tp_traverse()

int pygpu_buffer__tp_traverse ( BPyGPUBuffer * self, visitproc visit, void * arg )

static

Definition at line 277 of file gpu_py_buffer.cc.

References self.

pygpu_buffer_ass_slice()

int pygpu_buffer_ass_slice ( BPyGPUBuffer * self, Py_ssize_t begin, Py_ssize_t end, PyObject * seq )

static

Definition at line 322 of file gpu_py_buffer.cc.

References begin(), count, Py_DECREF(), pygpu_buffer__sq_ass_item(), and self.

Referenced by pygpu_buffer__mp_ass_subscript(), pygpu_buffer__sq_ass_item(), and pygpu_buffer__tp_new().

pygpu_buffer_calc_size()

size_t pygpu_buffer_calc_size ( const int format, const int shape_len, const Py_ssize_t * shape )

static

Definition at line 745 of file gpu_py_buffer.cc.

References GPU_texture_dataformat_size(), and pygpu_buffer_dimensions_tot_elem().

Referenced by BPyGPU_Buffer_CreatePyObject(), and bpygpu_Buffer_size().

pygpu_buffer_dimensions_get()

PyObject * pygpu_buffer_dimensions_get ( BPyGPUBuffer * self, void *  )

static

Definition at line 242 of file gpu_py_buffer.cc.

References i, and self.

pygpu_buffer_dimensions_set()

int pygpu_buffer_dimensions_set ( BPyGPUBuffer * self, PyObject * value, void *  )

static

Definition at line 254 of file gpu_py_buffer.cc.

References MAX_DIMENSIONS, MEM_freeN(), MEM_malloc_arrayN(), pygpu_buffer_dimensions_tot_len_compare(), pygpu_buffer_pyobj_as_shape(), and self.

pygpu_buffer_dimensions_tot_elem()

Py_ssize_t pygpu_buffer_dimensions_tot_elem ( const Py_ssize_t * shape, Py_ssize_t shape_len )

static

Definition at line 37 of file gpu_py_buffer.cc.

References i.

Referenced by pygpu_buffer_calc_size(), and pygpu_buffer_dimensions_tot_len_compare().

pygpu_buffer_dimensions_tot_len_compare()

bool pygpu_buffer_dimensions_tot_len_compare ( const Py_ssize_t * shape_a, const Py_ssize_t shape_a_len, const Py_ssize_t * shape_b, const Py_ssize_t shape_b_len )

static

Definition at line 47 of file gpu_py_buffer.cc.

References pygpu_buffer_dimensions_tot_elem().

Referenced by pygpu_buffer__tp_new(), and pygpu_buffer_dimensions_set().

pygpu_buffer_formatstr()

const char * pygpu_buffer_formatstr ( eGPUDataFormat data_format )

static

Definition at line 117 of file gpu_py_buffer.cc.

References GPU_DATA_10_11_11_REV, GPU_DATA_FLOAT, GPU_DATA_INT, GPU_DATA_UBYTE, GPU_DATA_UINT, and GPU_DATA_UINT_24_8_DEPRECATED.

Referenced by pygpu_buffer__bf_getbuffer(), and pygpu_buffer__sq_item().

pygpu_buffer_make_from_data()

BPyGPUBuffer * pygpu_buffer_make_from_data ( PyObject * parent, const eGPUDataFormat format, const int shape_len, const Py_ssize_t * shape, void * buf )

static

Definition at line 143 of file gpu_py_buffer.cc.

References BPyGPUBuffer::as_void, BLI_assert, BPyGPU_BufferType, BPyGPUBuffer::buf, BPyGPUBuffer::format, MEM_malloc_arrayN(), BPyGPUBuffer::parent, BPyGPUBuffer::shape, and BPyGPUBuffer::shape_len.

Referenced by BPyGPU_Buffer_CreatePyObject(), pygpu_buffer__sq_item(), and pygpu_buffer__tp_new().

pygpu_buffer_pyobj_as_shape()

bool pygpu_buffer_pyobj_as_shape ( PyObject * shape_obj, Py_ssize_t r_shape[MAX_DIMENSIONS], Py_ssize_t * r_shape_len )

static

Definition at line 62 of file gpu_py_buffer.cc.

References i, MAX_DIMENSIONS, Py_DECREF(), and STRINGIFY.

Referenced by pygpu_buffer__tp_new(), and pygpu_buffer_dimensions_set().

pygpu_buffer_slice()

PyObject * pygpu_buffer_slice ( BPyGPUBuffer * self, Py_ssize_t begin, Py_ssize_t end )

static

Definition at line 442 of file gpu_py_buffer.cc.

References begin(), count, pygpu_buffer__sq_item(), and self.

Referenced by pygpu_buffer__mp_subscript().

pygpu_buffer_strides_calc()

void pygpu_buffer_strides_calc ( const eGPUDataFormat format, const int shape_len, const Py_ssize_t * shape, Py_ssize_t * r_strides )

static

Definition at line 617 of file gpu_py_buffer.cc.

References GPU_texture_dataformat_size(), and i.

Referenced by pygpu_buffer__bf_getbuffer().

pygpu_buffer_to_list()

PyObject * pygpu_buffer_to_list ( BPyGPUBuffer * self )

static

Definition at line 206 of file gpu_py_buffer.cc.

References i, len, pygpu_buffer__sq_item(), and self.

Referenced by pygpu_buffer_to_list_recursive().

pygpu_buffer_to_list_recursive()

PyObject * pygpu_buffer_to_list_recursive ( BPyGPUBuffer * self )

static

Definition at line 218 of file gpu_py_buffer.cc.

References i, len, Py_DECREF(), pygpu_buffer__sq_item(), pygpu_buffer_to_list(), pygpu_buffer_to_list_recursive(), and self.

Referenced by pygpu_buffer__tp_repr(), and pygpu_buffer_to_list_recursive().

Variable Documentation

BPyGPU_BufferType

PyTypeObject BPyGPU_BufferType

Definition at line 689 of file gpu_py_buffer.cc.

Referenced by bpygpu_types_init(), pygpu_buffer_make_from_data(), pygpu_framebuffer_read_color(), pygpu_framebuffer_read_depth(), and pygpu_texture__tp_new().

pygpu_buffer__tp_as_buffer

PyBufferProcs pygpu_buffer__tp_as_buffer

static

Initial value:

                                                = {
     (getbufferproc)pygpu_buffer__bf_getbuffer,
     (releasebufferproc)pygpu_buffer__bf_releasebuffer,
}

Definition at line 667 of file gpu_py_buffer.cc.

pygpu_buffer__tp_as_mapping

PyMappingMethods pygpu_buffer__tp_as_mapping

static

Initial value:

                                                    = {
     (lenfunc)pygpu_buffer__sq_length,
     (binaryfunc)pygpu_buffer__mp_subscript,
     (objobjargproc)pygpu_buffer__mp_ass_subscript,
}

Definition at line 610 of file gpu_py_buffer.cc.

pygpu_buffer__tp_as_sequence

PySequenceMethods pygpu_buffer__tp_as_sequence

static

Initial value:

                                                      = {
     (lenfunc)pygpu_buffer__sq_length,
     nullptr,
     nullptr,
     (ssizeargfunc)pygpu_buffer__sq_item,
     nullptr, 
     (ssizeobjargproc)pygpu_buffer__sq_ass_item,
     nullptr, 
     nullptr,
     nullptr,
     nullptr,
}

Definition at line 597 of file gpu_py_buffer.cc.

pygpu_buffer__tp_methods

PyMethodDef pygpu_buffer__tp_methods[]

static

Initial value:

                                            = {
    {"to_list",
     (PyCFunction)pygpu_buffer_to_list_recursive,
     METH_NOARGS,
     "return the buffer as a list"},
    {nullptr, nullptr, 0, nullptr},
}

Definition at line 572 of file gpu_py_buffer.cc.

pygpu_buffer_getseters

PyGetSetDef pygpu_buffer_getseters[]

static

Initial value:

                                          = {
    {"dimensions",
     (getter)pygpu_buffer_dimensions_get,
     (setter)pygpu_buffer_dimensions_set,
     nullptr,
     nullptr},
    {nullptr, nullptr, nullptr, nullptr, nullptr},
}

Definition at line 588 of file gpu_py_buffer.cc.