vtfpp::SHT Class Reference

#include <SHT.h>

Collaboration diagram for vtfpp::SHT:

Classes
struct	Sequence

Public Member Functions
	SHT ()
	SHT (std::span< const std::byte > shtData)
	SHT (const std::filesystem::path &shtPath)
	operator bool () const
uint32_t	getVersion () const
void	setVersion (uint32_t v)
const std::vector< Sequence > &	getSequences () const
std::vector< Sequence > &	getSequences ()
const Sequence *	getSequenceFromID (uint32_t id) const
Sequence *	getSequenceFromID (uint32_t id)
uint8_t	getFrameBoundsCount () const
std::vector< std::byte >	bake () const
bool	bake (const std::filesystem::path &shtPath) const

Protected Attributes
bool	opened
uint32_t	version = 0
std::vector< Sequence >	sequences

Detailed Description

Definition at line 12 of file SHT.h.

Constructor & Destructor Documentation

SHT() [1/3]

SHT::SHT

(

)

Definition at line 10 of file SHT.cpp.

SHT() [2/3]

SHT::SHT ( std::span< const std::byte > shtData )

explicit

Definition at line 12 of file SHT.cpp.

SHT() [3/3]

SHT::SHT ( const std::filesystem::path & shtPath )

explicit

Definition at line 36 of file SHT.cpp.

Member Function Documentation

bake() [1/2]

std::vector< std::byte > SHT::bake ( ) const

nodiscard

Definition at line 84 of file SHT.cpp.

bake() [2/2]

bool SHT::bake

(

const std::filesystem::path &

shtPath

)

const

Definition at line 117 of file SHT.cpp.

getFrameBoundsCount()

uint8_t SHT::getFrameBoundsCount ( ) const

nodiscard

Definition at line 80 of file SHT.cpp.

getSequenceFromID() [1/2]

SHT::Sequence * SHT::getSequenceFromID ( uint32_t id )

nodiscard

Definition at line 71 of file SHT.cpp.

getSequenceFromID() [2/2]

const SHT::Sequence * SHT::getSequenceFromID ( uint32_t id ) const

nodiscard

Definition at line 62 of file SHT.cpp.

getSequences() [1/2]

std::vector< SHT::Sequence > & SHT::getSequences ( )

nodiscard

Definition at line 58 of file SHT.cpp.

getSequences() [2/2]

const std::vector< SHT::Sequence > & SHT::getSequences ( ) const

nodiscard

Definition at line 54 of file SHT.cpp.

getVersion()

uint32_t SHT::getVersion ( ) const

nodiscard

Definition at line 43 of file SHT.cpp.

operator bool()

SHT::operator bool ( ) const

explicitnodiscard

Definition at line 39 of file SHT.cpp.

setVersion()

void SHT::setVersion

(

uint32_t

v

)

Definition at line 47 of file SHT.cpp.

Member Data Documentation

opened

bool vtfpp::SHT::opened

protected

Definition at line 68 of file SHT.h.

sequences

std::vector<Sequence> vtfpp::SHT::sequences

protected

Definition at line 71 of file SHT.h.

version

uint32_t vtfpp::SHT::version = 0

protected

Definition at line 70 of file SHT.h.

---

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

• include/vtfpp/SHT.h
• src/vtfpp/SHT.cpp