Classes
struct	AABB

class	AABBShape

class	Animation

class	AnimationLibrary

class	AnimationPlayer

class	Application

struct	ApplicationConfig

class	BoxShape

class	Camera

class	Character

class	CollisionArea

class	CollisionObject

class	ConvexHullShape

class	Cubemap

class	CylinderShape

struct	DebugConfig

class	DirectionalLight

class	Environment

class	EnvironmentCubemap

class	Font

struct	Frustum

class	Image

class	ImageTexture

class	Input

class	InputEvent

class	InputEventGamepadButton

class	InputEventKey

class	InputEventMouse

class	InputEventMouseButton

class	InputEventMouseMotion

class	KinematicBody

class	Light

class	Loader

class	Locale

struct	Log

class	Material

class	Mesh

class	MeshInstance

class	MeshShape

class	Node

class	Object

class	OmniLight

class	OutlineMaterials

class	PhysicsBody

class	PropertyTween

class	RayCast

class	Resource

class	RigidBody

class	ShaderMaterial

class	Shape

class	Signal

class	Skybox

class	SphereShape

class	SpotLight

class	StandardMaterial

class	StaticBody

class	StaticCompoundShape

struct	SubShape

struct	Surface

class	Texture

class	Tween

class	TypeRegistry

struct	Vertex

class	Viewport

class	VirtualFS

class	Window

Enums
enum class	ProcessMode : uint8_t { INHERIT = 0, PAUSABLE = 1, WHEN_PAUSED = 2, ALWAYS = 3, DISABLED = 4 }

enum class	WindowMode : uint8_t { WINDOWED = 0, WINDOWED_MAXIMIZED = 1, WINDOWED_FULLSCREEN = 2, FULLSCREEN = 3 }

enum	LoggingMode : uint32_t { LOGGING_MODE_NONE = 0, LOGGING_MODE_WINDOW = 0x001, LOGGING_MODE_FILE = 0x010, LOGGING_MODE_STDOUT = 0x100 }

enum class	LogLevel : int32_t

enum class	VSyncMode : uint32_t { IMMEDIATE = 0, MAILBOX = 1, FIFO = 2, RELAXED = 3 }

enum class	MSAA : uint8_t { AUTO = 0, X2 = 0x00000002, X4 = 0x00000004, X8 = 0x00000008, X16 = 0x00000010, X32 = 0x00000020, X64 = 0x00000040 }

enum class	DepthBufferFormat : uint8_t { AUTO = 0, B16 = 1, B24 = 2, B32 = 3 }

enum class	NormalBufferFormat : uint8_t { B8 = 0, B16 = 1, B32 = 2 }

enum class	CullMode : uint8_t { DISABLED = 0, BACK = 1, FRONT = 2 }

enum class	Transparency : uint8_t { DISABLED = 0, ALPHA = 1, SCISSOR = 2, SCISSOR_ALPHA = 3 }

enum class	TransitionType : uint8_t { LINEAR = 0 }

enum class	InputEventType : uint8_t { KEY = 0, MOUSE_MOTION = 1, MOUSE_BUTTON = 2, GAMEPAD_BUTTON = 3 }

enum class	KeyModifier : uint8_t { SHIFT = 0x0001, CONTROL = 0x0002, ALT = 0x0004 }

