/* SPDX-License-Identifier: GPL-2.0-or-later */ /** \file * \ingroup bpygpu * * This file defines the gpu.state API. * * - Use `bpygpu_` for local API. * - Use `BPyGPU` for public API. */ #include #include "GPU_framebuffer.h" #include "GPU_state.h" #include "../generic/py_capi_utils.h" #include "../generic/python_utildefines.h" #include "gpu_py_framebuffer.h" #include "gpu_py_state.h" /* own include */ /* -------------------------------------------------------------------- */ /** \name Helper Functions * \{ */ static const struct PyC_StringEnumItems pygpu_state_blend_items[] = { {GPU_BLEND_NONE, "NONE"}, {GPU_BLEND_ALPHA, "ALPHA"}, {GPU_BLEND_ALPHA_PREMULT, "ALPHA_PREMULT"}, {GPU_BLEND_ADDITIVE, "ADDITIVE"}, {GPU_BLEND_ADDITIVE_PREMULT, "ADDITIVE_PREMULT"}, {GPU_BLEND_MULTIPLY, "MULTIPLY"}, {GPU_BLEND_SUBTRACT, "SUBTRACT"}, {GPU_BLEND_INVERT, "INVERT"}, /** * These are quite special cases used inside the draw manager. * {GPU_BLEND_OIT, "OIT"}, * {GPU_BLEND_BACKGROUND, "BACKGROUND"}, * {GPU_BLEND_CUSTOM, "CUSTOM"}, */ {0, NULL}, }; static const struct PyC_StringEnumItems pygpu_state_depthtest_items[] = { {GPU_DEPTH_NONE, "NONE"}, {GPU_DEPTH_ALWAYS, "ALWAYS"}, {GPU_DEPTH_LESS, "LESS"}, {GPU_DEPTH_LESS_EQUAL, "LESS_EQUAL"}, {GPU_DEPTH_EQUAL, "EQUAL"}, {GPU_DEPTH_GREATER, "GREATER"}, {GPU_DEPTH_GREATER_EQUAL, "GREATER_EQUAL"}, {0, NULL}, }; static const struct PyC_StringEnumItems pygpu_state_faceculling_items[] = { {GPU_CULL_NONE, "NONE"}, {GPU_CULL_FRONT, "FRONT"}, {GPU_CULL_BACK, "BACK"}, {0, NULL}, }; /** \} */ /* -------------------------------------------------------------------- */ /** \name Manage Stack * \{ */ PyDoc_STRVAR( pygpu_state_blend_set_doc, ".. function:: blend_set(mode)\n" "\n" " Defines the fixed pipeline blending equation.\n" "\n" " :arg mode: The type of blend mode.\n" " * ``NONE`` No blending.\n" " * ``ALPHA`` The original color channels are interpolated according to the alpha " "value.\n" " * ``ALPHA_PREMULT`` The original color channels are interpolated according to the " "alpha value with the new colors pre-multiplied by this value.\n" " * ``ADDITIVE`` The original color channels are added by the corresponding ones.\n" " * ``ADDITIVE_PREMULT`` The original color channels are added by the corresponding ones " "that are pre-multiplied by the alpha value.\n" " * ``MULTIPLY`` The original color channels are multiplied by the corresponding ones.\n" " * ``SUBTRACT`` The original color channels are subtracted by the corresponding ones.\n" " * ``INVERT`` The original color channels are replaced by its complementary color.\n" //" * ``OIT``.\n" //" * ``BACKGROUND`` .\n" //" * ``CUSTOM`` .\n" " :type mode: str\n"); static PyObject *pygpu_state_blend_set(PyObject *UNUSED(self), PyObject *value) { struct PyC_StringEnum pygpu_blend = {pygpu_state_blend_items}; if (!PyC_ParseStringEnum(value, &pygpu_blend)) { return NULL; } GPU_blend(pygpu_blend.value_found); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_blend_get_doc, ".. function:: blend_get()\n" "\n" " Current blending equation.\n" "\n"); static PyObject *pygpu_state_blend_get(PyObject *UNUSED(self)) { eGPUBlend blend = GPU_blend_get(); return PyUnicode_FromString(PyC_StringEnum_FindIDFromValue(pygpu_state_blend_items, blend)); } PyDoc_STRVAR(pygpu_state_clip_distances_set_doc, ".. function:: clip_distances_set(distances_enabled)\n" "\n" " Sets the number of `gl_ClipDistance` planes used for clip geometry.\n" "\n" " :arg distances_enabled: Number of clip distances enabled.\n" " :type distances_enabled: int\n"); static PyObject *pygpu_state_clip_distances_set(PyObject *UNUSED(self), PyObject *value) { int distances_enabled = (int)PyLong_AsUnsignedLong(value); if (distances_enabled == -1) { return NULL; } if (distances_enabled > 6) { PyErr_SetString(PyExc_ValueError, "too many distances enabled, max is 6"); } GPU_clip_distances(distances_enabled); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_depth_test_set_doc, ".. function:: depth_test_set(mode)\n" "\n" " Defines the depth_test equation.\n" "\n" " :arg mode: The depth test equation name.\n" " Possible values are `NONE`, `ALWAYS`, `LESS`, `LESS_EQUAL`, `EQUAL`, " "`GREATER` and `GREATER_EQUAL`.\n" " :type mode: str\n"); static PyObject *pygpu_state_depth_test_set(PyObject *UNUSED(self), PyObject *value) { struct PyC_StringEnum pygpu_depth_test = {pygpu_state_depthtest_items}; if (!PyC_ParseStringEnum(value, &pygpu_depth_test)) { return NULL; } GPU_depth_test(pygpu_depth_test.value_found); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_depth_test_get_doc, ".. function:: depth_test_get()\n" "\n" " Current depth_test equation.\n" "\n"); static PyObject *pygpu_state_depth_test_get(PyObject *UNUSED(self)) { eGPUDepthTest test = GPU_depth_test_get(); return PyUnicode_FromString(PyC_StringEnum_FindIDFromValue(pygpu_state_depthtest_items, test)); } PyDoc_STRVAR(pygpu_state_depth_mask_set_doc, ".. function:: depth_mask_set(value)\n" "\n" " Write to depth component.\n" "\n" " :arg value: True for writing to the depth component.\n" " :type near: bool\n"); static PyObject *pygpu_state_depth_mask_set(PyObject *UNUSED(self), PyObject *value) { bool write_to_depth; if (!PyC_ParseBool(value, &write_to_depth)) { return NULL; } GPU_depth_mask(write_to_depth); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_depth_mask_get_doc, ".. function:: depth_mask_get()\n" "\n" " Writing status in the depth component.\n"); static PyObject *pygpu_state_depth_mask_get(PyObject *UNUSED(self)) { return PyBool_FromLong(GPU_depth_mask_get()); } PyDoc_STRVAR(pygpu_state_viewport_set_doc, ".. function:: viewport_set(x, y, xsize, ysize)\n" "\n" " Specifies the viewport of the active framebuffer.\n" " Note: The viewport state is not saved upon framebuffer rebind.\n" "\n" " :arg x, y: lower left corner of the viewport_set rectangle, in pixels.\n" " :type x, y: int\n" " :arg xsize, ysize: width and height of the viewport_set.\n" " :type xsize, ysize: int\n"); static PyObject *pygpu_state_viewport_set(PyObject *UNUSED(self), PyObject *args) { int x, y, xsize, ysize; if (!PyArg_ParseTuple(args, "iiii:viewport_set", &x, &y, &xsize, &ysize)) { return NULL; } GPU_viewport(x, y, xsize, ysize); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_viewport_get_doc, ".. function:: viewport_get()\n" "\n" " Viewport of the active framebuffer.\n"); static PyObject *pygpu_state_viewport_get(PyObject *UNUSED(self), PyObject *UNUSED(args)) { int viewport[4]; GPU_viewport_size_get_i(viewport); PyObject *ret = PyTuple_New(4); PyTuple_SET_ITEMS(ret, PyLong_FromLong(viewport[0]), PyLong_FromLong(viewport[1]), PyLong_FromLong(viewport[2]), PyLong_FromLong(viewport[3])); return ret; } PyDoc_STRVAR(pygpu_state_line_width_set_doc, ".. function:: line_width_set(width)\n" "\n" " Specify the width of rasterized lines.\n" "\n" " :arg size: New width.\n" " :type mode: float\n"); static PyObject *pygpu_state_line_width_set(PyObject *UNUSED(self), PyObject *value) { float width = (float)PyFloat_AsDouble(value); if (PyErr_Occurred()) { return NULL; } GPU_line_width(width); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_line_width_get_doc, ".. function:: line_width_get()\n" "\n" " Current width of rasterized lines.\n"); static PyObject *pygpu_state_line_width_get(PyObject *UNUSED(self)) { float width = GPU_line_width_get(); return PyFloat_FromDouble((double)width); } PyDoc_STRVAR(pygpu_state_point_size_set_doc, ".. function:: point_size_set(size)\n" "\n" " Specify the diameter of rasterized points.\n" "\n" " :arg size: New diameter.\n" " :type mode: float\n"); static PyObject *pygpu_state_point_size_set(PyObject *UNUSED(self), PyObject *value) { float size = (float)PyFloat_AsDouble(value); if (PyErr_Occurred()) { return NULL; } GPU_point_size(size); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_color_mask_set_doc, ".. function:: color_mask_set(r, g, b, a)\n" "\n" " Enable or disable writing of frame buffer color components.\n" "\n" " :arg r, g, b, a: components red, green, blue, and alpha.\n" " :type r, g, b, a: bool\n"); static PyObject *pygpu_state_color_mask_set(PyObject *UNUSED(self), PyObject *args) { int r, g, b, a; if (!PyArg_ParseTuple(args, "pppp:color_mask_set", &r, &g, &b, &a)) { return NULL; } GPU_color_mask((bool)r, (bool)g, (bool)b, (bool)a); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_face_culling_set_doc, ".. function:: face_culling_set(culling)\n" "\n" " Specify whether none, front-facing or back-facing facets can be culled.\n" "\n" " :arg mode: `NONE`, `FRONT` or `BACK`.\n" " :type mode: str\n"); static PyObject *pygpu_state_face_culling_set(PyObject *UNUSED(self), PyObject *value) { struct PyC_StringEnum pygpu_faceculling = {pygpu_state_faceculling_items}; if (!PyC_ParseStringEnum(value, &pygpu_faceculling)) { return NULL; } GPU_face_culling(pygpu_faceculling.value_found); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_front_facing_set_doc, ".. function:: front_facing_set(invert)\n" "\n" " Specifies the orientation of front-facing polygons.\n" "\n" " :arg invert: True for clockwise polygons as front-facing.\n" " :type mode: bool\n"); static PyObject *pygpu_state_front_facing_set(PyObject *UNUSED(self), PyObject *value) { bool invert; if (!PyC_ParseBool(value, &invert)) { return NULL; } GPU_front_facing(invert); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_program_point_size_set_doc, ".. function:: program_point_size_set(enable)\n" "\n" " If enabled, the derived point size is taken from the (potentially clipped) " "shader builtin gl_PointSize.\n" "\n" " :arg enable: True for shader builtin gl_PointSize.\n" " :type enable: bool\n"); static PyObject *pygpu_state_program_point_size_set(PyObject *UNUSED(self), PyObject *value) { bool enable; if (!PyC_ParseBool(value, &enable)) { return NULL; } GPU_program_point_size(enable); Py_RETURN_NONE; } PyDoc_STRVAR(pygpu_state_framebuffer_active_get_doc, ".. function:: framebuffer_active_get(enable)\n" "\n" " Return the active frame-buffer in context.\n"); static PyObject *pygpu_state_framebuffer_active_get(PyObject *UNUSED(self)) { GPUFrameBuffer *fb = GPU_framebuffer_active_get(); return BPyGPUFrameBuffer_CreatePyObject(fb, true); } /** \} */ /* -------------------------------------------------------------------- */ /** \name Module * \{ */ static struct PyMethodDef pygpu_state__tp_methods[] = { /* Manage Stack */ {"blend_set", (PyCFunction)pygpu_state_blend_set, METH_O, pygpu_state_blend_set_doc}, {"blend_get", (PyCFunction)pygpu_state_blend_get, METH_NOARGS, pygpu_state_blend_get_doc}, {"clip_distances_set", (PyCFunction)pygpu_state_clip_distances_set, METH_O, pygpu_state_clip_distances_set_doc}, {"depth_test_set", (PyCFunction)pygpu_state_depth_test_set, METH_O, pygpu_state_depth_test_set_doc}, {"depth_test_get", (PyCFunction)pygpu_state_depth_test_get, METH_NOARGS, pygpu_state_depth_test_get_doc}, {"depth_mask_set", (PyCFunction)pygpu_state_depth_mask_set, METH_O, pygpu_state_depth_mask_set_doc}, {"depth_mask_get", (PyCFunction)pygpu_state_depth_mask_get, METH_NOARGS, pygpu_state_depth_mask_get_doc}, {"viewport_set", (PyCFunction)pygpu_state_viewport_set, METH_VARARGS, pygpu_state_viewport_set_doc}, {"viewport_get", (PyCFunction)pygpu_state_viewport_get, METH_NOARGS, pygpu_state_viewport_get_doc}, {"line_width_set", (PyCFunction)pygpu_state_line_width_set, METH_O, pygpu_state_line_width_set_doc}, {"line_width_get", (PyCFunction)pygpu_state_line_width_get, METH_NOARGS, pygpu_state_line_width_get_doc}, {"point_size_set", (PyCFunction)pygpu_state_point_size_set, METH_O, pygpu_state_point_size_set_doc}, {"color_mask_set", (PyCFunction)pygpu_state_color_mask_set, METH_VARARGS, pygpu_state_color_mask_set_doc}, {"face_culling_set", (PyCFunction)pygpu_state_face_culling_set, METH_O, pygpu_state_face_culling_set_doc}, {"front_facing_set", (PyCFunction)pygpu_state_front_facing_set, METH_O, pygpu_state_front_facing_set_doc}, {"program_point_size_set", (PyCFunction)pygpu_state_program_point_size_set, METH_O, pygpu_state_program_point_size_set_doc}, {"active_framebuffer_get", (PyCFunction)pygpu_state_framebuffer_active_get, METH_NOARGS, pygpu_state_framebuffer_active_get_doc}, {NULL, NULL, 0, NULL}, }; PyDoc_STRVAR(pygpu_state__tp_doc, "This module provides access to the gpu state."); static PyModuleDef pygpu_state_module_def = { PyModuleDef_HEAD_INIT, .m_name = "gpu.state", .m_doc = pygpu_state__tp_doc, .m_methods = pygpu_state__tp_methods, }; PyObject *bpygpu_state_init(void) { PyObject *submodule; submodule = PyModule_Create(&pygpu_state_module_def); return submodule; } /** \} */