imbuf_py_api.cc File Reference

#include <Python.h>
#include "BLI_rect.h"
#include "BLI_string.h"
#include "BLI_utildefines.h"
#include "py_capi_utils.hh"
#include "python_compat.hh"
#include "python_utildefines.hh"
#include "imbuf_py_api.hh"
#include "../../imbuf/IMB_imbuf.hh"
#include "../../imbuf/IMB_imbuf_types.hh"
#include "BLI_fileops.h"
#include <cerrno>
#include <fcntl.h>

Go to the source code of this file.

Classes
struct	Py_ImBuf

Functions
Module Functions
	PyDoc_STRVAR (M_imbuf_new_doc, ".. function:: new(size)\n" "\n" " Load a new image.\n" "\n" " :arg size: The size of the image in pixels.\n" " :type size: tuple[int, int]\n" " :return: the newly loaded image.\n" " :rtype: :class:`ImBuf`\n")
static PyObject *	M_imbuf_new (PyObject *, PyObject *args, PyObject *kw)
static PyObject *	imbuf_load_impl (const char *filepath)
	PyDoc_STRVAR (M_imbuf_load_doc, ".. function:: load(filepath)\n" "\n" " Load an image from a file.\n" "\n" " :arg filepath: the filepath of the image.\n" " :type filepath: str | bytes\n" " :return: the newly loaded image.\n" " :rtype: :class:`ImBuf`\n")
static PyObject *	M_imbuf_load (PyObject *, PyObject *args, PyObject *kw)
static PyObject *	imbuf_write_impl (ImBuf *ibuf, const char *filepath)
	PyDoc_STRVAR (M_imbuf_write_doc, ".. function:: write(image, filepath=image.filepath)\n" "\n" " Write an image.\n" "\n" " :arg image: the image to write.\n" " :type image: :class:`ImBuf`\n" " :arg filepath: Optional filepath of the image (fallback to the images file path).\n" " :type filepath: str | bytes | None\n")
static PyObject *	M_imbuf_write (PyObject *, PyObject *args, PyObject *kw)

Type & Utilities
#define	PY_IMBUF_CHECK_OBJ(obj)
#define	PY_IMBUF_CHECK_INT(obj)
static int	py_imbuf_valid_check (Py_ImBuf *self)

Methods
static PyMethodDef	Py_ImBuf_methods []
	PyDoc_STRVAR (py_imbuf_resize_doc, ".. method:: resize(size, method='FAST')\n" "\n" " Resize the image.\n" "\n" " :arg size: New size.\n" " :type size: tuple[int, int]\n" " :arg method: Method of resizing ('FAST', 'BILINEAR')\n" " :type method: str\n")
static PyObject *	py_imbuf_resize (Py_ImBuf *self, PyObject *args, PyObject *kw)
	PyDoc_STRVAR (py_imbuf_crop_doc, ".. method:: crop(min, max)\n" "\n" " Crop the image.\n" "\n" " :arg min: X, Y minimum.\n" " :type min: tuple[int, int]\n" " :arg max: X, Y maximum.\n" " :type max: tuple[int, int]\n")
static PyObject *	py_imbuf_crop (Py_ImBuf *self, PyObject *args, PyObject *kw)
	PyDoc_STRVAR (py_imbuf_copy_doc, ".. method:: copy()\n" "\n" " :return: A copy of the image.\n" " :rtype: :class:`ImBuf`\n")
static PyObject *	py_imbuf_copy (Py_ImBuf *self)
static PyObject *	py_imbuf_deepcopy (Py_ImBuf *self, PyObject *args)
	PyDoc_STRVAR (py_imbuf_free_doc, ".. method:: free()\n" "\n" " Clear image data immediately (causing an error on re-use).\n")
static PyObject *	py_imbuf_free (Py_ImBuf *self)

Attributes
static PyGetSetDef	Py_ImBuf_getseters []
	PyDoc_STRVAR (py_imbuf_size_doc, "size of the image in pixels.\n" "\n" ":type: pair of ints")
static PyObject *	py_imbuf_size_get (Py_ImBuf *self, void *)
	PyDoc_STRVAR (py_imbuf_ppm_doc, "pixels per meter.\n" "\n" ":type: pair of floats")
static PyObject *	py_imbuf_ppm_get (Py_ImBuf *self, void *)
static int	py_imbuf_ppm_set (Py_ImBuf *self, PyObject *value, void *)
	PyDoc_STRVAR (py_imbuf_filepath_doc, "filepath associated with this image.\n" "\n" ":type: str")
