Enum TCOD_Error

• Defined in File error.h

Enum Documentation

enum TCOD_Error

An enum of libtcod error codes.

On values other than TCOD_E_OK you can use TCOD_get_error() to learn more information.

New in version 1.16.

Values:

enumerator TCOD_E_OK

The function completed successfully without issues.

A function is successful when (err >= 0). Positive values may be used for warnings, or for other outputs.

enumerator TCOD_E_ERROR

The error code for generic runtime errors.

The returned code my be changed in the future to something more specific. Use (err < 0) to check if the value is an error.

enumerator TCOD_E_INVALID_ARGUMENT

The function failed because a given input argument was invalid.

enumerator TCOD_E_OUT_OF_MEMORY

The function failed because it was unable to allocate enough memory.

enumerator TCOD_E_REQUIRES_ATTENTION

This function needs additional attention, but is otherwise functioning correctly.

See its documentation.

New in version 1.16.

enumerator TCOD_E_WARN

The function completed, but a minor issue was detected.