enum	Key : uint8_t { , KEY_SPACE = 1, KEY_DASH = 2, KEY_PIPE = 3, KEY_APOSTROPHE = 4, KEY_COMMA = 5, KEY_PERIOD = 6, KEY_QUESTIONMARK = 7, KEY_0 = 8, KEY_1 = 9, KEY_2 = 10, KEY_3 = 11, KEY_4 = 12, KEY_5 = 13, KEY_6 = 14, KEY_7 = 15, KEY_8 = 16, KEY_9 = 17, KEY_SEMICOLON = 18, KEY_EQUAL = 19, KEY_A = 20, KEY_B = 21, KEY_C = 22, KEY_D = 23, KEY_E = 24, KEY_F = 25, KEY_G = 26, KEY_H = 27, KEY_I = 28, KEY_J = 29, KEY_K = 30, KEY_L = 31, KEY_M = 32, KEY_N = 33, KEY_O = 34, KEY_P = 35, KEY_Q = 36, KEY_R = 37, KEY_S = 38, KEY_T = 39, KEY_U = 40, KEY_V = 41, KEY_W = 42, KEY_X = 43, KEY_Y = 44, KEY_Z = 45, KEY_LEFT_BRACKET = 46, KEY_BACKSLASH = 47, KEY_RIGHT_BRACKET = 48 , KEY_ESCAPE = 50, KEY_ENTER = 51, KEY_TAB = 52, KEY_BACKSPACE = 53, KEY_INSERT = 54, KEY_DELETE = 55, KEY_RIGHT = 56, KEY_LEFT = 57, KEY_DOWN = 58, KEY_UP = 59, KEY_PAGE_UP = 60, KEY_PAGE_DOWN = 61, KEY_HOME = 62, KEY_END = 63, KEY_CAPS_LOCK = 64, KEY_SCROLL_LOCK = 65, KEY_NUM_LOCK = 66, KEY_PRINT_SCREEN = 67, KEY_PAUSE = 68, KEY_F1 = 69, KEY_F2 = 70, KEY_F3 = 71, KEY_F4 = 72, KEY_F5 = 73, KEY_F6 = 74, KEY_F7 = 75, KEY_F8 = 76, KEY_F9 = 77, KEY_F10 = 78, KEY_F11 = 79, KEY_F12 = 80, KEY_KP_0 = 81, KEY_KP_1 = 82, KEY_KP_2 = 83, KEY_KP_3 = 84, KEY_KP_4 = 85, KEY_KP_5 = 86, KEY_KP_6 = 87, KEY_KP_7 = 88, KEY_KP_8 = 89, KEY_KP_9 = 90, KEY_KP_PERIOD = 91, KEY_KP_DIVIDE = 92, KEY_KP_MULTIPLY = 93, KEY_KP_SUBTRACT = 94, KEY_KP_ADD = 95, KEY_KP_ENTER = 96, KEY_KP_EQUAL = 97, KEY_LEFT_SHIFT = 98, KEY_LEFT_CONTROL = 99, KEY_LEFT_ALT = 100, KEY_LEFT_SUPER = 101, KEY_RIGHT_SHIFT = 102, KEY_RIGHT_CONTROL = 103, KEY_RIGHT_ALT = 104, KEY_RIGHT_SUPER = 105 }

enum class	MouseButton : uint8_t { , LEFT = 0b0001, RIGHT = 0b0010, MIDDLE = 0b0100, WHEEL = 0b1000 }

enum class	GamepadButton : uint8_t { A = 0, CROSS = A, B = 1, CIRCLE = B, X = 2, SQUARE = X, Y = 3, TRIANGLE = Y, LB = 4, L1 = LB, RB = 5, R1 = RB, BACK = 6, SHARE = BACK, START = 7, MENU = START, LT = 8, L2 = LT, RT = 9, R2 = RT, DPAD_UP = 10, DPAD_RIGHT = 11, DPAD_DOWN = 12, DPAD_LEFT = 13 }

enum class	GamepadAxisJoystick : uint8_t { LEFT = 0, RIGHT = 1 }

enum class	GamepadAxis : uint8_t { LEFT_X = 0, LEFT_Y = 1, RIGHT_X = 2, RIGHT_Y = 3 }

enum class	MouseMode : uint8_t { VISIBLE = 0, VISIBLE_CAPTURED = 1, HIDDEN = 2, HIDDEN_CAPTURED = 3 }

enum class	MouseCursor : uint8_t { ARROW = 0, WAIT = 1, RESIZE_H = 2, RESIZE_V = 3 }

enum class	ImageFormat : uint8_t { R8G8B8A8_SRGB = 0, R8G8B8A8_UNORM = 1 }

enum class	AnimationType : uint8_t { TRANSLATION = 1, ROTATION = 2, SCALE = 3 }

enum class	AnimationInterpolation : uint8_t { LINEAR = 0, STEP = 1 }

enum class	AnimationLoopMode : uint8_t { NONE = 0, LINEAR = 1 }

enum class	DebugShapeColor { InstanceColor, ShapeTypeColor, MotionTypeColor, SleepColor, IslandColor }
	Coloring scheme of collision shapes. More...

