godotengine / godotengine/godot-docs

Inaccurate hint to VK_EXT_DEBUG_UTILS_EXTENSION_NAME in draw_command_begin_label

Open
#11,778 0 comments 0 reactions 0 assignees View on GitHub
area:class reference bug
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**
4.6

**Issue description:**
The documented prerequisite for `draw_command_begin_label` seems to be inaccurate. The method documentation states:

> The VK_EXT_DEBUG_UTILS_EXTENSION_NAME Vulkan extension must be available and enabled for command buffer debug label region to work. See also [draw_command_end_label()](https://docs.godotengine.org/en/stable/classes/class_renderingdevice.html#class-renderingdevice-method-draw-command-end-label).

From my testing and understanding however, a godot user can't directly enable the vulkan extension. Rather, there are two ways which are more accurately described in the docs for `set_resource_name`:

> Note: Resource names are only set when the engine runs in verbose mode ([OS.is_stdout_verbose()](https://docs.godotengine.org/en/stable/classes/class_os.html#class-os-method-is-stdout-verbose) = true), or when using an engine build compiled with the dev_mode=yes SCons option. The graphics driver must also support the VK_EXT_DEBUG_UTILS_EXTENSION_NAME Vulkan extension for named resources to work.

Maybe the doc for `draw_command_begin_label` should just be the same?

**URL to the documentation page (if already existing):**
* https://docs.godotengine.org/en/stable/classes/class_renderingdevice.html#class-renderingdevice-method-draw-command-begin-label

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.