Skip to main content

buffer Folder

Files Index

filehelios/core/buffer/_module.ixx

Aggregate module for helios::core::buffer namespace. More...

fileBuffer.ixx

Abstract base class for buffer implementations. More...

fileDoubleBuffer.ixx

Double-buffered, type-indexed message system for decoupled inter-system communication. More...

fileReadBuffer.ixx

Read-only buffer for the double-buffering pattern. More...

fileReadWriteBuffer.ixx

Combined read-write buffer for single-buffered access patterns. More...

fileReadWriteDoubleBuffer.ixx

Type-safe double-buffered container for producer-consumer patterns. More...

fileTypeIndexedDoubleBuffer.ixx

Double-buffered, type-indexed message system for decoupled inter-system communication. More...

fileTypeIndexedReadWriteBuffer.ixx

Type-indexed single-buffered message system for immediate-access patterns. More...

fileWriteBuffer.ixx

Write-only buffer for the double-buffering pattern. More...

Description

helios::core::buffer

Double-buffering infrastructure for thread-safe message passing.

This module provides read and write buffers for implementing double-buffered message systems. Double-buffering enables safe producer-consumer patterns across frame boundaries, where messages pushed in one frame become available for reading in the next.

Components:

  • Buffer - Abstract base class for type-erased buffer implementations.
  • DoubleBuffer - Abstract base class for double-buffered containers with swap semantics.
  • ReadBuffer - Read-only buffer for consuming messages (consumer-side of double-buffering).
  • WriteBuffer - Write-only buffer for producing messages (producer-side of double-buffering).
  • ReadWriteBuffer - Combined single-buffer with immediate visibility for same-phase access.
  • ReadWriteDoubleBuffer - Type-safe double-buffered container pairing ReadBuffer and WriteBuffer.
  • TypeIndexedDoubleBuffer - Type-indexed container managing multiple ReadWriteDoubleBuffers by message type.
  • TypeIndexedReadWriteBuffer - Type-indexed container for immediate-access single-buffered patterns.

Usage patterns:

  • Cross-phase communication: Use TypeIndexedDoubleBuffer with swapBuffers() at frame boundaries.
  • Same-phase communication: Use TypeIndexedReadWriteBuffer for immediate message visibility.


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.