archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity
This repository has been archived on 2023-10-09. You can view files and clone it, but cannot push or open issues or pull requests.
Files
426e2663a0891d16a497a33b273a5cee1e09f929
blender-archive/source/blender/python/gpu/gpu_py_api.c

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

91 lines
3.0 KiB
C
Raw Normal View History

PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
/*
* 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.
*/
doxygen: add newline after \file While \file doesn't need an argument, it can't have another doxy command after it.
2019-02-18 08:08:12 +11:00
/** \file
* \ingroup bpygpu
PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
*
GWN: Port to GPU module: Replace GWN prefix by GPU
2018-07-18 00:12:21 +02:00
* Experimental Python API, not considered public yet (called '_gpu'),
PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
* we may re-expose as public later.
Join the python modules `gpu` and `_gpu` into one. Maybe it's still early to set the new drawing api for python. But joining these two modules is an initial step. ``` >>> gpu. matrix select types ``` ``` >>> gpu.types.GPU Batch( OffScreen( VertBuf( VertFormat( ``` The creation of a new offscreen object is now done by the `GPUOffscreen.__new__` method. Reviewers: campbellbarton, dfelinto Reviewed By: campbellbarton, dfelinto Tags: #bf_blender_2.8 Differential Revision: https://developer.blender.org/D3667
2018-09-05 21:10:42 -03:00
*
Cleanup: use single back-tick quoting in comments While doxygen supports both, conform to our style guide. Note that single back-tick's are already used in a majority of comments.
2021-07-20 22:52:31 +10:00
* - Use `bpygpu_` for local API.
* - Use `BPyGPU` for public API.
PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
*/
#include <Python.h>
#include "BLI_utildefines.h"
#include "../generic/python_utildefines.h"
Python GPU: New 'capabilities' module This module exposes the capabilities defined in the GPU module in C. This will be useful for porting existing code in `bgl` to `gpu`. Reviewed By: fclem, brecht, campbellbarton Maniphest Tasks: T80730 Part of D11147
2021-05-14 11:15:00 -03:00
#include "gpu_py_capabilities.h"
Join the python modules `gpu` and `_gpu` into one. Maybe it's still early to set the new drawing api for python. But joining these two modules is an initial step. ``` >>> gpu. matrix select types ``` ``` >>> gpu.types.GPU Batch( OffScreen( VertBuf( VertFormat( ``` The creation of a new offscreen object is now done by the `GPUOffscreen.__new__` method. Reviewers: campbellbarton, dfelinto Reviewed By: campbellbarton, dfelinto Tags: #bf_blender_2.8 Differential Revision: https://developer.blender.org/D3667
2018-09-05 21:10:42 -03:00
#include "gpu_py_matrix.h"
Python GPU: New 'platform' module This module exposes the platform utils defined in the GPU module in C. This will be useful for porting existing code with `bgl` to `gpu`. Reviewed By: fclem, brecht, campbellbarton Maniphest Tasks: T80730 Part of D11147
2021-05-14 11:15:00 -03:00
#include "gpu_py_platform.h"
Join the python modules `gpu` and `_gpu` into one. Maybe it's still early to set the new drawing api for python. But joining these two modules is an initial step. ``` >>> gpu. matrix select types ``` ``` >>> gpu.types.GPU Batch( OffScreen( VertBuf( VertFormat( ``` The creation of a new offscreen object is now done by the `GPUOffscreen.__new__` method. Reviewers: campbellbarton, dfelinto Reviewed By: campbellbarton, dfelinto Tags: #bf_blender_2.8 Differential Revision: https://developer.blender.org/D3667
2018-09-05 21:10:42 -03:00
#include "gpu_py_select.h"
Python: gpu module: add new submodules and types This commit extends the gpu python API with: ``` gpu.types.Buffer #"__init__", "to_list" gpu.types.GPUTexture #"__init__", "clear", "read", "format" gpu.types.GPUFrameBuffer #"__init__", "bind", "clear", "is_bound", "viewport", ("__enter__", "__exit__" with "GPUFrameBufferStackContext") gpu.types.GPUUniformBuf #"__init__", "update" gpu.state #"blend_set", "blend_get", "depth_test_set", "depth_test_get", "depth_mask_set", "depth_mask_get", "viewport_set", "viewport_get", "line_width_set", "line_width_get", "point_size_set", "color_mask_set", "face_culling_set", "front_facing_set", "program_point_size_set" ``` Add these methods to existing objects: ``` gpu.types.GPUShader #"uniform_sample", "uniform_buffer" ``` Maniphest Tasks: T80481 Differential Revision: https://developer.blender.org/D8826
2021-02-17 10:48:08 -03:00
#include "gpu_py_state.h"
Join the python modules `gpu` and `_gpu` into one. Maybe it's still early to set the new drawing api for python. But joining these two modules is an initial step. ``` >>> gpu. matrix select types ``` ``` >>> gpu.types.GPU Batch( OffScreen( VertBuf( VertFormat( ``` The creation of a new offscreen object is now done by the `GPUOffscreen.__new__` method. Reviewers: campbellbarton, dfelinto Reviewed By: campbellbarton, dfelinto Tags: #bf_blender_2.8 Differential Revision: https://developer.blender.org/D3667
2018-09-05 21:10:42 -03:00
#include "gpu_py_types.h"
Revert file rename from T59773 fix Mixing file rename with other changes should be avoided. Using 'module_py_api' convention here is in keeping with imbuf, idprop, blf & bmesh. No reason for gpu to have a different convention.
2019-01-03 00:55:07 +11:00
#include "gpu_py_api.h" /* own include */
Fix T59773: Raise exception if the gpu module is used in backgound mode. Instead of crashing, an error message is displayed if a function of the gpu module is called without a GPU context. Reviewers: brecht, campbellbarton, JacquesLucke, mont29 Subscribers: abdelmatinboulbayam, amir.shehata Differential Revision: https://developer.blender.org/D4143
2019-01-02 10:01:46 -02:00
/* -------------------------------------------------------------------- */
/** \name GPU Module
* \{ */
Cleanup: Use 'pygpu_' prefix in the cpython GPU module `py_` prefix can be confused with the Python's own API's.
2021-02-17 10:16:41 -03:00
PyDoc_STRVAR(pygpu_doc,
PyDoc: resolve duplicate module warnings Remove submodule listings from the module docstring, as this information already exists in the generator.
2020-10-09 11:56:11 +11:00
"This module provides Python wrappers for the GPU implementation in Blender.\n"
"Some higher level functions can be found in the `gpu_extras` module.");
Cleanup: Use 'pygpu_' prefix in the cpython GPU module `py_` prefix can be confused with the Python's own API's.
2021-02-17 10:16:41 -03:00
static struct PyModuleDef pygpu_module_def = {
PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
PyModuleDef_HEAD_INIT,
Join the python modules `gpu` and `_gpu` into one. Maybe it's still early to set the new drawing api for python. But joining these two modules is an initial step. ``` >>> gpu. matrix select types ``` ``` >>> gpu.types.GPU Batch( OffScreen( VertBuf( VertFormat( ``` The creation of a new offscreen object is now done by the `GPUOffscreen.__new__` method. Reviewers: campbellbarton, dfelinto Reviewed By: campbellbarton, dfelinto Tags: #bf_blender_2.8 Differential Revision: https://developer.blender.org/D3667
2018-09-05 21:10:42 -03:00
.m_name = "gpu",
Cleanup: Use 'pygpu_' prefix in the cpython GPU module `py_` prefix can be confused with the Python's own API's.
2021-02-17 10:16:41 -03:00
.m_doc = pygpu_doc,
PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
};
GWN: Port to GPU module: Replace GWN prefix by GPU
2018-07-18 00:12:21 +02:00
PyObject *BPyInit_gpu(void)
PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
{
Merge branch 'master' into blender2.8
2018-09-13 17:08:58 +10:00
PyObject *sys_modules = PyImport_GetModuleDict();
PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
PyObject *submodule;
PyObject *mod;
Cleanup: Use 'pygpu_' prefix in the cpython GPU module `py_` prefix can be confused with the Python's own API's.
2021-02-17 10:16:41 -03:00
mod = PyModule_Create(&pygpu_module_def);
PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
Cleanup: Python GPU: Use consistent prefixes for local API It was not following the own documentation at the top code that mentions that for local API the prefix is "bpygpu_".
2021-02-11 13:53:20 -03:00
PyModule_AddObject(mod, "types", (submodule = bpygpu_types_init()));
PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
Python GPU: New 'capabilities' module This module exposes the capabilities defined in the GPU module in C. This will be useful for porting existing code in `bgl` to `gpu`. Reviewed By: fclem, brecht, campbellbarton Maniphest Tasks: T80730 Part of D11147
2021-05-14 11:15:00 -03:00
PyModule_AddObject(mod, "capabilities", (submodule = bpygpu_capabilities_init()));
PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
Cleanup: Python GPU: Use consistent prefixes for local API It was not following the own documentation at the top code that mentions that for local API the prefix is "bpygpu_".
2021-02-11 13:53:20 -03:00
PyModule_AddObject(mod, "matrix", (submodule = bpygpu_matrix_init()));
Join the python modules `gpu` and `_gpu` into one. Maybe it's still early to set the new drawing api for python. But joining these two modules is an initial step. ``` >>> gpu. matrix select types ``` ``` >>> gpu.types.GPU Batch( OffScreen( VertBuf( VertFormat( ``` The creation of a new offscreen object is now done by the `GPUOffscreen.__new__` method. Reviewers: campbellbarton, dfelinto Reviewed By: campbellbarton, dfelinto Tags: #bf_blender_2.8 Differential Revision: https://developer.blender.org/D3667
2018-09-05 21:10:42 -03:00
PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
Python GPU: New 'platform' module This module exposes the platform utils defined in the GPU module in C. This will be useful for porting existing code with `bgl` to `gpu`. Reviewed By: fclem, brecht, campbellbarton Maniphest Tasks: T80730 Part of D11147
2021-05-14 11:15:00 -03:00
PyModule_AddObject(mod, "platform", (submodule = bpygpu_platform_init()));
PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
Cleanup: Python GPU: Use consistent prefixes for local API It was not following the own documentation at the top code that mentions that for local API the prefix is "bpygpu_".
2021-02-11 13:53:20 -03:00
PyModule_AddObject(mod, "select", (submodule = bpygpu_select_init()));
Join the python modules `gpu` and `_gpu` into one. Maybe it's still early to set the new drawing api for python. But joining these two modules is an initial step. ``` >>> gpu. matrix select types ``` ``` >>> gpu.types.GPU Batch( OffScreen( VertBuf( VertFormat( ``` The creation of a new offscreen object is now done by the `GPUOffscreen.__new__` method. Reviewers: campbellbarton, dfelinto Reviewed By: campbellbarton, dfelinto Tags: #bf_blender_2.8 Differential Revision: https://developer.blender.org/D3667
2018-09-05 21:10:42 -03:00
PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
Cleanup: Python GPU: Use consistent prefixes for local API It was not following the own documentation at the top code that mentions that for local API the prefix is "bpygpu_".
2021-02-11 13:53:20 -03:00
PyModule_AddObject(mod, "shader", (submodule = bpygpu_shader_init()));
GPU module: Initial implementation of the `gpu.shader` submodule. Differential Revision: https://developer.blender.org/D3688
2018-09-14 09:32:19 -03:00
PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
Python: gpu module: add new submodules and types This commit extends the gpu python API with: ``` gpu.types.Buffer #"__init__", "to_list" gpu.types.GPUTexture #"__init__", "clear", "read", "format" gpu.types.GPUFrameBuffer #"__init__", "bind", "clear", "is_bound", "viewport", ("__enter__", "__exit__" with "GPUFrameBufferStackContext") gpu.types.GPUUniformBuf #"__init__", "update" gpu.state #"blend_set", "blend_get", "depth_test_set", "depth_test_get", "depth_mask_set", "depth_mask_get", "viewport_set", "viewport_get", "line_width_set", "line_width_get", "point_size_set", "color_mask_set", "face_culling_set", "front_facing_set", "program_point_size_set" ``` Add these methods to existing objects: ``` gpu.types.GPUShader #"uniform_sample", "uniform_buffer" ``` Maniphest Tasks: T80481 Differential Revision: https://developer.blender.org/D8826
2021-02-17 10:48:08 -03:00
PyModule_AddObject(mod, "state", (submodule = bpygpu_state_init()));
PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
GPU Python: Implement gpu.texture.from_image It can be useful to replace `image.bindcode` and `image.gl_load`. Used for example in https://docs.blender.org/api/current/gpu.html#d-image Reviewed By: brecht Differential Revision: https://developer.blender.org/D10458
2021-03-01 17:35:10 -03:00
PyModule_AddObject(mod, "texture", (submodule = bpygpu_texture_init()));
PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
PyAPI: Iniital gawain API for Python Wraps vertex-format, vertex-buffer and batch's (enough for drawing). Doesn't yet expose index-buffers or shaders.
2017-08-17 20:32:42 +10:00
return mod;
}
Fix T59773: Raise exception if the gpu module is used in backgound mode. Instead of crashing, an error message is displayed if a function of the gpu module is called without a GPU context. Reviewers: brecht, campbellbarton, JacquesLucke, mont29 Subscribers: abdelmatinboulbayam, amir.shehata Differential Revision: https://developer.blender.org/D4143
2019-01-02 10:01:46 -02:00
/** \} */
Copy Permalink