OpenTTD Source: OutputBuffer Class Reference

OpenTTD Source 14.0-RC3

Public Member Functions | Data Fields
OutputBuffer Class Reference

Output buffer for a block of data. More...

## Public Member Functions
void | Clear ()
| Prepare buffer for use.
size_t | Add (const char *text, size_t length)
| Add text to the output buffer. More...
void | Write (FILE *out_fp) const
| Dump buffer to the output stream. More...
bool | HasRoom () const
| Does the block have room for more data? More...

## Data Fields
size_t | size
| Number of bytes stored in data.
char | data [OUTPUT_BLOCK_SIZE]
| Stored data.

## Detailed Description

Output buffer for a block of data.

Definition at line 39 of file settingsgen.cpp.

## Member Function Documentation

## ◆ Add()

size_t OutputBuffer::Add | ( | const char * | text,
|  | size_t | length
| ) |  |
| inline

Add text to the output buffer.

Parameters

  text | Text to store.
  length | Length of the text in bytes.

Returns
  Number of bytes actually stored.

Definition at line 53 of file settingsgen.cpp.

References data, MemCpyT(), OUTPUT_BLOCK_SIZE, and size.

Referenced by OutputStore::Add().

## ◆ HasRoom()

bool OutputBuffer::HasRoom | ( |  | ) | const
| inline

Does the block have room for more data?

Returns
  `true` if room is available, else `false`.

Definition at line 77 of file settingsgen.cpp.

References OUTPUT_BLOCK_SIZE, and size.

## ◆ Write()

void OutputBuffer::Write | ( | FILE * | out_fp | ) | const
| inline

Dump buffer to the output stream.

Parameters

  out_fp | Stream to write the data to.

Definition at line 66 of file settingsgen.cpp.

References data, and size.

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

- src/settingsgen/settingsgen.cpp