Pushes a named debug group onto the backend's debug-label stack. More...
#include <kanzi/gfx/commands.hpp>
Inheritance diagram for kanzi::gfx::BeginDebugScopeCommand:
Public Member Functions | |
| BeginDebugScopeCommand () | |
| Constructor. | |
 Public Member Functions inherited from kanzi::gfx::BaseCommand | |
| uint32_t | getSize () const |
| Gets the command size in bytes. | |
| uint8_t | getTag () const |
| Gets the command tag. | |
| CommandType | getType () const |
| Gets the command type. | |
| void | setTag (uint8_t tag) |
| Sets the command tag. | |
Public Attributes | |
| string_view | name |
| Label text. | |
Additional Inherited Members | |
| Protected Member Functions inherited from kanzi::gfx::BaseCommand | |
| BaseCommand (CommandType t, uint32_t s) | |
| Constructor. | |
| BaseCommand (const BaseCommand &other) | |
| Copy Constructor. | |
| BaseCommand & | operator= (const BaseCommand &other) |
| Assignment operator. | |
Detailed Description
Pushes a named debug group onto the backend's debug-label stack.
Pairs with EndDebugScopeCommand. Visible in graphics tools (RenderDoc, etc.) as a nested scope grouping subsequent commands. No-op when the backend has no debug-label support available at runtime.
The name field is a non-owning view; the underlying string storage must remain valid until the command is consumed by the backend. String literals are the easiest fit.
- Since
- Kanzi 4.1.0
Constructor & Destructor Documentation
◆ BeginDebugScopeCommand()
|
inline |
Constructor.
Member Data Documentation
◆ name
| string_view kanzi::gfx::BeginDebugScopeCommand::name |
Label text.
Caller owns the underlying storage and must keep it alive until the command is consumed.
The documentation for this struct was generated from the following file:
- kanzi/gfx/commands.hpp