| LUFA Library 140302 |

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
RingBuffer_t Struct Reference
Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h

Ring Buffer Management Structure. More...

`#include <RingBuffer.h>`

## Data Fields
uint16_t | Count
uint8_t * | End
uint8_t * | In
uint8_t * | Out
uint16_t | Size
uint8_t * | Start

## Detailed Description

Type define for a new ring buffer object. Buffers should be initialized via a call to RingBuffer_InitBuffer() before use.

## Field Documentation

uint16_t RingBuffer_t::Count

Number of bytes currently stored in the buffer.

uint8_t* RingBuffer_t::End

Pointer to the end of the buffer's underlying storage array.

uint8_t* RingBuffer_t::In

Current storage location in the circular buffer.

uint8_t* RingBuffer_t::Out

Current retrieval location in the circular buffer.

uint16_t RingBuffer_t::Size

Size of the buffer's underlying storage array.

uint8_t* RingBuffer_t::Start

Pointer to the start of the buffer's underlying storage array.

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

- Drivers/Misc/RingBuffer.h