UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
FRHIDiagnosticBuffer Class Reference

#include <RHIDiagnosticBuffer.h>

+ Inheritance diagram for FRHIDiagnosticBuffer:

Classes

struct  FLane
 
struct  FQueue
 

Public Member Functions

FString RHICORE_API GetShaderDiagnosticMessages (uint32 DeviceIndex, uint32 QueueIndex, const TCHAR *QueueName)
 

Public Attributes

FQueue * Data = nullptr
 

Static Public Attributes

static constexpr uint32 SizeInBytes = sizeof(FQueue)
 

Detailed Description

Common base for platform-specific implementations of GPU diagnostic buffer. The diagnostic buffer contains GPU messages (debug logs, shader asserts, etc.) and GPU progress breadcrumbs. This buffer is persistently mapped and can be accessed on CPU at any point, including after a GPU crash has been detected. Platform-specific code is responsible for allocating the actual underlying resource and binding it to shaders that need it. Diagnostic buffer functionality may be used independently of GPU breadcrumbs.

Member Function Documentation

◆ GetShaderDiagnosticMessages()

FString FRHIDiagnosticBuffer::GetShaderDiagnosticMessages ( uint32  DeviceIndex,
uint32  QueueIndex,
const TCHAR *  QueueName 
)

Member Data Documentation

◆ Data

FQueue* FRHIDiagnosticBuffer::Data = nullptr

◆ SizeInBytes

constexpr uint32 FRHIDiagnosticBuffer::SizeInBytes = sizeof(FQueue)
staticconstexpr
The documentation for this class was generated from the following files: