Sound Open Firmware
Loading...
Searching...
No Matches
intel_adsp::StreamBufferAlignment Struct Reference

"Scoped enumeration" of values which specify data buffer alignment of input or output stream buffer. More...

#include <src/include/sof/audio/module_adapter/iadk/processing_module_prerequisites.h>

Public Types

enum  WordSize { _4_BYTES = 4 , _8_BYTES = 8 }
 the enumeration type of StreamBufferAlignment "scoped enumeration" More...
 
typedef uint8_t Type
 Type of the inner integral value.
 

Public Member Functions

 StreamBufferAlignment (void)
 Initializes a new instance of StreamBufferAlignment with value set to _4_BYTES.
 
 StreamBufferAlignment (WordSize val)
 Initializes a new instance of StreamBufferAlignment given a StreamBufferAlignment::WordSize value.
 
 StreamBufferAlignment (Type val)
 Initializes a new instance of StreamBufferAlignment given a StreamBufferAlignment::Type value.
 
 StreamBufferAlignment (const StreamBufferAlignment &ref)
 Copy constructor.
 
 operator WordSize (void)
 Implicit cast operator to IoChunkAligment::WordSize.
 
 operator Type (void)
 Implicit cast operator to IoChunkAligment::Type.
 
StreamBufferAlignment & operator= (const StreamBufferAlignment &src)
 default assignment operator
 
StreamBufferAlignment & operator= (const StreamBufferAlignment::WordSize &src)
 assignment operator given a StreamBufferAlignment::WordSize value
 
bool operator> (const StreamBufferAlignment &r) const
 implement comparison operator
 
bool operator< (const StreamBufferAlignment &r) const
 implement comparison operator
 
bool operator== (const StreamBufferAlignment &r) const
 implement comparison operator
 
bool operator!= (const StreamBufferAlignment &r) const
 implement comparison operator
 

Detailed Description

"Scoped enumeration" of values which specify data buffer alignment of input or output stream buffer.

Member Typedef Documentation

◆ Type

Type of the inner integral value.

Member Enumeration Documentation

◆ WordSize

the enumeration type of StreamBufferAlignment "scoped enumeration"

Enumerator
_4_BYTES 

enumeration tag for 4-bytes aligned buffer

_8_BYTES 

enumeration tag for 8-bytes aligned buffer

Constructor & Destructor Documentation

◆ StreamBufferAlignment() [1/4]

intel_adsp::StreamBufferAlignment::StreamBufferAlignment ( void  )
inline

Initializes a new instance of StreamBufferAlignment with value set to _4_BYTES.

◆ StreamBufferAlignment() [2/4]

intel_adsp::StreamBufferAlignment::StreamBufferAlignment ( WordSize  val)
inline

Initializes a new instance of StreamBufferAlignment given a StreamBufferAlignment::WordSize value.

◆ StreamBufferAlignment() [3/4]

intel_adsp::StreamBufferAlignment::StreamBufferAlignment ( Type  val)
inlineexplicit

Initializes a new instance of StreamBufferAlignment given a StreamBufferAlignment::Type value.

◆ StreamBufferAlignment() [4/4]

intel_adsp::StreamBufferAlignment::StreamBufferAlignment ( const StreamBufferAlignment &  ref)
inline

Copy constructor.

Member Function Documentation

◆ operator Type()

intel_adsp::StreamBufferAlignment::operator Type ( void  )
inline

Implicit cast operator to IoChunkAligment::Type.

◆ operator WordSize()

intel_adsp::StreamBufferAlignment::operator WordSize ( void  )
inline

Implicit cast operator to IoChunkAligment::WordSize.

◆ operator!=()

bool intel_adsp::StreamBufferAlignment::operator!= ( const StreamBufferAlignment &  r) const
inline

implement comparison operator

◆ operator<()

bool intel_adsp::StreamBufferAlignment::operator< ( const StreamBufferAlignment &  r) const
inline

implement comparison operator

◆ operator=() [1/2]

StreamBufferAlignment & intel_adsp::StreamBufferAlignment::operator= ( const StreamBufferAlignment &  src)
inline

default assignment operator

◆ operator=() [2/2]

StreamBufferAlignment & intel_adsp::StreamBufferAlignment::operator= ( const StreamBufferAlignment::WordSize &  src)
inline

assignment operator given a StreamBufferAlignment::WordSize value

◆ operator==()

bool intel_adsp::StreamBufferAlignment::operator== ( const StreamBufferAlignment &  r) const
inline

implement comparison operator

◆ operator>()

bool intel_adsp::StreamBufferAlignment::operator> ( const StreamBufferAlignment &  r) const
inline

implement comparison operator


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