xiiGALScopedDebugGroup Class Reference

Copyright (c) Theophilus Eriata. All Rights Reserved. More...

#include <ScopedDebugGroup.h>

Public Member Functions
	xiiGALScopedDebugGroup () noexcept
	Copyright (c) Theophilus Eriata. All Rights Reserved.
	xiiGALScopedDebugGroup (xiiGALCommandList *pCommandList, xiiStringView sName, xiiColor color=xiiColor::White)
	xiiGALScopedDebugGroup (xiiGALCommandList &commandList, xiiStringView sName, xiiColor color=xiiColor::White)
	~xiiGALScopedDebugGroup ()
	Destructor, automatically ends the debug group.
	xiiGALScopedDebugGroup (xiiGALScopedDebugGroup &&rhs) noexcept
xiiGALScopedDebugGroup &	operator= (xiiGALScopedDebugGroup &&rhs) noexcept

Detailed Description

Copyright (c) Theophilus Eriata. All Rights Reserved.

A helper class for managing debug groups in a command list.

This class allows developers to create scoped debug groups, which can be useful for debugging and profiling graphics commands. When instantiated, it marks the beginning of a debug group, and when destroyed, it marks the end.

Note

This class ensures that debug groups are properly created and closed within the scope they are used.

Usage example:

{
  xiiGALScopedDebugGroup debugGroup(pCommandList, "Rendering Pass", xiiColor::Red);
  // Commands within this scope belong to the "Rendering Pass" debug group.
}

Constructor & Destructor Documentation

xiiGALScopedDebugGroup() [1/4]

XII_ALWAYS_INLINE xiiGALScopedDebugGroup::xiiGALScopedDebugGroup ( )

noexcept

Copyright (c) Theophilus Eriata. All Rights Reserved.

Default constructor.

Note

Initializes an empty debug group.

xiiGALScopedDebugGroup() [2/4]

XII_ALWAYS_INLINE xiiGALScopedDebugGroup::xiiGALScopedDebugGroup	(	xiiGALCommandList *	pCommandList,
		xiiStringView	sName,
		xiiColor	color = xiiColor::White )

Constructs a debug group with the specified name and color.

Parameters

pCommandList	- Pointer to the command list where the debug group is applied.
sName	- Name of the debug group for debugging and profiling purposes.
color	- Color used for visual representation (defaults to black).

xiiGALScopedDebugGroup() [3/4]

XII_ALWAYS_INLINE xiiGALScopedDebugGroup::xiiGALScopedDebugGroup	(	xiiGALCommandList &	commandList,
		xiiStringView	sName,
		xiiColor	color = xiiColor::White )

Constructs a debug group with the specified name and color.

Parameters

commandList	- Reference to the command list where the debug group is applied.
sName	- Name of the debug group for debugging and profiling purposes.
color	- Color used for visual representation (defaults to black).

xiiGALScopedDebugGroup() [4/4]

XII_ALWAYS_INLINE xiiGALScopedDebugGroup::xiiGALScopedDebugGroup ( xiiGALScopedDebugGroup && rhs )

noexcept

Move constructor.

Parameters

rhs	- Another debug group to move from.

Member Function Documentation

operator=()

XII_ALWAYS_INLINE xiiGALScopedDebugGroup & xiiGALScopedDebugGroup::operator= ( xiiGALScopedDebugGroup && rhs )

noexcept

Move assignment operator.

Parameters

rhs	- Another debug group to move from.

Returns

Reference to this object.

---

The documentation for this class was generated from the following files:

• /home/runner/work/XII/XII/Source/Engine/GraphicsFoundation/Tools/ScopedDebugGroup.h
• /home/runner/work/XII/XII/Source/Engine/GraphicsFoundation/Tools/Implementation/ScopedDebugGroup_inl.h