static PyObject *	py_imbuf_filepath_get (Py_ImBuf *self, void *)
static int	py_imbuf_filepath_set (Py_ImBuf *self, PyObject *value, void *)
	PyDoc_STRVAR (py_imbuf_planes_doc, "Number of bits associated with this image.\n" "\n" ":type: int")
static PyObject *	py_imbuf_planes_get (Py_ImBuf *self, void *)
	PyDoc_STRVAR (py_imbuf_channels_doc, "Number of bit-planes.\n" "\n" ":type: int")
static PyObject *	py_imbuf_channels_get (Py_ImBuf *self, void *)

Type & Implementation
PyTypeObject	Py_ImBuf_Type
static PyObject *	Py_ImBuf_CreatePyObject (ImBuf *ibuf)
static void	py_imbuf_dealloc (Py_ImBuf *self)
static PyObject *	py_imbuf_repr (Py_ImBuf *self)
static Py_hash_t	py_imbuf_hash (Py_ImBuf *self)

Module Definition (<tt>imbuf</tt>)
static PyMethodDef	IMB_methods []
static PyModuleDef	IMB_module_def
	PyDoc_STRVAR (IMB_doc, "This module provides access to Blender's image manipulation API.\n" "\n" "It provides access to image buffers outside of Blender's\n" ":class:`bpy.types.Image` data-block context.\n")
PyObject *	BPyInit_imbuf ()

Module Definition (<tt>imbuf.types</tt>)
imbuf.types module, only include this to expose access to imbuf.types.ImBuf for docs and the ability to use with built-ins such as isinstance, issubclass.
static PyModuleDef	IMB_types_module_def
static PyObject *	BPyInit_imbuf_types (void)
	PyDoc_STRVAR (IMB_types_doc, "This module provides access to image buffer types.\n" "\n" ".. note::\n" "\n" " Image buffer is also the structure used by :class:`bpy.types.Image`\n" " ID type to store and manipulate image data at runtime.\n")

Detailed Description

This file defines the 'imbuf' image manipulation module.

Definition in file imbuf_py_api.cc.

Macro Definition Documentation

PY_IMBUF_CHECK_INT

#define PY_IMBUF_CHECK_INT

(

obj

)

Value:

  if (UNLIKELY(py_imbuf_valid_check(obj) == -1)) { \
    return -1; \
  } \
  ((void)0)

Definition at line 62 of file imbuf_py_api.cc.

Referenced by py_imbuf_filepath_set(), and py_imbuf_ppm_set().

PY_IMBUF_CHECK_OBJ

#define PY_IMBUF_CHECK_OBJ

(

obj

)

Value:

  if (UNLIKELY(py_imbuf_valid_check(obj) == -1)) { \
    return nullptr; \
  } \
  ((void)0)

Definition at line 57 of file imbuf_py_api.cc.

Referenced by py_imbuf_channels_get(), py_imbuf_copy(), py_imbuf_crop(), py_imbuf_filepath_get(), py_imbuf_planes_get(), py_imbuf_ppm_get(), py_imbuf_resize(), and py_imbuf_size_get().

Function Documentation

BPyInit_imbuf()

PyObject * BPyInit_imbuf

(

)

Definition at line 665 of file imbuf_py_api.cc.

References BPyInit_imbuf_types(), IMB_module_def, and mod().

BPyInit_imbuf_types()

PyObject * BPyInit_imbuf_types ( void )

static

Definition at line 711 of file imbuf_py_api.cc.

References IMB_types_module_def, and Py_ImBuf_Type.

Referenced by BPyInit_imbuf().

imbuf_load_impl()

static PyObject * imbuf_load_impl ( const char * filepath )

static

Definition at line 509 of file imbuf_py_api.cc.

References BLI_open(), ImBuf::filepath, IB_rect, IMB_loadifffile(), O_BINARY, Py_ImBuf_CreatePyObject(), and STRNCPY.

Referenced by M_imbuf_load().

imbuf_write_impl()

static PyObject * imbuf_write_impl ( ImBuf * ibuf, const char * filepath )

static

Definition at line 566 of file imbuf_py_api.cc.

References IB_rect, and IMB_saveiff().

Referenced by M_imbuf_write().

M_imbuf_load()

static PyObject * M_imbuf_load ( PyObject * , PyObject * args, PyObject * kw )

static

Definition at line 543 of file imbuf_py_api.cc.

