tag_block< entry_structure > Struct Template Reference

Structure representing a tag block. More...

#include <tags.h>

Collaboration diagram for tag_block< entry_structure >:

Public Member Functions
entry_structure *	GetEntry (int entry_index)
	Retrieves an entry from the tag block. More...

Public Attributes
char	block_identifier [4] = {'t','b','f','d'}
	The tag block identifier. Will always be tbfd. More...
char	padding0 [4]
	Empty padding. More...
int	entry_size = 0
	The size of each block entry. More...
int	reserved_0 = 0
	4 reserved bytes for future use. More...
void *	entry_data_address = nullptr
	The address of the blocks' entry data. More...
int	entry_count = 0
	The number of entries within the tag block. More...
int	reserved_1 = 0
	4 reserved bytes for future use. More...

Detailed Description

template<typename entry_structure>
struct tag_block< entry_structure >

Structure representing a tag block.

This is used to define a tag block in tag data.

Template Parameters

entry_structure

-

Member Function Documentation

GetEntry()

template<typename entry_structure >

entry_structure* tag_block< entry_structure >::GetEntry ( int  entry_index )

inline

Retrieves an entry from the tag block.

Parameters

entry_index

- The index of the desired entry.

Returns

Pointer to the specified entry, or nullptr if the index was out of range.

Member Data Documentation

block_identifier

template<typename entry_structure >

char tag_block< entry_structure >::block_identifier[4] = {'t','b','f','d'}

The tag block identifier. Will always be tbfd.

entry_count

template<typename entry_structure >

int tag_block< entry_structure >::entry_count = 0

The number of entries within the tag block.

entry_data_address

template<typename entry_structure >

void* tag_block< entry_structure >::entry_data_address = nullptr

The address of the blocks' entry data.

entry_size

template<typename entry_structure >

int tag_block< entry_structure >::entry_size = 0

The size of each block entry.

padding0

template<typename entry_structure >

char tag_block< entry_structure >::padding0[4]

Empty padding.

reserved_0

template<typename entry_structure >

int tag_block< entry_structure >::reserved_0 = 0

4 reserved bytes for future use.

reserved_1

template<typename entry_structure >

int tag_block< entry_structure >::reserved_1 = 0

4 reserved bytes for future use.

---

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

• blam/api/v1/types/tags.h