FShaderSource Class Reference

#include <ShaderSource.h>

Public Types
typedef ANSICHAR	CharType
typedef FAnsiStringView	FViewType
typedef FAnsiString	FStringType
typedef FCStringAnsi	FCStringType
template<int NumChars>
using	TStringBuilder = TAnsiStringBuilder< NumChars >

Public Member Functions
	FShaderSource ()
RENDERCORE_API	FShaderSource (FViewType InSrc, int32 AdditionalSlack=0)
RENDERCORE_API void	Set (FViewType InSrc, int32 AdditionalSlack=0)
RENDERCORE_API FShaderSource &	operator= (FStringType &&InSrc)
void	ShrinkToLen (int32 Num, EAllowShrinking AllowShrinking=EAllowShrinking::Default)
void	ShrinkToLen (int32 Num, bool bShrink)
FViewType	GetView () const
CharType *	GetData ()
bool	IsEmpty () const
int32	Len () const
bool	IsCompressed () const
int32	GetDecompressedSize () const
RENDERCORE_API void	Compress ()
RENDERCORE_API void	Decompress ()

Static Public Member Functions
static constexpr bool	IsWide ()
static constexpr int32	GetSimdCharCount ()
static constexpr int32	GetSingleCharMask ()

Friends
FArchive &	operator<< (FArchive &Ar, FShaderSource &ShaderSource)

Member Typedef Documentation

CharType

typedef ANSICHAR FShaderSource::CharType

FCStringType

typedef FCStringAnsi FShaderSource::FCStringType

FStringType

typedef FAnsiString FShaderSource::FStringType

FViewType

typedef FAnsiStringView FShaderSource::FViewType

TStringBuilder

template<int NumChars>

using FShaderSource::TStringBuilder = TAnsiStringBuilder<NumChars>

Constructor & Destructor Documentation

FShaderSource() [1/2]

FShaderSource::FShaderSource ( )

inline

FShaderSource() [2/2]

FShaderSource::FShaderSource ( FShaderSource::FViewType  InSrc, int32  AdditionalSlack = 0  )

explicit

Member Function Documentation

Compress()

void FShaderSource::Compress

(

)

Decompress()

void FShaderSource::Decompress

(

)

GetData()

CharType * FShaderSource::GetData ( )

inline

GetDecompressedSize()

int32 FShaderSource::GetDecompressedSize ( ) const

inline

GetSimdCharCount()

static constexpr int32 FShaderSource::GetSimdCharCount ( )

inlinestaticconstexpr

Constexpr function returning the number of characters read in a single SIMD compare op

GetSingleCharMask()

static constexpr int32 FShaderSource::GetSingleCharMask ( )

inlinestaticconstexpr

Constexpr function returning a mask value for a single character

GetView()

FViewType FShaderSource::GetView ( ) const

inline

IsCompressed()

bool FShaderSource::IsCompressed ( ) const

inline

IsEmpty()

bool FShaderSource::IsEmpty ( ) const

inline

IsWide()

static constexpr bool FShaderSource::IsWide ( )

inlinestaticconstexpr

Constexpr predicate indicating whether wide or ansi chars are used

Len()

int32 FShaderSource::Len ( ) const

inline

operator=()

FShaderSource & FShaderSource::operator=

(

FShaderSource::FStringType &&

InSrc

)

Set()

void FShaderSource::Set	(	FShaderSource::FViewType	InSrc,
		int32	AdditionalSlack = 0
	)

ShrinkToLen() [1/2]

void FShaderSource::ShrinkToLen ( int32  Num, bool  bShrink  )

inline

ShrinkToLen() [2/2]

void FShaderSource::ShrinkToLen ( int32  Num, EAllowShrinking  AllowShrinking = EAllowShrinking::Default  )

inline

Friends And Related Symbol Documentation

operator<<

FArchive & operator<< ( FArchive &  Ar, FShaderSource &  ShaderSource  )

friend

---

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

• Engine/Source/Runtime/RenderCore/Public/ShaderSource.h
• Engine/Source/Runtime/RenderCore/Private/ShaderSource.cpp