References imbuf_load_impl(), PY_ARG_PARSER_HEAD_COMPAT, PyC_ParseUnicodeAsBytesAndSize(), result, PyC_UnicodeAsBytesAndSize_Data::value, and PyC_UnicodeAsBytesAndSize_Data::value_coerce.

M_imbuf_new()

static PyObject * M_imbuf_new ( PyObject * , PyObject * args, PyObject * kw )

static

Definition at line 478 of file imbuf_py_api.cc.

References IB_rect, IMB_allocImBuf(), PY_ARG_PARSER_HEAD_COMPAT, Py_ImBuf_CreatePyObject(), and UNPACK2.

M_imbuf_write()

static PyObject * M_imbuf_write ( PyObject * , PyObject * args, PyObject * kw )

static

Definition at line 588 of file imbuf_py_api.cc.

References ImBuf::filepath, Py_ImBuf::ibuf, imbuf_write_impl(), PY_ARG_PARSER_HEAD_COMPAT, Py_ImBuf_Type, PyC_ParseUnicodeAsBytesAndSize_OrNone(), result, PyC_UnicodeAsBytesAndSize_Data::value, and PyC_UnicodeAsBytesAndSize_Data::value_coerce.

py_imbuf_channels_get()

static PyObject * py_imbuf_channels_get ( Py_ImBuf * self, void *  )

static

Definition at line 347 of file imbuf_py_api.cc.

References ImBuf::channels, PY_IMBUF_CHECK_OBJ, and self.

py_imbuf_copy()

static PyObject * py_imbuf_copy ( Py_ImBuf * self )

static

Definition at line 186 of file imbuf_py_api.cc.

References IMB_dupImBuf(), PY_IMBUF_CHECK_OBJ, Py_ImBuf_CreatePyObject(), self, and UNLIKELY.

Referenced by py_imbuf_deepcopy().

Py_ImBuf_CreatePyObject()

static PyObject * Py_ImBuf_CreatePyObject ( ImBuf * ibuf )

static

Definition at line 454 of file imbuf_py_api.cc.

References Py_ImBuf_Type, and self.

Referenced by imbuf_load_impl(), M_imbuf_new(), and py_imbuf_copy().

py_imbuf_crop()

static PyObject * py_imbuf_crop ( Py_ImBuf * self, PyObject * args, PyObject * kw )

static

Definition at line 142 of file imbuf_py_api.cc.

References IMB_rect_crop(), PY_ARG_PARSER_HEAD_COMPAT, PY_IMBUF_CHECK_OBJ, self, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

py_imbuf_dealloc()

static void py_imbuf_dealloc ( Py_ImBuf * self )

static

Definition at line 373 of file imbuf_py_api.cc.

References IMB_freeImBuf(), and self.

py_imbuf_deepcopy()

static PyObject * py_imbuf_deepcopy ( Py_ImBuf * self, PyObject * args )

static

Definition at line 200 of file imbuf_py_api.cc.

References py_imbuf_copy(), PyC_CheckArgs_DeepCopy(), and self.

py_imbuf_filepath_get()

static PyObject * py_imbuf_filepath_get ( Py_ImBuf * self, void *  )

static

Definition at line 300 of file imbuf_py_api.cc.

References ImBuf::filepath, PY_IMBUF_CHECK_OBJ, PyC_UnicodeFromBytes(), and self.

py_imbuf_filepath_set()

static int py_imbuf_filepath_set ( Py_ImBuf * self, PyObject * value, void *  )

static

Definition at line 307 of file imbuf_py_api.cc.

References ImBuf::filepath, PY_IMBUF_CHECK_INT, and self.

py_imbuf_free()

static PyObject * py_imbuf_free ( Py_ImBuf * self )

static

Definition at line 214 of file imbuf_py_api.cc.

References IMB_freeImBuf(), and self.

py_imbuf_hash()

static Py_hash_t py_imbuf_hash ( Py_ImBuf * self )

static

Definition at line 397 of file imbuf_py_api.cc.

References self.

py_imbuf_planes_get()

static PyObject * py_imbuf_planes_get ( Py_ImBuf * self, void *  )

static

Definition at line 334 of file imbuf_py_api.cc.

References ImBuf::planes, PY_IMBUF_CHECK_OBJ, and self.

py_imbuf_ppm_get()

static PyObject * py_imbuf_ppm_get ( Py_ImBuf * self, void *  )

static

Definition at line 267 of file imbuf_py_api.cc.

References ImBuf::ppm, PY_IMBUF_CHECK_OBJ, PyC_Tuple_Pack_F64(), and self.

py_imbuf_ppm_set()

