UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AVEncoder::DecoderUtilities::FEventSignal Class Reference

#include <VideoDecoderUtilities.h>

Public Member Functions

 FEventSignal ()
 
 FEventSignal (const FEventSignal &)=delete
 
FEventSignaloperator= (const FEventSignal &)=delete
 
 ~FEventSignal ()
 
void Wait ()
 
void WaitAndReset ()
 
void Signal ()
 
void Reset ()
 
bool IsSignaled () const
 
bool WaitTimeout (int64 InMicroSeconds)
 
bool WaitTimeoutAndReset (int64 InMicroSeconds)
 

Constructor & Destructor Documentation

◆ FEventSignal() [1/2]

AVEncoder::DecoderUtilities::FEventSignal::FEventSignal ( )
inline

◆ FEventSignal() [2/2]

AVEncoder::DecoderUtilities::FEventSignal::FEventSignal ( const FEventSignal )
delete

◆ ~FEventSignal()

AVEncoder::DecoderUtilities::FEventSignal::~FEventSignal ( )
inline

Member Function Documentation

◆ IsSignaled()

bool AVEncoder::DecoderUtilities::FEventSignal::IsSignaled ( ) const
inline

Returns state of the signal.

◆ operator=()

FEventSignal & AVEncoder::DecoderUtilities::FEventSignal::operator= ( const FEventSignal )
delete

◆ Reset()

void AVEncoder::DecoderUtilities::FEventSignal::Reset ( )
inline

Clears the signal. Threads will now wait again until the signal is set once more.

◆ Signal()

void AVEncoder::DecoderUtilities::FEventSignal::Signal ( )
inline

Signals the event to be set. If already set, this does nothing.

◆ Wait()

void AVEncoder::DecoderUtilities::FEventSignal::Wait ( )
inline

Waits for the event signal to get set. If already set, this function returns immediately.

◆ WaitAndReset()

void AVEncoder::DecoderUtilities::FEventSignal::WaitAndReset ( )
inline

Waits for the event signal to get set and clears it immediately. If already set, this function returns immediately.

◆ WaitTimeout()

bool AVEncoder::DecoderUtilities::FEventSignal::WaitTimeout ( int64  InMicroSeconds)
inline

Waits for the event signal to get set within the given time limit. If already set, this function returns immediately. Returns true when event was set, false when wait timed out.

◆ WaitTimeoutAndReset()

bool AVEncoder::DecoderUtilities::FEventSignal::WaitTimeoutAndReset ( int64  InMicroSeconds)
inline

Waits for the event signal to get set within the given time limit and clears it immediately. If already set, this function returns immediately. Returns true when event was set, false when wait timed out.


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