UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FShaderPreprocessOutput Class Reference

#include <ShaderPreprocessTypes.h>

Public Member Functions

 FShaderPreprocessOutput ()
 
FShaderSource::FViewType GetSourceView () const
 
FAnsiStringView GetSourceViewAnsi () const
 
FStringView GetSourceViewWide () const
 
FStringView GetUnstrippedSourceView () const
 
FShaderSourceEditSource ()
 
void ForEachLine (TFunction< void(FAnsiStringView Line, int32 LineIndex)> Callback) const
 
bool HasDirective (const FString &Directive) const
 
void VisitDirectives (TFunction< void(const FString *)> Action) const
 
void VisitDirectivesWithPrefix (const TCHAR *Prefix, TFunction< void(const FString *)> Action) const
 
void AddDirective (FString &&Directive)
 
void MoveDirectives (TArray< FString > &OutDirectives)
 
bool IsSecondary () const
 
bool GetSucceeded () const
 
void LogError (FString &&Message)
 
void LogError (FString &&FilePath, FString &&Message, FString &&LineNumberStr)
 
void LogError (FString &&FilePath, FString &&Message, int32 LineNumber)
 
TArray< FShaderCompilerError > & EditErrors ()
 
TConstArrayView< FShaderCompilerErrorGetErrors () const
 
double GetPreprocessTime () const
 
TArray< FShaderDiagnosticData > & EditDiagnosticDatas ()
 
const TArray< FShaderDiagnosticData > & GetDiagnosticDatas () const
 

Friends

class FInternalShaderCompilerFunctions
 
class FShaderCompileJob
 
FArchiveoperator<< (FArchive &Ar, FShaderPreprocessOutput &PreprocessOutput)
 

Constructor & Destructor Documentation

◆ FShaderPreprocessOutput()

FShaderPreprocessOutput::FShaderPreprocessOutput ( )
inline

Member Function Documentation

◆ AddDirective()

void FShaderPreprocessOutput::AddDirective ( FString &&  Directive)
inline

◆ EditDiagnosticDatas()

TArray< FShaderDiagnosticData > & FShaderPreprocessOutput::EditDiagnosticDatas ( )
inline

◆ EditErrors()

TArray< FShaderCompilerError > & FShaderPreprocessOutput::EditErrors ( )
inline

◆ EditSource()

FShaderSource & FShaderPreprocessOutput::EditSource ( )
inline

◆ ForEachLine()

void FShaderPreprocessOutput::ForEachLine ( TFunction< void(FAnsiStringView Line, int32 LineIndex)>  Callback) const
inline

◆ GetDiagnosticDatas()

const TArray< FShaderDiagnosticData > & FShaderPreprocessOutput::GetDiagnosticDatas ( ) const
inline

◆ GetErrors()

TConstArrayView< FShaderCompilerError > FShaderPreprocessOutput::GetErrors ( ) const
inline

◆ GetPreprocessTime()

double FShaderPreprocessOutput::GetPreprocessTime ( ) const
inline

◆ GetSourceView()

FShaderSource::FViewType FShaderPreprocessOutput::GetSourceView ( ) const
inline

◆ GetSourceViewAnsi()

FAnsiStringView FShaderPreprocessOutput::GetSourceViewAnsi ( ) const
inline

◆ GetSourceViewWide()

FStringView FShaderPreprocessOutput::GetSourceViewWide ( ) const
inline

◆ GetSucceeded()

bool FShaderPreprocessOutput::GetSucceeded ( ) const
inline

◆ GetUnstrippedSourceView()

FStringView FShaderPreprocessOutput::GetUnstrippedSourceView ( ) const
inline

◆ HasDirective()

bool FShaderPreprocessOutput::HasDirective ( const FString &  Directive) const
inline

◆ IsSecondary()

bool FShaderPreprocessOutput::IsSecondary ( ) const
inline

◆ LogError() [1/3]

void FShaderPreprocessOutput::LogError ( FString &&  FilePath,
FString &&  Message,
FString &&  LineNumberStr 
)
inline

◆ LogError() [2/3]

void FShaderPreprocessOutput::LogError ( FString &&  FilePath,
FString &&  Message,
int32  LineNumber 
)
inline

◆ LogError() [3/3]

void FShaderPreprocessOutput::LogError ( FString &&  Message)
inline

◆ MoveDirectives()

void FShaderPreprocessOutput::MoveDirectives ( TArray< FString > &  OutDirectives)
inline

◆ VisitDirectives()

void FShaderPreprocessOutput::VisitDirectives ( TFunction< void(const FString *)>  Action) const
inline

◆ VisitDirectivesWithPrefix()

void FShaderPreprocessOutput::VisitDirectivesWithPrefix ( const TCHAR Prefix,
TFunction< void(const FString *)>  Action 
) const
inline

Friends And Related Symbol Documentation

◆ FInternalShaderCompilerFunctions

◆ FShaderCompileJob

friend class FShaderCompileJob
friend

◆ operator<<

FArchive & operator<< ( FArchive Ar,
FShaderPreprocessOutput PreprocessOutput 
)
friend

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