1. Epic GamesDeveloper
  3. FShaderSource

FShaderSource

Class used in shader compilation pipelines which wraps source code and ensures sufficient padding such that 16-byte wide SIMD operations on the source are guaranteed to read valid memory even if starting from the last character.

API > API/Runtime > API/Runtime/RenderCore

References

   
Module RenderCore
Header /Engine/Source/Runtime/RenderCore/Public/ShaderSource.h
Include #include "ShaderSource.h"

Syntax

class FShaderSource

Remarks

Class used in shader compilation pipelines which wraps source code and ensures sufficient padding such that 16-byte wide SIMD operations on the source are guaranteed to read valid memory even if starting from the last character.

Variables

  Type Name Description
Public variable bool bShrink  

Constructors

  Type Name Description
Public function   Construct an empty shader source object; will still contain padding
Public function  

FShaderSource ( FViewType InSrc,
int32 AdditionalSlack
)

 Given a string view construct a shader source object containing the contents of that string.

Functions

  Type Name Description
Public function void  
Public function void  
Public function CharType *

GetData ()

 Direct data pointer accessor. Will decompress data if it was previously compressed.
Public function Const int32  
Public function Static int32 Constexpr function returning the number of characters read in a single SIMD compare op
Public function Static int32 Constexpr function returning a mask value for a single character
Public function Const FViewType

GetView ()

 String view accessor. Will decompress data if it was previously compressed.
Public function Const bool  
Public function Const bool

IsEmpty ()

 IsEmpty predicate
Public function Static bool

IsWide ()

 Constexpr predicate indicating whether wide or ansi chars are used
Public function Const int32

Len ()

 Length accessor.
Public function void

Set ( FViewType InSrc,
int32 AdditionalSlack
)

 Set the given string as the contents of this shader source object.
Public function void

ShrinkToLen ( int32 Num,
EAllowShrinking AllowShrinking
)

 Reduces the set size of the stored string length, optionally shrinking the allocation.

Operators

  Type Name Description
Public function FShaderSource &

operator= ( FStringType&& InSrc
)

 Move assignment operator accepting a string object.

Typedefs

Name Description
CharType  
FCStringType  
FStringType  
FViewType  
TStringBuilder  

Constants

Name Description
ShaderSourceSimdPadding  

Deprecated Functions

  Type Name Description
Public function    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page