test2/source/blender/python/generic/imbuf_py_api.hh

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

#pragma once

/** \file
 * \ingroup pygen
 */

#include <Python.h>

struct ImBuf;

[[nodiscard]] PyObject *BPyInit_imbuf();

extern PyTypeObject Py_ImBuf_Type;

/** Return the #ImBuf or null with an error set. */
[[nodiscard]] ImBuf *BPy_ImBuf_FromPyObject(PyObject *py_imbuf);
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 */`
Python API: Initial 'imbuf' API Support only basic operations new/load/write & resize. Add now so we can extend as needed & more easily accept patches. 2018-06-07 07:41:49 +02:00
			`#pragma once`

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 pygen`
Python API: Initial 'imbuf' API Support only basic operations new/load/write & resize. Add now so we can extend as needed & more easily accept patches. 2018-06-07 07:41:49 +02:00			`*/`

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>`

PyAPI: add blf.bind_imbuf(..) context manager Add support for using BLF to draw into an ImBuf image buffer. Once the imbuf context has been set, draw calls for that font_id will draw into the image. This works by binding an imbuf to BLF which is then used as the target when drawing. ``` with blf.bind_imbuf(font_id, imbuf): blf.draw_buffer(font_id, text) ``` See the example in the Python API documentation for reference. The following BLF API's have been added to support a Python context manager. - `BLF_buffer_state_push`. - `BLF_buffer_state_pop` - `BLF_buffer_state_free` Ref !135772 2025-03-15 08:58:50 +11:00			`struct ImBuf;`

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 *BPyInit_imbuf();`
Python API: Initial 'imbuf' API Support only basic operations new/load/write & resize. Add now so we can extend as needed & more easily accept patches. 2018-06-07 07:41:49 +02:00
Cleanup: declare vars or make static 2018-08-01 08:57:31 +10:00			`extern PyTypeObject Py_ImBuf_Type;`
PyAPI: add blf.bind_imbuf(..) context manager Add support for using BLF to draw into an ImBuf image buffer. Once the imbuf context has been set, draw calls for that font_id will draw into the image. This works by binding an imbuf to BLF which is then used as the target when drawing. ``` with blf.bind_imbuf(font_id, imbuf): blf.draw_buffer(font_id, text) ``` See the example in the Python API documentation for reference. The following BLF API's have been added to support a Python context manager. - `BLF_buffer_state_push`. - `BLF_buffer_state_pop` - `BLF_buffer_state_free` Ref !135772 2025-03-15 08:58:50 +11:00
			`/** Return the #ImBuf or null with an error set. */`
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]] ImBuf BPy_ImBuf_FromPyObject(PyObject py_imbuf);`