UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSlateSdfGeneratorImpl Class Reference
+ Inheritance diagram for FSlateSdfGeneratorImpl:

Public Member Functions

 FSlateSdfGeneratorImpl ()
 
 ~FSlateSdfGeneratorImpl ()
 
virtual ERequestResponse Spawn (const FRequestDescriptor &InRequest, FRequestOutputInfo &OutCharInfo) override
 
virtual ERequestResponse SpawnWithPlaceholder (const FRequestDescriptor &InRequest, FRequestOutputInfo &OutCharInfo, TArray< uint8 > &OutRawPixels) override
 
virtual ERequestResponse Respawn (const FRequestDescriptor &InRequest, const FRequestOutputInfo &InCharInfo) override
 
virtual ERequestResponse MakePlaceholder (const FRequestDescriptor &InRequest, FRequestOutputInfo &OutCharInfo, TArray< uint8 > &OutRawPixels) override
 
virtual void Update (const FForEachRequestDoneCallback &InEnumerator) override
 
virtual void Flush () override
 
- Public Member Functions inherited from FSlateSdfGenerator
virtual ~FSlateSdfGenerator ()
 

Additional Inherited Members

- Public Types inherited from FSlateSdfGenerator
enum class  ERequestResponse {
  SUCCESS = 0 , SDF_UNAVAILABLE , BUSY , PLACEHOLDER_ONLY ,
  BAD_REQUEST
}
 
enum class  ESdfType { Simple , Perpendicular , MultichannelAndSimple }
 
using Ptr = TUniquePtr< FSlateSdfGenerator >
 
using FForEachRequestDoneCallback = TFunctionRef< void(const FRequestDescriptor, TArray< uint8 >)>
 
- Static Public Member Functions inherited from FSlateSdfGenerator
static Ptr create ()
 
- Protected Member Functions inherited from FSlateSdfGenerator
 FSlateSdfGenerator ()
 

Constructor & Destructor Documentation

◆ FSlateSdfGeneratorImpl()

FSlateSdfGeneratorImpl::FSlateSdfGeneratorImpl ( )

◆ ~FSlateSdfGeneratorImpl()

FSlateSdfGeneratorImpl::~FSlateSdfGeneratorImpl ( )

Member Function Documentation

◆ Flush()

void FSlateSdfGeneratorImpl::Flush ( )
overridevirtual

Flushes all started tasks.

Implements FSlateSdfGenerator.

◆ MakePlaceholder()

FSlateSdfGenerator::ERequestResponse FSlateSdfGeneratorImpl::MakePlaceholder ( const FRequestDescriptor InRequest,
FRequestOutputInfo OutCharInfo,
TArray< uint8 > &  OutRawPixels 
)
overridevirtual

Only generates a placeholder-quality signed distance field immediately into OutRawPixels without spawning.

Implements FSlateSdfGenerator.

◆ Respawn()

FSlateSdfGenerator::ERequestResponse FSlateSdfGeneratorImpl::Respawn ( const FRequestDescriptor InRequest,
const FRequestOutputInfo InCharInfo 
)
overridevirtual

Attempts to start generating again if previous attempt failed but produced a placeholder, whose FRequestOutputInfo must match.

Implements FSlateSdfGenerator.

◆ Spawn()

FSlateSdfGenerator::ERequestResponse FSlateSdfGeneratorImpl::Spawn ( const FRequestDescriptor InRequest,
FRequestOutputInfo OutCharInfo 
)
overridevirtual

Starts generating a distance field for the requested glyph.

Implements FSlateSdfGenerator.

◆ SpawnWithPlaceholder()

FSlateSdfGenerator::ERequestResponse FSlateSdfGeneratorImpl::SpawnWithPlaceholder ( const FRequestDescriptor InRequest,
FRequestOutputInfo OutCharInfo,
TArray< uint8 > &  OutRawPixels 
)
overridevirtual

Starts generating a distance field and immediately provides an approximate distance field placeholder.

Implements FSlateSdfGenerator.

◆ Update()

void FSlateSdfGeneratorImpl::Update ( const FForEachRequestDoneCallback InEnumerator)
overridevirtual

Checks for finished tasks and processes each of them by calling InEnumerator.

Implements FSlateSdfGenerator.


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