include/OnTubeVis/types.h file

Sub header defining general core types used throughout the API.

Classes

struct OTV_Vec2
A convenience struct for representing 2D vectors.
struct OTV_Vec3
A convenience struct for representing 3D vectors.
struct OTV_Vec4
A convenience struct for representing 4D vectors.
struct OTV_Rgb
A convenience struct for representing RGB values.
struct OTV_Interval
A convenience struct for representing an inclusive interval.

Typedefs

using otv__Vec2_funct = OTV_Vec2(*)(const float, const float)
The function pointer type for the otv__Vec2() function.
using otv__Vec3_funct = OTV_Vec3(*)(const float, const float, const float)
The function pointer type for the otv__Vec3() function.
using otv__Vec4_funct = OTV_Vec4(*)(const float, const float, const float, const float)
The function pointer type for the otv__Vec4() function.
using otv__Rgb_funct = OTV_Rgb(*)(const float, const float, const float)
The function pointer type for the otv__Rgb() function.
using otv__Interval_funct = OTV_Rgb(*)(const float, const float)
The function pointer type for the otv__Interval() function.

Functions

auto otv__Vec2(const float x, const float y) -> OTV_API OTV_Vec2
Constructs an instance of the OTV_Vec2 struct for convenient on-the-fly construction as a pass-by-value argument to other functions.
auto otv__Vec3(const float x, const float y, const float z) -> OTV_API OTV_Vec3
Constructs an instance of the OTV_Vec3 struct for convenient on-the-fly construction as a pass-by-value argument to other functions.
auto otv__Vec4(const float x, const float y, const float z, const float w) -> OTV_API OTV_Vec4
Constructs an instance of the OTV_Vec4 struct for convenient on-the-fly construction as a pass-by-value argument to other functions.
auto otv__Rgb(const float r, const float g, const float b) -> OTV_API OTV_Rgb
Constructs an instance of the OTV_Rgb struct for convenient on-the-fly construction as a pass-by-value argument to other functions.
auto otv__Interval(const float min, const float max) -> OTV_API OTV_Interval
Constructs an instance of the OTV_Interval struct for convenient on-the-fly construction as a pass-by-value argument to other functions.

Function documentation

OTV_API OTV_Vec2 otv__Vec2(const float x, const float y)

Constructs an instance of the OTV_Vec2 struct for convenient on-the-fly construction as a pass-by-value argument to other functions.

Parameters
x The value for the field OTV_Vec2::x
y The value for the field OTV_Vec2::y
Returns An instance of the OTV_Vec2 struct.

OTV_API OTV_Vec3 otv__Vec3(const float x, const float y, const float z)

Constructs an instance of the OTV_Vec3 struct for convenient on-the-fly construction as a pass-by-value argument to other functions.

Parameters
x The value for the field OTV_Vec3::x
y The value for the field OTV_Vec3::y
z The value for the field OTV_Vec3::z
Returns An instance of the OTV_Vec3 struct.

OTV_API OTV_Vec4 otv__Vec4(const float x, const float y, const float z, const float w)

Constructs an instance of the OTV_Vec4 struct for convenient on-the-fly construction as a pass-by-value argument to other functions.

Parameters
x The value for the field OTV_Vec4::x
y The value for the field OTV_Vec4::y
z The value for the field OTV_Vec4::z
w The value for the field OTV_Vec4::w
Returns An instance of the OTV_Vec4 struct.

OTV_API OTV_Rgb otv__Rgb(const float r, const float g, const float b)

Constructs an instance of the OTV_Rgb struct for convenient on-the-fly construction as a pass-by-value argument to other functions.

Parameters
r The value for the field OTV_Rgb::r
g The value for the field OTV_Rgb::g
b The value for the field OTV_Rgb::b
Returns An instance of the OTV_Rgb struct.

OTV_API OTV_Interval otv__Interval(const float min, const float max)

Constructs an instance of the OTV_Interval struct for convenient on-the-fly construction as a pass-by-value argument to other functions.

Parameters
min The value for the field OTV_Interval::min
max The value for the field OTV_Interval::max
Returns An instance of the OTV_Interval struct.