IrrIMGUI  0.3.1
Private Attributes | List of all members
IrrIMGUI::CCharFifo Class Reference

A Fifo Memory to store character inputs from the keyboard. More...

#include <CCharFifo.h>

Public Member Functions

Constructor and Destructor
 CCharFifo (void)
 Standard Constructor. More...
 
 ~CCharFifo (void)
 Standard Destructor. More...
 
Write-, Read- and Status-Methods
void addChar (ImWchar C)
 
ImWchar getChar (void)
 
bool isEmpty (void) const
 
bool isFull (void) const
 
irr::u8 getNumberOfElements (void) const
 

Private Attributes

ImWchar mCharArray [256]
 
irr::u8 mWriteIndex
 
irr::u8 mReadIndex
 

Detailed Description

A Fifo Memory to store character inputs from the keyboard.

Definition at line 49 of file CCharFifo.h.

Constructor & Destructor Documentation

IrrIMGUI::CCharFifo::CCharFifo ( void  )

Standard Constructor.

Definition at line 44 of file CCharFifo.cpp.

Here is the call graph for this function:

IrrIMGUI::CCharFifo::~CCharFifo ( void  )

Standard Destructor.

Definition at line 55 of file CCharFifo.cpp.

Member Function Documentation

void IrrIMGUI::CCharFifo::addChar ( ImWchar  C)
Parameters
CIs the input Character to add to the Fifo Memory.
Note
If the Fifo is full an assertion is raised.

Definition at line 60 of file CCharFifo.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ImWchar IrrIMGUI::CCharFifo::getChar ( void  )
Returns
Returns a Character from the Fifo Memory.
Note
If the Fifo is empty an assertion is raised.

Definition at line 75 of file CCharFifo.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

irr::u8 IrrIMGUI::CCharFifo::getNumberOfElements ( void  ) const
Returns
Returns the number of characters inside the Fifo.

Definition at line 106 of file CCharFifo.cpp.

bool IrrIMGUI::CCharFifo::isEmpty ( void  ) const
Returns
Returns true, when the Fifo is empty.

Definition at line 96 of file CCharFifo.cpp.

Here is the caller graph for this function:

bool IrrIMGUI::CCharFifo::isFull ( void  ) const
Returns
Returns true, when the Fifo is full.

Definition at line 101 of file CCharFifo.cpp.

Here is the caller graph for this function:

Member Data Documentation

ImWchar IrrIMGUI::CCharFifo::mCharArray[256]
private

Definition at line 88 of file CCharFifo.h.

irr::u8 IrrIMGUI::CCharFifo::mReadIndex
private

Definition at line 90 of file CCharFifo.h.

irr::u8 IrrIMGUI::CCharFifo::mWriteIndex
private

Definition at line 89 of file CCharFifo.h.


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