Functions
auto	removeNumericSuffix (const string &str)

void	die (convertible_to< string_view > auto &&...s)

uint32_t	randomi (uint32_t max)

float	randomf (float max)

vector< string_view >	split (string_view str, char delimiter)

vec2	lerp (const vec2 a, const vec2 b, const float t)

vec3	lerp (const vec3 a, const vec3 b, const float t)

vec4	lerp (const vec4 a, const vec4 b, const float t)

Variables
constexpr auto	ENGINE_NAME {"ZeroZero"}

constexpr vec3	WINDOW_CLEAR_COLOR {0, 0, 0}

constexpr vec3	AXIS_X {1.0, 0.0f, 0.0f}

constexpr vec3	AXIS_Y {0.0, 1.0f, 0.0f}

constexpr vec3	AXIS_Z {0.0, 0.0f, 1.0f}

constexpr vec3	AXIS_UP = AXIS_Y

constexpr vec3	AXIS_DOWN = -AXIS_Y

constexpr vec3	AXIS_FRONT = -AXIS_Z

constexpr vec3	AXIS_BACK = AXIS_Z

constexpr vec3	AXIS_RIGHT = AXIS_X

constexpr vec3	AXIS_LEFT = -AXIS_X

constexpr vec2	VEC2ZERO {0.0}

constexpr vec3	VEC3ZERO {0.0}

constexpr quat	QUATERNION_IDENTITY {1.0f, 0.0f, 0.0f, 0.0f}

constexpr mat3	TRANSFORM_BASIS {1, 0, 0, 0, 1, 0, 0, 0, 1}

const regex	numericSuffixPattern {R"(.d+$)"}

Detailed Description

The z0 namespace

Enumeration Type Documentation

enum class AnimationInterpolation : uint8_t

strong

Interpolation type to apply when caculating animation values

Enum Values	Documentation
LINEAR	The animated values are linearly interpolated between keyframes..
STEP	The animated values remain constant to the output of the first keyframe, until the next keyframe.

enum class AnimationLoopMode : uint8_t

strong

Animation loop mode

Enum Values	Documentation
NONE	No loop (default)
LINEAR	Restart from start of the track.

enum class AnimationType : uint8_t

strong

Animation type for a animation track

Enum Values	Documentation
TRANSLATION	The values are the translation along the X, Y, and Z axes.
ROTATION	The values are a quaternion in the order x, y, z, w where w is the scalar.
SCALE	The values are scaling factors along the X, Y, and Z axes.

enum class CullMode : uint8_t

strong

Cull mode for mesh surfaces. Determines which side of the triangle to cull depending on whether the triangle faces towards or away from the camera.

Enum Values	Documentation
DISABLED	No face culling is performed; both the front face and back face will be visible.
BACK	Default cull mode. The back of the object is culled when not visible. Back face triangles will be culled when facing the camera. This results in only the front side of triangles being drawn. For closed-surface meshes, this means that only the exterior of the mesh will be visible.
FRONT	Front face triangles will be culled when facing the camera. This results in only the back side of triangles being drawn. For closed-surface meshes, this means that the interior of the mesh will be drawn instead of the exterior.

enum class DebugShapeColor

strong

Coloring scheme of collision shapes.

Enum Values	Documentation
InstanceColor	Random color per instance.
ShapeTypeColor	Convex = green, scaled = yellow, compound = orange, mesh = red.
MotionTypeColor	Static = grey, keyframed = green, dynamic = random color per instance.
SleepColor	Static = grey, keyframed = green, dynamic = yellow, sleeping = red.
IslandColor	Static = grey, active = random color per island, sleeping = light grey.

enum class DepthBufferFormat : uint8_t

strong

Depth frame buffers precision

Enum Values	Documentation
AUTO	Selection the best depth format available.
B16	16-bit unsigned normalized
B24	24-bit unsigned normalized with or without stencil component
B32	32-bit signed float with or without stencil component

enum class GamepadAxis : uint8_t

strong

Gamepad axis & triggers

Enum Values	Documentation
LEFT_X	Left stick/joystick X.
LEFT_Y	Left stick/joystick Y.
RIGHT_X	Right stick/joystick X.
RIGHT_Y	Right stick/joystick Y.

