test2/source/blender/python/gpu/gpu_py_offscreen.hh

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

/** \file
 * \ingroup bpygpu
 */

#pragma once

#include <Python.h>

#include "BLI_compiler_attrs.h"

struct GPUOffScreen;
struct GPUViewport;

extern PyTypeObject BPyGPUOffScreen_Type;

#define BPyGPUOffScreen_Check(v) (Py_TYPE(v) == &BPyGPUOffScreen_Type)

struct BPyGPUOffScreen {
  PyObject_HEAD
  GPUOffScreen *ofs;
  GPUViewport *viewport;
};

[[nodiscard]] PyObject *BPyGPUOffScreen_CreatePyObject(GPUOffScreen *ofs) ATTR_NONNULL(1);
License Headers: Set copyright to "Blender Authors", add AUTHORS Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783. 2023-08-16 00:20:26 +10:00			`/* SPDX-FileCopyrightText: 2023 Blender Authors`
Cleanup: Add a copyright notice to files and use SPDX format A lot of files were missing copyright field in the header and the Blender Foundation contributed to them in a sense of bug fixing and general maintenance. This change makes it explicit that those files are at least partially copyrighted by the Blender Foundation. Note that this does not make it so the Blender Foundation is the only holder of the copyright in those files, and developers who do not have a signed contract with the foundation still hold the copyright as well. Another aspect of this change is using SPDX format for the header. We already used it for the license specification, and now we state it for the copyright as well, following the FAQ: https://reuse.software/faq/ 2023-05-31 16:19:06 +02: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`

Refactor: Make header files more clangd and clang-tidy friendly When using clangd or running clang-tidy on headers there are currently many errors. These are noisy in IDEs, make auto fixes impossible, and break features like code completion, refactoring and navigation. This makes source/blender headers work by themselves, which is generally the goal anyway. But #includes and forward declarations were often incomplete. * Add #includes and forward declarations * Add IWYU pragma: export in a few places * Remove some unused #includes (but there are many more) * Tweak ShaderCreateInfo macros to work better with clangd Some types of headers still have errors, these could be fixed or worked around with more investigation. Mostly preprocessor template headers like NOD_static_types.h. Note that that disabling WITH_UNITY_BUILD is required for clangd to work properly, otherwise compile_commands.json does not contain the information for the relevant source files. For more details see the developer docs: https://developer.blender.org/docs/handbook/tooling/clangd/ Pull Request: https://projects.blender.org/blender/blender/pulls/132608 2025-01-07 12:39:13 +01:00			`#include <Python.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 "BLI_compiler_attrs.h"`

Cleanup: Miscellaneous cleanups to newly C++ headers 2024-03-23 10:10:52 -04:00			`struct GPUOffScreen;`
			`struct GPUViewport;`

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			`extern PyTypeObject BPyGPUOffScreen_Type;`

			`#define BPyGPUOffScreen_Check(v) (Py_TYPE(v) == &BPyGPUOffScreen_Type)`
correct include guards and add checks in check_style_c.py for them. 2013-09-19 23:17:52 +00:00
Cleanup: Miscellaneous cleanups to newly C++ headers 2024-03-23 10:10:52 -04:00			`struct BPyGPUOffScreen {`
Cleanup: update clang-format so PyObject_HEAD indents properly 2021-06-24 17:10:22 +10:00			`PyObject_HEAD`
Cleanup: Miscellaneous cleanups to newly C++ headers 2024-03-23 10:10:52 -04:00			`GPUOffScreen *ofs;`
			`GPUViewport *viewport;`
			`};`
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
Cleanup: use nodiscard attribute for functions in the Python API In most (cases functions returning a PyObject pointer requires it to be used by the caller, declare functions in the Python API with the `nodiscard` attribute. 2025-06-28 00:15:23 +00:00			`[[nodiscard]] PyObject BPyGPUOffScreen_CreatePyObject(GPUOffScreen ofs) ATTR_NONNULL(1);`