blender-archive/source/blender/python/gpu/gpu_py_batch.h

/* SPDX-License-Identifier: GPL-2.0-or-later */

/** \file
 * \ingroup bpygpu
 */

#pragma once

#include "BLI_compiler_attrs.h"

#define USE_GPU_PY_REFERENCES

extern PyTypeObject BPyGPUBatch_Type;

#define BPyGPUBatch_Check(v) (Py_TYPE(v) == &BPyGPUBatch_Type)

typedef struct BPyGPUBatch {
  PyObject_VAR_HEAD
  /* The batch is owned, we may support thin wrapped batches later. */
  struct GPUBatch *batch;
#ifdef USE_GPU_PY_REFERENCES
  /* Just to keep a user to prevent freeing buf's we're using */
  PyObject *references;
#endif
} BPyGPUBatch;

PyObject *BPyGPUBatch_CreatePyObject(struct GPUBatch *batch) ATTR_NONNULL(1);
File headers: SPDX License migration Use a shorter/simpler license convention, stops the header taking so much space. Follow the SPDX license specification: https://spdx.org/licenses - C/C++/objc/objc++ - Python - Shell Scripts - CMake, GNUmakefile While most of the source tree has been included - `./extern/` was left out. - `./intern/cycles` & `./intern/atomic` are also excluded because they use different header conventions. doc/license/SPDX-license-identifiers.txt has been added to list SPDX all used identifiers. See P2788 for the script that automated these edits. Reviewed By: brecht, mont29, sergey Ref D14069 2022-02-11 09:07:11 +11:00			`/* SPDX-License-Identifier: GPL-2.0-or-later */`
GPU: add gpu python module with export_shader() function to export GLSL shader. shader = gpu.export_shader(scene,material) Returns the GLSL shader that blender generates to produce the visual effect of material in scene for the purpose of reusing the shader in an external engine. This function is meant to be used in a material exporter so that the GLSL shader can be exported entirely. The return value is a dictionary containing the shader source code and all associated data. The full documentation is under sphinx. Warning: there has been an API between the patch and this commit: uniform['lamp'] and uniform['image'] now return python reference to ID block instead of ID name as before. The X3D exporter that uses this function must be adapted. 2011-09-09 11:55:38 +00:00
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`
GPU: add gpu python module with export_shader() function to export GLSL shader. shader = gpu.export_shader(scene,material) Returns the GLSL shader that blender generates to produce the visual effect of material in scene for the purpose of reusing the shader in an external engine. This function is meant to be used in a material exporter so that the GLSL shader can be exported entirely. The return value is a dictionary containing the shader source code and all associated data. The full documentation is under sphinx. Warning: there has been an API between the patch and this commit: uniform['lamp'] and uniform['image'] now return python reference to ID block instead of ID name as before. The X3D exporter that uses this function must be adapted. 2011-09-09 11:55:38 +00:00			`*/`
correct include guards and add checks in check_style_c.py for them. 2013-09-19 23:17:52 +00:00
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			`#pragma once`

			`#include "BLI_compiler_attrs.h"`

			`#define USE_GPU_PY_REFERENCES`

			`extern PyTypeObject BPyGPUBatch_Type;`

			`#define BPyGPUBatch_Check(v) (Py_TYPE(v) == &BPyGPUBatch_Type)`
correct include guards and add checks in check_style_c.py for them. 2013-09-19 23:17:52 +00:00
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			`typedef struct BPyGPUBatch {`
Revert "Cleanup: add semicolon after PyObject_VAR_HEAD" This reverts commit a01bcfa6366f893fbc8fdbf537d91ece4832ea03. This causes MSVC2019 build to fail with error C2059 Unfortunately this means we have to put up with bad formatting in Python structs. 2019-05-03 18:09:04 +10:00			`PyObject_VAR_HEAD`
Cleanup: clang format 2021-04-01 11:15:47 +11:00			`/* The batch is owned, we may support thin wrapped batches later. */`
			`struct GPUBatch *batch;`
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			`#ifdef USE_GPU_PY_REFERENCES`
			`/* Just to keep a user to prevent freeing buf's we're using */`
			`PyObject *references;`
			`#endif`
			`} BPyGPUBatch;`
GPU: add gpu python module with export_shader() function to export GLSL shader. shader = gpu.export_shader(scene,material) Returns the GLSL shader that blender generates to produce the visual effect of material in scene for the purpose of reusing the shader in an external engine. This function is meant to be used in a material exporter so that the GLSL shader can be exported entirely. The return value is a dictionary containing the shader source code and all associated data. The full documentation is under sphinx. Warning: there has been an API between the patch and this commit: uniform['lamp'] and uniform['image'] now return python reference to ID block instead of ID name as before. The X3D exporter that uses this function must be adapted. 2011-09-09 11:55:38 +00:00
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			`PyObject BPyGPUBatch_CreatePyObject(struct GPUBatch batch) ATTR_NONNULL(1);`