static int py_imbuf_ppm_set ( Py_ImBuf * self, PyObject * value, void *  )

static

Definition at line 274 of file imbuf_py_api.cc.

References ImBuf::ppm, PY_IMBUF_CHECK_INT, PyC_AsArray(), and self.

py_imbuf_repr()

static PyObject * py_imbuf_repr ( Py_ImBuf * self )

static

Definition at line 383 of file imbuf_py_api.cc.

References ImBuf::filepath, self, ImBuf::x, and ImBuf::y.

py_imbuf_resize()

static PyObject * py_imbuf_resize ( Py_ImBuf * self, PyObject * args, PyObject * kw )

static

Definition at line 85 of file imbuf_py_api.cc.

References BLI_assert_unreachable, Box, IMB_scale(), Nearest, PY_ARG_PARSER_HEAD_COMPAT, PY_IMBUF_CHECK_OBJ, PyC_ParseStringEnum(), self, and UNPACK2.

py_imbuf_size_get()

static PyObject * py_imbuf_size_get ( Py_ImBuf * self, void *  )

static

Definition at line 254 of file imbuf_py_api.cc.

References PY_IMBUF_CHECK_OBJ, PyC_Tuple_Pack_I32(), self, ImBuf::x, and ImBuf::y.

py_imbuf_valid_check()

static int py_imbuf_valid_check ( Py_ImBuf * self )

static

Definition at line 46 of file imbuf_py_api.cc.

References LIKELY, and self.

PyDoc_STRVAR() [1/14]

PyDoc_STRVAR	(	IMB_doc	,
		"This module provides access to Blender's image manipulation API.\n" "\n" "It provides access to image buffers outside of Blender's\n" ":class:`bpy.types.Image` data-block context.\n"	)

PyDoc_STRVAR() [2/14]

PyDoc_STRVAR	(	IMB_types_doc	,
		"This module provides access to image buffer types.\n" "\n" ".. note::\n" "\n" " Image buffer is also the structure used by :class:`bpy.types.Image`\n" " ID type to store and manipulate image data at runtime.\n"	)

PyDoc_STRVAR() [3/14]

PyDoc_STRVAR	(	M_imbuf_load_doc	,
		".. function:: load(filepath)\n" "\n" " Load an image from a file.\n" "\n" " :arg filepath: the filepath of the image.\n" " :type filepath: str | bytes\n" " :return: the newly loaded image.\n" " :rtype: :class:`ImBuf`\n"	)

PyDoc_STRVAR() [4/14]

PyDoc_STRVAR	(	M_imbuf_new_doc	,
		".. function:: new(size)\n" "\n" " Load a new image.\n" "\n" " :arg size: The size of the image in pixels.\n" " :type size: tuple\n" " :return: the newly loaded image.\n" " :rtype: :class:`ImBuf`\n"	[int, int] )

PyDoc_STRVAR() [5/14]

PyDoc_STRVAR	(	M_imbuf_write_doc	,
		".. function:: write(image, filepath=image.filepath)\n" "\n" " Write an image.\n" "\n" " :arg image: the image to write.\n" " :type image: :class:`ImBuf`\n" " :arg filepath: Optional filepath of the image (fallback to the images file path).\n" " :type filepath: str | bytes | None\n"	)

PyDoc_STRVAR() [6/14]

PyDoc_STRVAR	(	py_imbuf_channels_doc	,
		"Number of bit-planes.\n" "\n" ":type: int"	)

PyDoc_STRVAR() [7/14]

PyDoc_STRVAR	(	py_imbuf_copy_doc	,
		".. method:: copy()\n" "\n" " :return: A copy of the image.\n" " :rtype: :class:`ImBuf`\n"	)

PyDoc_STRVAR() [8/14]

