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

#include <Distributions.h>

+ Inheritance diagram for FComposableFloatDistribution:

Public Member Functions

 FComposableFloatDistribution ()
 
 FComposableFloatDistribution (const FComposableFloatDistribution &Other)
 
const FComposableFloatDistributionoperator= (const FComposableFloatDistribution &Other)
 
void Initialize (const class UDistributionFloat *FloatDistribution)
 
void InitializeWithConstant (float Value)
 
void ScaleByConstant (float Scale)
 
void ScaleByDistribution (const class UDistributionFloat *FloatDistribution)
 
void AddDistribution (const class UDistributionFloat *FloatDistribution)
 
void Normalize (float *OutScale, float *OutBias)
 
void Resample (float MinIn, float MaxIn)
 

Additional Inherited Members

- Static Public Member Functions inherited from FComposableDistribution
static void BuildFloat (class FFloatDistribution &OutDistribution, const class FComposableFloatDistribution &X)
 
static void BuildVector (class FVectorDistribution &OutDistribution, const class FComposableVectorDistribution &XYZ)
 
static void BuildVector4 (class FVector4Distribution &OutDistribution, const class FComposableVectorDistribution &XYZ, const class FComposableFloatDistribution &W)
 
static void BuildVector4 (class FVector4Distribution &OutDistribution, const class FComposableVectorDistribution &XY, const class FComposableFloatDistribution &Z, const class FComposableFloatDistribution &W)
 
static void BuildVector4 (class FVector4Distribution &OutDistribution, const class FComposableFloatDistribution &X, const class FComposableFloatDistribution &Y, const class FComposableFloatDistribution &Z, const class FComposableFloatDistribution &W)
 
static void QuantizeVector4 (TArray< FColor > &OutQuantizedSamples, FVector4 &OutScale, FVector4 &OutBias, const class FVector4Distribution &Distribution)
 
- Protected Member Functions inherited from FComposableDistribution
 FComposableDistribution ()
 
 ~FComposableDistribution ()
 
 FComposableDistribution (const FComposableDistribution &Other)
 
const FComposableDistributionoperator= (const FComposableDistribution &Other)
 
- Protected Attributes inherited from FComposableDistribution
FDistributionLookupTable LookupTable
 

Detailed Description

A composable floating point distribution.

Constructor & Destructor Documentation

◆ FComposableFloatDistribution() [1/2]

FComposableFloatDistribution::FComposableFloatDistribution ( )

Default constructor.

◆ FComposableFloatDistribution() [2/2]

FComposableFloatDistribution::FComposableFloatDistribution ( const FComposableFloatDistribution Other)
inline

Copy constructor.

Member Function Documentation

◆ AddDistribution()

void FComposableFloatDistribution::AddDistribution ( const class UDistributionFloat FloatDistribution)

Adds each sample in the distribution to the corresponding sample in another distribution.

◆ Initialize()

void FComposableFloatDistribution::Initialize ( const class UDistributionFloat FloatDistribution)

Initializes this distribution from that specified.

◆ InitializeWithConstant()

void FComposableFloatDistribution::InitializeWithConstant ( float  Value)

Initializes this distribution with a constant value.

◆ Normalize()

void FComposableFloatDistribution::Normalize ( float OutScale,
float OutBias 
)

Normalizes each value to [0,1] and return a scale and bias to reconstruct the original values.

◆ operator=()

const FComposableFloatDistribution & FComposableFloatDistribution::operator= ( const FComposableFloatDistribution Other)
inline

Assignment operator.

◆ Resample()

void FComposableFloatDistribution::Resample ( float  MinIn,
float  MaxIn 
)

Resamples the distribution to include only information from [MinIn,MaxIn].

◆ ScaleByConstant()

void FComposableFloatDistribution::ScaleByConstant ( float  Scale)

Scales each sample in the distribution by a constant.

◆ ScaleByDistribution()

void FComposableFloatDistribution::ScaleByDistribution ( const class UDistributionFloat FloatDistribution)

Scale each sample in the distribution by the corresponding sample in another distribution.


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