enum class GamepadAxisJoystick : uint8_t

strong

Gamepad thumbs joysticks

Enum Values	Documentation
LEFT	Left stick/joystick.
RIGHT	Right stick/joystick.

enum class GamepadButton : uint8_t

strong

Gamepas buttons

Enum Values	Documentation
A	A or X.
CROSS	A or X.
B	B or ○.
CIRCLE	B or ○.
X	X or □.
SQUARE	X or □.
Y	Y or △.
TRIANGLE	Y or △.
LB	Left shoulder/bumper.
L1	Left shoulder/bumper.
RB	Right shoulder/bumper.
R1	Right shoulder/bumper.
BACK	Back/Share.
SHARE	Back/Share.
START	Start/Menu.
MENU	Start/Menu.
LT	Left trigger.
L2	Left trigger.
RT	Right trigger.
R2	Right trigger.
DPAD_UP	Directional hat ↑.
DPAD_RIGHT	Directional hat →.
DPAD_DOWN	Directional hat ↓.
DPAD_LEFT	Directional hat ←.

enum class ImageFormat : uint8_t

strong

Images pixel format

Enum Values	Documentation
R8G8B8A8_SRGB	32 bits with alpha channel in the sRGB color space
R8G8B8A8_UNORM	32 bits with alpha channel in the linear color space

enum class InputEventType : uint8_t

strong

Source of an input event

Enum Values	Documentation
KEY	A key have been pressed or released.
MOUSE_MOTION	The mouse cursor moved.
MOUSE_BUTTON	A mouse button have been pressed or released.
GAMEPAD_BUTTON	A gamepad button have been pressed or released.

enum Key : uint8_t

Key codes, QWERTY layout to keep the WASD keys

Enum Values	Documentation
KEY_SPACE	Space.
KEY_DASH
KEY_PIPE	\|
KEY_APOSTROPHE	'
KEY_COMMA	,
KEY_PERIOD	$.
KEY_QUESTIONMARK	?
KEY_0	0
KEY_1	1
KEY_2	2
KEY_3	3
KEY_4	4
KEY_5	5
KEY_6	6
KEY_7	7
KEY_8	8
KEY_9	9
KEY_SEMICOLON	;
KEY_EQUAL	=
KEY_A	A.
KEY_B	B.
KEY_C	C.
KEY_D	D.
KEY_E	E.
KEY_F	F.
KEY_G	G.
KEY_H	H.
KEY_I	I.
KEY_J	J.
KEY_K	K.
KEY_L	L.
KEY_M	M.
KEY_N	N.
KEY_O	O.
KEY_P	P.
KEY_Q	Q.
KEY_R	R.
KEY_S	S.
KEY_T	T.
KEY_U	U.
KEY_V	V.
KEY_W	W.
KEY_X	X.
KEY_Y	Y.
KEY_Z	Z.
KEY_LEFT_BRACKET	[
KEY_BACKSLASH	backslash
KEY_RIGHT_BRACKET	]
KEY_ESCAPE	ESC.
KEY_ENTER	⏎
KEY_TAB	Tabulation.
KEY_BACKSPACE	back space
KEY_INSERT	Insert.
KEY_DELETE	Delete.
KEY_RIGHT	→
KEY_LEFT	←
KEY_DOWN	↓
KEY_UP	↑
KEY_PAGE_UP	Page ↑.
KEY_PAGE_DOWN	Page ↓.
KEY_HOME	Home/Start.
KEY_END	End.
KEY_CAPS_LOCK	Left caps lock.
KEY_SCROLL_LOCK	Scroll lock.
KEY_NUM_LOCK	Numeric keypad lock.
KEY_PRINT_SCREEN	Print.
KEY_PAUSE	Pause.
KEY_F1	F1.
KEY_F2	F2.
KEY_F3	F3.
KEY_F4	F4.
KEY_F5	F5.
KEY_F6	F6.
KEY_F7	F7.
KEY_F8	F8.
KEY_F9	F9.
KEY_F10	F10.
KEY_F11	F11.
KEY_F12	F12.
KEY_KP_0	Keypad 0.
KEY_KP_1	Keypad 1.
KEY_KP_2	Keypad 2.
KEY_KP_3	Keypad 3.
KEY_KP_4	Keypad 4.
KEY_KP_5	Keypad 5.
KEY_KP_6	Keypad 6.
KEY_KP_7	Keypad 7.
KEY_KP_8	Keypad 8.
KEY_KP_9	Keypad 9.
KEY_KP_PERIOD	Keypad .
KEY_KP_DIVIDE	Keypad /.
KEY_KP_MULTIPLY	Keypad *.
KEY_KP_SUBTRACT	Keypad -.
KEY_KP_ADD	Keypad +.
KEY_KP_ENTER	Keypad ⏎.
KEY_KP_EQUAL	Keypad =.
KEY_LEFT_SHIFT	Left Shift.
KEY_LEFT_CONTROL	Left Control.
KEY_LEFT_ALT	Left Alt.
KEY_LEFT_SUPER	Left Super/Windows.
KEY_RIGHT_SHIFT	Right Shift.
KEY_RIGHT_CONTROL	Right Control.
KEY_RIGHT_ALT	Right Alt.
KEY_RIGHT_SUPER	Right Super/Windows.

