SourcePP
Several modern C++20 libraries for sanely parsing Valve's formats.
Loading...
Searching...
No Matches
dmxpp::DMX Class Reference

#include <dmxpp.h>

Public Member Functions

 DMX (const std::byte *dmxData, std::size_t dmxSize)
 
 DMX (const unsigned char *dmxData, std::size_t dmxSize)
 
 DMX (const std::vector< std::byte > &dmxData)
 
 DMX (const std::vector< unsigned char > &dmxData)
 
 operator bool () const
 
std::string_view getFormatType () const
 
int getFormatVersion () const
 
std::string_view getEncodingType () const
 
int getEncodingVersion () const
 
const std::vector< DMXElement > & getElements () const
 

Protected Member Functions

bool openText (const std::byte *dmxData, std::size_t dmxSize)
 
bool openBinary (BufferStream &stream)
 

Detailed Description

Definition at line 16 of file dmxpp.h.

Constructor & Destructor Documentation

◆ DMX() [1/4]

DMX::DMX ( const std::byte *  dmxData,
std::size_t  dmxSize 
)

Definition at line 10 of file dmxpp.cpp.

◆ DMX() [2/4]

DMX::DMX ( const unsigned char *  dmxData,
std::size_t  dmxSize 
)

Definition at line 51 of file dmxpp.cpp.

◆ DMX() [3/4]

DMX::DMX ( const std::vector< std::byte > &  dmxData)
explicit

Definition at line 54 of file dmxpp.cpp.

◆ DMX() [4/4]

DMX::DMX ( const std::vector< unsigned char > &  dmxData)
explicit

Definition at line 57 of file dmxpp.cpp.

Member Function Documentation

◆ getElements()

const std::vector< DMXElement > & DMX::getElements ( ) const

Definition at line 80 of file dmxpp.cpp.

◆ getEncodingType()

std::string_view DMX::getEncodingType ( ) const

Definition at line 72 of file dmxpp.cpp.

◆ getEncodingVersion()

int DMX::getEncodingVersion ( ) const

Definition at line 76 of file dmxpp.cpp.

◆ getFormatType()

std::string_view DMX::getFormatType ( ) const

Definition at line 64 of file dmxpp.cpp.

◆ getFormatVersion()

int DMX::getFormatVersion ( ) const

Definition at line 68 of file dmxpp.cpp.

◆ openBinary()

bool DMX::openBinary ( BufferStream &  stream)
protected

Definition at line 88 of file dmxpp.cpp.

◆ openText()

bool DMX::openText ( const std::byte *  dmxData,
std::size_t  dmxSize 
)
protected

Definition at line 84 of file dmxpp.cpp.

◆ operator bool()

DMX::operator bool ( ) const
explicit

Definition at line 60 of file dmxpp.cpp.


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