PyDoc_STRVAR	(	py_imbuf_crop_doc	,
		".. method:: crop(min, max)\n" "\n" " Crop the image.\n" "\n" " :arg min:	X,
		Y minimum.\n" " :type min:tuple\n" " :arg max:X	[int, int],
		Y maximum.\n" " :type max:tuple\n"	[int, int] )

PyDoc_STRVAR() [9/14]

PyDoc_STRVAR	(	py_imbuf_filepath_doc	,
		"filepath associated with this image.\n" "\n" ":type: str"	)

PyDoc_STRVAR() [10/14]

PyDoc_STRVAR	(	py_imbuf_free_doc	,
		".. method:: free()\n" "\n" " Clear image data immediately (causing an error on re-use).\n"	)

PyDoc_STRVAR() [11/14]

PyDoc_STRVAR	(	py_imbuf_planes_doc	,
		"Number of bits associated with this image.\n" "\n" ":type: int"	)

PyDoc_STRVAR() [12/14]

PyDoc_STRVAR	(	py_imbuf_ppm_doc	,
		"pixels per meter.\n" "\n" ":type: pair of floats"	)

PyDoc_STRVAR() [13/14]

PyDoc_STRVAR	(	py_imbuf_resize_doc	,
		".. method:: resize(size, method='FAST')\n" "\n" " Resize the image.\n" "\n" " :arg size: New size.\n" " :type size: tuple\n" " :arg method: Method of resizing ('FAST', 'BILINEAR')\n" " :type method: str\n"	[int, int] )

PyDoc_STRVAR() [14/14]

PyDoc_STRVAR	(	py_imbuf_size_doc	,
		"size of the image in pixels.\n" "\n" ":type: pair of ints"	)

Variable Documentation

IMB_methods

PyMethodDef IMB_methods[]

static

Initial value:

= {
    {"new", (PyCFunction)M_imbuf_new, METH_VARARGS | METH_KEYWORDS, M_imbuf_new_doc},
    {"load", (PyCFunction)M_imbuf_load, METH_VARARGS | METH_KEYWORDS, M_imbuf_load_doc},
    {"write", (PyCFunction)M_imbuf_write, METH_VARARGS | METH_KEYWORDS, M_imbuf_write_doc},
    {nullptr, nullptr, 0, nullptr},
}

Definition at line 635 of file imbuf_py_api.cc.

IMB_module_def

PyModuleDef IMB_module_def

static

Initial value:

= {
     PyModuleDef_HEAD_INIT,
     "imbuf",
     IMB_doc,
     0,
     IMB_methods,
     nullptr,
     nullptr,
     nullptr,
     nullptr,
}

Definition at line 653 of file imbuf_py_api.cc.

Referenced by BPyInit_imbuf().

IMB_types_module_def

PyModuleDef IMB_types_module_def

static

Initial value:

= {
     PyModuleDef_HEAD_INIT,
     "imbuf.types",
     IMB_types_doc,
     0,
     nullptr,
     nullptr,
     nullptr,
     nullptr,
     nullptr,
}

Definition at line 699 of file imbuf_py_api.cc.

Referenced by BPyInit_imbuf_types().

Py_ImBuf_getseters

PyGetSetDef Py_ImBuf_getseters[]

static

Initial value:

= {
    {"size", (getter)py_imbuf_size_get, (setter) nullptr, py_imbuf_size_doc, nullptr},
    {"ppm", (getter)py_imbuf_ppm_get, (setter)py_imbuf_ppm_set, py_imbuf_ppm_doc, nullptr},
    {"filepath",
     (getter)py_imbuf_filepath_get,
     (setter)py_imbuf_filepath_set,
     py_imbuf_filepath_doc,
     nullptr},
    {"planes", (getter)py_imbuf_planes_get, nullptr, py_imbuf_planes_doc, nullptr},
    {"channels", (getter)py_imbuf_channels_get, nullptr, py_imbuf_channels_doc, nullptr},
    {nullptr, nullptr, nullptr, nullptr, nullptr} 
}

Definition at line 354 of file imbuf_py_api.cc.

Py_ImBuf_methods

PyMethodDef Py_ImBuf_methods[]

static

Initial value:

= {
    {"resize", (PyCFunction)py_imbuf_resize, METH_VARARGS | METH_KEYWORDS, py_imbuf_resize_doc},
    {"crop", (PyCFunction)py_imbuf_crop, METH_VARARGS | METH_KEYWORDS, (char *)py_imbuf_crop_doc},
    {"free", (PyCFunction)py_imbuf_free, METH_NOARGS, py_imbuf_free_doc},
    {"copy", (PyCFunction)py_imbuf_copy, METH_NOARGS, py_imbuf_copy_doc},
    {"__copy__", (PyCFunction)py_imbuf_copy, METH_NOARGS, py_imbuf_copy_doc},
    {"__deepcopy__", (PyCFunction)py_imbuf_deepcopy, METH_VARARGS, py_imbuf_copy_doc},
    {nullptr, nullptr, 0, nullptr},
}

Definition at line 228 of file imbuf_py_api.cc.

Py_ImBuf_Type

PyTypeObject Py_ImBuf_Type

Definition at line 402 of file imbuf_py_api.cc.

Referenced by BPyInit_imbuf_types(), M_imbuf_write(), and Py_ImBuf_CreatePyObject().