1. Epic GamesDeveloper
  3. FAlphaBlend

FAlphaBlend

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

API > API/Runtime > API/Runtime/Engine

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

  Type Name Description
Public function  

FAlphaBlend ( float NewBlendTime
)

 Constructor
Public function  

FAlphaBlend ( const FAlphaBlendArgs& InArgs
)

 Constructor
Public function  

FAlphaBlend ( const FAlphaBlend& Other,
float NewBlendTime
)

 Constructor

Functions

  Type 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 Gets the current 0..1 alpha value. Changed to AlphaLerp to match with SetAlpha function
Public function Const float Get the current begin value
Public function Const float Gets the current blended value
Public function Const EAlphaBlendOption  
Public function Const float Getters
Public function Const float  
Public function Const UCurveFloat *  
Public function Const float Get the current desired value
Public function Const bool Gets whether or not the blend is complete
Public function void

Reset ()

 Reset functions -
Public function void Reset alpha, this keeps current BlendedValue but modify Alpha to keep the blending state.
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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page