FAlphaBlend

Alpha Blend class that supports different blend options as well as custom curves

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/AlphaBlend.h

Include

#include "AlphaBlend.h"

Syntax

struct FAlphaBlend

Remarks

Alpha Blend class that supports different blend options as well as custom curves

Constructors

Name Description

Public function

FAlphaBlend

(
    float NewBlendTime
)

Constructor

Public function

FAlphaBlend

(
    const FAlphaBlend& Other,
    float NewBlendTime
)

Constructor

Functions

Name Description

Public function Static

float

 

AlphaToBlendOption

(
    float InAlpha,
    EAlphaBlendOption InBlendOption,
    UCurveFloat* InCustomCurve
)

Converts InAlpha from a linear 0...1 value into the output alpha described by InBlendOption

Public function Const

float

 

GetAlpha()

Gets the current 0..1 alpha value. Changed to AlphaLerp to match with SetAlpha function

Public function Const

float

 

GetBeginValue()

Get the current begin value

Public function Const

float

 

GetBlendedValue()

Gets the current blended value

Public function Const

EAlphaBlendO...

 

GetBlendOption()

Public function Const

float

 

GetBlendTime()

Getters

Public function Const

float

 

GetBlendTimeRemaining()

Public function Const

UCurveFloat ...

 

GetCustomCurve()

Public function Const

float

 

GetDesiredValue()

Get the current desired value

Public function Const

bool

 

IsComplete()

Gets whether or not the blend is complete

Public function

void

 

Reset()

Reset functions -

Public function

void

 

SetAlpha

(
    float InAlpha
)

Sets the Lerp alpha value directly.

Public function

void

 

SetBlendOption

(
    EAlphaBlendOption InBlendOption
)

Setters - need to refresh cached value

Public function

void

 

SetBlendTime

(
    float InBlendTime
)

Update transition blend time. This new value will be applied in the next Update.

Public function

void

 

SetCustomCurve

(
    UCurveFloat* InCustomCurve
)

Public function

void

 

SetDesiredValue

(
    float InDesired
)

Sets the final desired value for the blended value

Public function

void

 

SetValueRange

(
    float Begin,
    float Desired
)

Sets the range of values to map to the interpolation

Public function

float

 

Update

(
    float InDeltaTime
)

Update interpolation, has to be called once every frame.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss