template class ThreadSafeRingBuffer

Thread-safe ring buffer used to back logging system.

File location: framework/cauldron/framework/inc/misc/threadsafe_ringbuffer.h

Construction

Return type

Description

Construction with custom initialization.

Methods

Return type

Description

void

Closes the ring buffer (takes no more entries).

bool

Empty () const
Queries if the ring buffer is empty.

bool

Full () const
Queries if the ring buffer is full (at max capacity).

bool

Pop (T& item)
Pops an item off the top of the ring buffer. Blocking until the buffer has an element or is closed.

void

PushBack (T&& item)
Pushes an item onto the ring buffer. Blocking until there is enough space in the ring buffer if at capacity.

Detailed description

Thread-safe ring buffer used to back logging system.

Construction

ThreadSafeRingBuffer

Copied!

ThreadSafeRingBuffer ()

Construction with custom initialization.


Methods

Close

Copied!

void Close ()

Closes the ring buffer (takes no more entries).


Empty

Copied!

bool Empty () const

Queries if the ring buffer is empty.


Full

Copied!

bool Full () const

Queries if the ring buffer is full (at max capacity).


Pop

Copied!

bool Pop (T& item)

Pops an item off the top of the ring buffer. Blocking until the buffer has an element or is closed.


PushBack

Copied!

void PushBack (T&& item)

Pushes an item onto the ring buffer. Blocking until there is enough space in the ring buffer if at capacity.


Related pages

  • Visit the FidelityFX SDK product page for download links and more information.

Looking for more documentation on GPUOpen?

AMD GPUOpen software blogs

Our handy software release blogs will help you make good use of our tools, SDKs, and effects, as well as sharing the latest features with new releases.

GPUOpen Manuals

Don’t miss our manual documentation! And if slide decks are what you’re after, you’ll find 100+ of our finest presentations here.

AMD GPUOpen Performance Guides

The home of great performance and optimization advice for AMD RDNAâ„¢ 2 GPUs, AMD Ryzenâ„¢ CPUs, and so much more.

Getting started: AMD GPUOpen software

New or fairly new to AMD’s tools, libraries, and effects? This is the best place to get started on GPUOpen!

AMD GPUOpen Getting Started Development and Performance

Looking for tips on getting started with developing and/or optimizing your game, whether on AMD hardware or generally? We’ve got you covered!

AMD GPUOpen Technical blogs

Browse our technical blogs, and find valuable advice on developing with AMD hardware, ray tracing, Vulkan®, DirectX®, Unreal Engine, and lots more.

Find out more about our software!

AMD GPUOpen Effects - AMD FidelityFX technologies

Create wonder. No black boxes. Meet the AMD FidelityFX SDK!

AMD GPUOpen Samples

Browse all our useful samples. Perfect for when you’re needing to get started, want to integrate one of our libraries, and much more.

AMD GPUOpen developer SDKs

Discover what our SDK technologies can offer you. Query hardware or software, manage memory, create rendering applications or machine learning, and much more!

AMD GPUOpen Developer Tools

Analyze, Optimize, Profile, Benchmark. We provide you with the developer tools you need to make sure your game is the best it can be!