Core Libraries

Description

Lowest-level libraries, structs and functionality. Everything is expected to depend on this.

Topics
	Job System
	Submit async jobs to an internal threadpool.
	Lua Scripting
	Execute lightweight lua code within the engine.
	Transforms
	Represent transformations and hierarchies of transformations in 3D space.
	Mathematics
	Basic mathematical geometric types.

Classes
class	tz::handle< T >
	Represents a generic opaque handle. More...

Enumeration Type Documentation

error_code

enum class tz::error_code

strong

Error codes for Topaz.

Enumerator
success	Correct behaviour has occurred. No need to do any sanity checking.
partial_success	Nothing erroneous happened, but the process did not complete fully or otherwise provide an ideal result.
precondition_failure	An error has occurred because some previously-required setup has not been complete. The most common cause of this is not initialising the engine via tz::initialise.
invalid_value	An error has occurred because an illegal/incorrect value has been detected.
machine_unsuitable	An error has occurred because the currently running machine does not support the given operation.
engine_bug	An error has occurred due to an engine-side logic error, and you should submit a bug report.
driver_hazard	An error has occurred due to a serious hazard relating to the driver/hardware. This most likely means a graphics driver crash/hardware-lost.
unknown_error	An error has occurred, but it's not clear why.
oom	An error has occurred due to lack of CPU memory.
voom	An error has occurred due to lack of GPU memory.
concurrent_usage	An error has occurred due to an operation being invalid while a given resource is in use by something else.

Variable Documentation

nullhand

nullhand_t tz::nullhand

constexpr

Represents the null handle. You can assign any tz::handle<T> to the null handle, meaning it no longer corresponds to something valid. You can also compare any handle to the null handle.