test/source/blender/gpu/shaders/infos/gpu_shader_print_infos.hh

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

/** \file
 * \ingroup gpu
 */

#ifdef GPU_SHADER
#  pragma once
#  include "gpu_shader_compat.hh"

#  include "GPU_shader_shared.hh"
#endif

#include "gpu_shader_create_info.hh"

GPU_SHADER_CREATE_INFO(gpu_print)
STORAGE_BUF_FREQ(GPU_SHADER_PRINTF_SLOT, read_write, uint, gpu_print_buf[], PASS)
DEFINE_VALUE("GPU_SHADER_PRINTF_MAX_CAPACITY", STRINGIFY(GPU_SHADER_PRINTF_MAX_CAPACITY))
GPU_SHADER_CREATE_END()
GPU: Add support for in shader printf This allows much easier debugging of shader programs. Usage is as simple as adding `printf` calls inside shaders. example: `printf("Formating %d\n", my_var);` Contrary to the `drw_print`, this is not limited to draw manager shader dispatch/draws. It is compatible with any shader inside blender. Most notably, this doesn't need a viewport to display. So this can be used to debug render pipeline. Data formating is currently limited to only `%x`, `%d`, `%u` and `%f`. This could be easily extended if this is really needed. There is no type checking, so values are directly reinterpreted as specified by the printf format. The current approach for making this work is to bind a storage buffer inside `GPU_shader_bind`, making it available to any shader that needs it. The storage buffer is downloaded back to CPU after a frame or a render step and the content printed to the console. This scheduling means that you cannot rely on these printfs to detect crashes. We could add a mode to force flushing at shader binding to avoid this limitation. The values are written from the shaders in binary form and only formated on the CPU. This avoid issues with manual printing like with `drw_print`. Pull Request: https://projects.blender.org/blender/blender/pulls/125071 2024-07-19 15:48:00 +02:00			`/* SPDX-FileCopyrightText: 2024 Blender Authors`
			`*`
			`* SPDX-License-Identifier: GPL-2.0-or-later */`

			`/** \file`
			`* \ingroup gpu`
			`*/`

GPU: GLSL compilation as C++ for gpu static shaders Allow compilation of shaders using C++ for linting and IDE support. Related #127983 Pull Request: https://projects.blender.org/blender/blender/pulls/128724 2024-11-12 18:53:34 +01:00			`#ifdef GPU_SHADER`
			`# pragma once`
GPU: Split GLSL, C++ and metal shader defines This makes all the defines and boiler plate code use the generated source include system. This makes source hierarchy more understandable. Pull Request: https://projects.blender.org/blender/blender/pulls/146289 2025-09-15 17:22:19 +02:00			`# include "gpu_shader_compat.hh"`
GPU: GLSL compilation as C++ for gpu static shaders Allow compilation of shaders using C++ for linting and IDE support. Related #127983 Pull Request: https://projects.blender.org/blender/blender/pulls/128724 2024-11-12 18:53:34 +01:00
			`# include "GPU_shader_shared.hh"`
			`#endif`

GPU: Add support for in shader printf This allows much easier debugging of shader programs. Usage is as simple as adding `printf` calls inside shaders. example: `printf("Formating %d\n", my_var);` Contrary to the `drw_print`, this is not limited to draw manager shader dispatch/draws. It is compatible with any shader inside blender. Most notably, this doesn't need a viewport to display. So this can be used to debug render pipeline. Data formating is currently limited to only `%x`, `%d`, `%u` and `%f`. This could be easily extended if this is really needed. There is no type checking, so values are directly reinterpreted as specified by the printf format. The current approach for making this work is to bind a storage buffer inside `GPU_shader_bind`, making it available to any shader that needs it. The storage buffer is downloaded back to CPU after a frame or a render step and the content printed to the console. This scheduling means that you cannot rely on these printfs to detect crashes. We could add a mode to force flushing at shader binding to avoid this limitation. The values are written from the shaders in binary form and only formated on the CPU. This avoid issues with manual printing like with `drw_print`. Pull Request: https://projects.blender.org/blender/blender/pulls/125071 2024-07-19 15:48:00 +02:00			`#include "gpu_shader_create_info.hh"`

			`GPU_SHADER_CREATE_INFO(gpu_print)`
GPU: Refactor Qualifier and ImageType This allow to use types closer to GLSL in resource declaration. These are aliased for clarity in the GPU module (i.e. `isampler2D` is shortened to `Int2D`). Rel #137446 Pull Request: https://projects.blender.org/blender/blender/pulls/137954 2025-04-24 14:38:13 +02:00			`STORAGE_BUF_FREQ(GPU_SHADER_PRINTF_SLOT, read_write, uint, gpu_print_buf[], PASS)`
GPU: Use macros for create infos Mass rename create info function to use the new macros. This allows to define resources in C++ inside IDEs' precompilation system for linting purpose. This applies the following script and format afterwards: https://projects.blender.org/blender/blender/pulls/128602#issuecomment-1310597 Rel #127983 Pull Request: https://projects.blender.org/blender/blender/pulls/128602 2024-10-04 19:04:40 +02:00			`DEFINE_VALUE("GPU_SHADER_PRINTF_MAX_CAPACITY", STRINGIFY(GPU_SHADER_PRINTF_MAX_CAPACITY))`
			`GPU_SHADER_CREATE_END()`