halt::TerminalShader Class Reference

Terminal shader object. Terminal shaders are responsible for transforming an input value to an output value. They are used to intercept cells as they are being written to the terminal buffer. Because of this, they are able to inject special effects like waves and colors. More...

#include <TerminalShader.h>

List of all members.

Public Member Functions
virtual void	Transform (const TerminalShaderInput &input, TerminalShaderOutput &output)=0
	Transforms an input value into an output value.

---

Detailed Description

Terminal shader object. Terminal shaders are responsible for transforming an input value to an output value. They are used to intercept cells as they are being written to the terminal buffer. Because of this, they are able to inject special effects like waves and colors.

---

Member Function Documentation

virtual void halt::TerminalShader::Transform	(	const TerminalShaderInput &	input,
		TerminalShaderOutput &	output
	)		[pure virtual]

Transforms an input value into an output value.

Parameters:

input	Cell that is currently being written to the terminal buffer.
output	The modified cell to write to the terminal buffer.

See also:

TerminalShaderInput

TerminalShaderOutput

---

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

• Halt2/include/TerminalShader.h