constants_and_types.h

Go to the documentation of this file.

 
#pragma once
#include <opinionated_type_names.h>
 
// Engine details
constexpr const char* ENGINE_NAME = "Untitled 2D game engine";
 
// Update
constexpr u16
    UPDATE_MAJOR = 1,
    UPDATE_MINOR = 0,
    UPDATE_PATCH = 0;
 
// Types
struct i32Vec2
{
    i32 x, y;
};

struct u32Vec2
{
    u32 x, y;
};

struct Colour
{
    u8 r, g, b, a;
    constexpr Colour() : r(0), g(0), b(0), a(255) {}
 
    constexpr Colour(u8 red, u8 green, u8 blue) 
        : r(red), g(green), b(blue), a(255) {}
 
    constexpr Colour(u8 red, u8 green, u8 blue, u8 alpha) 
        : r(red), g(green), b(blue), a(alpha) {}
};
// Colour constants
static constexpr Colour BLACK {};
static constexpr Colour WHITE (255, 255, 255);
static constexpr Colour RED (255, 0, 0);
static constexpr Colour GREEN (0, 255, 0);
static constexpr Colour BLUE (0, 0, 255);

using Color = Colour;
 
/*
    NOTES:
 
    What cases does this engine use:
        Variables   use camelCase
 
        Functions   use PascalCase
        Structs     use PascalCase (unless starts with type (e.g. u8))
        Classes     use PascalCase
 
        Constants   use UPPERCASE_SNAKE_CASE
 
        .h files    use lowercase_snake_case
        .cpp files  use lowercase_snake_case
 
        namespaces  use lowercase (single word)
 
    Use /// for doxygen documentation
*/