enum class KeyModifier : uint8_t

strong

Keyboard modifier keys

Enum Values	Documentation
SHIFT	Left & right shift keys.
CONTROL	Left & right control keys.
ALT	Left & right alt keys.

enum LoggingMode : uint32_t

Where to log message using the z0::log() function

Enum Values	Documentation
LOGGING_MODE_NONE	Disable logging.
LOGGING_MODE_WINDOW	Open an external Window (on the first screen if you have multiple screen) to display the log messages. Log message appearance in the Window can be deferred to the next frame if the log message is sent from a thread different from the main thread
LOGGING_MODE_FILE	Log the messages into a file named 'log.txt'
LOGGING_MODE_STDOUT	Log the messages to cout. WIN32 applications needs to be linked with `-mconsole`

enum class LogLevel : int32_t

strong

Log levels

enum class MouseButton : uint8_t

strong

Mouse buttons

Enum Values	Documentation
LEFT	Left.
RIGHT	Right.
MIDDLE	Middle.
WHEEL	Wheel. Pressed==true means rotated backward.

enum class MouseCursor : uint8_t

strong

Mouse cursors types

Enum Values	Documentation
ARROW	"Normal" arrow cursor
WAIT	Waiting cursor.
RESIZE_H	Horizontal resize cursor.
RESIZE_V	Vertical resize cursor.

enum class MouseMode : uint8_t

strong

Mouse visibility & capture mode

Enum Values	Documentation
VISIBLE	Makes the mouse cursor visible.
VISIBLE_CAPTURED	Confines the mouse cursor to the game Window, and make it visible.
HIDDEN	Makes the mouse cursor hidden.
HIDDEN_CAPTURED	Confines the mouse cursor to the game Window, and make it hidden.

enum class MSAA : uint8_t

strong

MSAA samples

Enum Values	Documentation
AUTO	Select the best MSAA sample count between 2x and 8x.
X2	2x MSAA
X4	4x MSAA
X8	8x MSAA
X16	16x MSAA
X32	32x MSAA
X64	64x MSAA

enum class NormalBufferFormat : uint8_t

strong

Normal frame buffers precision

Enum Values	Documentation
B8	8-bit signed normalized
B16	16-bit signed float
B32	32-bit signed float

enum class ProcessMode : uint8_t

strong

Nodes state when the scene is paused or running

Enum Values	Documentation
INHERIT	Inherits mode from the node's parent. This is the default for any newly created node.
PAUSABLE	Stops processing when Application::isPaused() is true. This is the inverse of PROCESS_MODE_WHEN_PAUSED.
WHEN_PAUSED	Process only when Application::isPaused() is true. This is the inverse of PROCESS_MODE_PAUSABLE.
ALWAYS	Always process. Keeps processing, ignoring Application::isPaused(). This is the inverse of PROCESS_MODE_DISABLED.
DISABLED	Never process. Completely disables processing, ignoring Application::isPaused(). This is the inverse of PROCESS_MODE_ALWAYS.

enum class TransitionType : uint8_t

strong

A Tween transition type

Enum Values	Documentation
LINEAR	The animation is interpolated linearly

enum class Transparency : uint8_t

