TCircularQueue::Peek

Returns the oldest item in the queue without removing it.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Containers/CircularQueue.h

Include

#include "Containers/CircularQueue.h"

Syntax

bool Peek
(
    ElementType & OutItem
) const

Remarks

Returns the oldest item in the queue without removing it.

Returns

true if an item has been returned, false if the queue was empty. @note To be called only from consumer thread.

Parameters

Parameter

Description

OutItem

Will contain the item if the queue is not empty.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss