// =====================================================================================================================
//  fennec, a free and open source game engine
//  Copyright © 2025 - 2026  Medusa Slockbower
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <https://www.gnu.org/licenses/>.
// =====================================================================================================================

///
/// \file fennec/math/scalar.h
/// \brief the \ref fennec_math_scalar
///
///
/// \details
/// \author Medusa Slockbower
///
/// \copyright Copyright © 2025 - 2026 Medusa Slockbower ([GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html))
///
///

#ifndef FENNEC_MATH_SCALAR_H
#define FENNEC_MATH_SCALAR_H

///
///
///
/// \page fennec_math_scalar Scalars
/// \anchor scalar
///
/// \brief The base scalar types of the fennec Math Library
///
/// \code #include <fennec/math/scalar.h> \endcode
///
/// The fennecLibrary considers any type that passes `(.*?)` to be a \ref scalar "Scalar." Bools are
/// supported as a logical type.
///
/// The GLSL Specification, and fennecrespectively, defines the following scalar types:
///
/// | Type     | Corresponding Type    | Meaning                      |
/// |----------|-----------------------|------------------------------|
/// |\c bool   | \ref fennec::bool_t   | \copybrief fennec::bool_t    |
/// |\c int    | \ref fennec::int_t    | \copybrief fennec::int_t     |
/// |\c uint   | \ref fennec::uint_t   | \copybrief fennec::uint_t    |
/// |\c float  | \ref fennec::float_t  | \copybrief fennec::float_t   |
/// |\c double | \ref fennec::double_t | \copybrief fennec::double_t  |
///
///
///

#include <fennec/lang/types.h>

#include <fennec/math/detail/_forward.h>
#include <fennec/math/detail/_types.h>

namespace fennec
{

using byte   = uint8_t;  //!< a single byte type
using ubyte  = uint8_t;  //!< a single unsigned byte type
using ushort = uint16_t; //!< an unsigned short type
using uint   = uint32_t; //!< an unsigned int type

}

#endif // FENNEC_MATH_SCALAR_H
