OSVR-Core
Public Member Functions | List of all members
osvr::common::IPCRingBuffer::Options Class Reference

Public Member Functions

OSVR_COMMON_EXPORT Options (std::string const &name)
 
OSVR_COMMON_EXPORT Options (std::string const &name, BackendType backend)
 
BackendType getBackend () const
 
OptionssetName (std::string const &name)
 sets the name, after sanitizing the input string. More...
 
std::string const & getName () const
 
OptionssetAlignment (alignment_type alignment)
 Sets the alignment for each entry, which must be a power of 2 (rounded up to the nearest if it's not). More...
 
alignment_type getAlignment () const
 
OptionssetEntries (entry_count_type entries)
 Sets the number of entries in the ring buffer. More...
 
entry_count_type getEntries () const
 
OptionssetEntrySize (entry_size_type entrySize)
 Sets the size of each entry in the ring buffer. More...
 
entry_size_type getEntrySize () const
 

Member Function Documentation

§ setAlignment()

IPCRingBuffer::Options & osvr::common::IPCRingBuffer::Options::setAlignment ( alignment_type  alignment)

Sets the alignment for each entry, which must be a power of 2 (rounded up to the nearest if it's not).

Returns
*this for chained method idiom.
Todo:
ensure power of 2

§ setEntries()

IPCRingBuffer::Options & osvr::common::IPCRingBuffer::Options::setEntries ( entry_count_type  entries)

Sets the number of entries in the ring buffer.

Returns
*this for chained method idiom.

§ setEntrySize()

IPCRingBuffer::Options & osvr::common::IPCRingBuffer::Options::setEntrySize ( entry_size_type  entrySize)

Sets the size of each entry in the ring buffer.

Returns
*this for chained method idiom.

§ setName()

IPCRingBuffer::Options & osvr::common::IPCRingBuffer::Options::setName ( std::string const &  name)

sets the name, after sanitizing the input string.

Returns
*this for chained method idiom.

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