strong

A Material transparency mode Any transparency mode other than Transparency::DISABLED has a greater performance impact compared to opaque rendering.

Enum Values	Documentation
DISABLED	The material will not use transparency. This is the fastest to render.
ALPHA	The material will use the texture's alpha values for transparency.
SCISSOR	The material will cut off all values below a threshold, the rest will remain opaque.
SCISSOR_ALPHA	The material will cut off all values below a threshold, the rest will use the texture's alpha values for transparency.

enum class VSyncMode : uint32_t

strong

Presentation mode

Enum Values	Documentation
IMMEDIATE	VK_PRESENT_MODE_IMMEDIATE_KHR
MAILBOX	VK_PRESENT_MODE_MAILBOX_KHR
FIFO	VK_PRESENT_MODE_FIFO_KHR
RELAXED	VK_PRESENT_MODE_FIFO_RELAXED_KHR

enum class WindowMode : uint8_t

strong

Rendering Window mode

Enum Values	Documentation
WINDOWED	A Window with a border and a title that can be minimized.
WINDOWED_MAXIMIZED	A maximized Window with a border and a title that can be minimized.
WINDOWED_FULLSCREEN	A maximized Window without a border and without a title.
FULLSCREEN	A full screen Window. The screen resolution will be changed.

Function Documentation

void z0::die ( convertible_to< string_view > auto &&... s )

Violently stop the application

vec2 z0::lerp	(	const vec2	a,
		const vec2	b,
		const float	t
	)

inline

lerp for a vec2 using std::lerp for componants

vec3 z0::lerp	(	const vec3	a,
		const vec3	b,
		const float	t
	)

inline

lerp for a vec3 using std::lerp for componants

vec4 z0::lerp	(	const vec4	a,
		const vec4	b,
		const float	t
	)

inline

lerp for a vec4 using std::lerp for componants

float z0::randomf ( float max )

Returns a random value in the range [0.0f, max]

uint32_t z0::randomi ( uint32_t max )

Returns a random value in the range [0, max]

auto z0::removeNumericSuffix ( const string & str )

inline

Removes the Blender numeric suffix from a string

vector<string_view> z0::split	(	string_view	str,
		char	delimiter
	)

Split a string

Variable Documentation

constexpr vec3 AXIS_BACK = AXIS_Z

constexpr

BACK Axis

constexpr vec3 AXIS_DOWN = -AXIS_Y

constexpr

DOWN Axis

constexpr vec3 AXIS_FRONT = -AXIS_Z

constexpr

FRONT Axis

constexpr vec3 AXIS_LEFT = -AXIS_X

constexpr

LEFT Axis

constexpr vec3 AXIS_RIGHT = AXIS_X

constexpr

RIGHT Axis

constexpr vec3 AXIS_UP = AXIS_Y

constexpr

UP Axis

constexpr vec3 AXIS_X {1.0, 0.0f, 0.0f}

constexpr

X Axis

constexpr vec3 AXIS_Y {0.0, 1.0f, 0.0f}

constexpr

Y Axis

constexpr vec3 AXIS_Z {0.0, 0.0f, 1.0f}

constexpr

Z Axis

constexpr auto ENGINE_NAME {"ZeroZero"}

constexpr

Useless engine name

const regex numericSuffixPattern {R"(.d+$)"}

Blender numeric suffix pattern for names

constexpr quat QUATERNION_IDENTITY {1.0f, 0.0f, 0.0f, 0.0f}

constexpr

Unit quaternion with no rotation

constexpr mat3 TRANSFORM_BASIS {1, 0, 0, 0, 1, 0, 0, 0, 1}

constexpr

The Basis of 3D transform. It is composed by 3 axes (Basis.x, Basis.y, and Basis.z). Together, these represent the transform's rotation, scale, and shear.

constexpr vec2 VEC2ZERO {0.0}

constexpr

2D zero initialized vector

constexpr vec3 VEC3ZERO {0.0}

constexpr

3D zero initialized vector

constexpr vec3 WINDOW_CLEAR_COLOR {0, 0, 0}

constexpr

Default background color for the display Window

Classes

Enums

Functions

Variables

Detailed Description

Enumeration Type Documentation

Function Documentation

Variable Documentation