v9.4

Author: nichcode

.clang-format

@@ -1,6 +1,7 @@
 
 BasedOnStyle: LLVM # use LLVM defauls
 IndentWidth: 4
+ColumnLimit: 80
 
 # reset if not set
 AllowShortFunctionsOnASingleLine: None

include/pal/pal_opengl.h

@@ -52,10 +52,10 @@ freely, subject to the following restrictions:
 typedef struct PalGLContext PalGLContext;
 
 /**
- * @enum PalGLExtension
+ * @enum PalGLExtensions
  * @brief Opengl system extensions.
  *
- * @note All opengl extensions follow the format `PAL_GL_EXTENSION**` for
+ * @note All opengl extensions follow the format `PAL_GL_EXTENSION_**` for
  * consistency and API use.
  *
  * @sa PalGLInfo
@@ -94,13 +94,13 @@ typedef enum {
 
     /** Standard red, green and blue.*/
     PAL_GL_EXTENSION_COLORSPACE_SRGB = PAL_BIT(9)
-} PalGLExtension;
+} PalGLExtensions;
 
 /**
  * @enum PalGLProfile
- * @brief Oepngl context creation profiles. This is not a bitmask.
+ * @brief Opengl context creation profiles. This is not a bitmask.
  *
- * @note All opengl profiles follow the format `PAL_GL_PROFILE**` for
+ * @note All opengl profiles follow the format `PAL_GL_PROFILE_**` for
  * consistency and API use.
  *
  * @since Added in version 1.0.0.
@@ -125,9 +125,9 @@ typedef enum {
 
 /**
  * @enum PalGLContextReset
- * @brief Oepngl context reset behavior. This is not a bitmask.
+ * @brief Opengl context reset behavior. This is not a bitmask.
  *
- * @note All context reset behavior follow the format `PAL_GL_CONTEXT_RESET**`
+ * @note All context reset behavior follow the format `PAL_GL_CONTEXT_RESET_**`
  * for consistency and API use.
  *
  * @since Added in version 1.0.0.
@@ -148,10 +148,10 @@ typedef enum {
 
 /**
  * @enum PalGLRelease
- * @brief Oepngl context release behavior. This is not a bitmask.
+ * @brief Opengl context release behavior. This is not a bitmask.
  *
  * @note All opengl context release behavior follow the format
- * `PAL_GL_RELEASE_BEHAVIOR**` for consistency and API use.
+ * `PAL_GL_RELEASE_BEHAVIOR_**` for consistency and API use.
  *
  * @since Added in version 1.0.0.
  * @ingroup opengl
@@ -175,8 +175,8 @@ typedef enum {
  * @ingroup opengl
  */
 typedef struct {
-    /** Supported opengl extensions. see PalGLExtension.*/
-    PalGLExtension extensions;
+    /** Supported opengl extensions. see PalGLExtensions.*/
+    PalGLExtensions extensions;
 
     /** Highest supported opengl major.*/
     Uint32 major;

include/pal/pal_system.h

@@ -38,94 +38,242 @@ freely, subject to the following restrictions:
 #define PAL_CPU_VENDOR_NAME_SIZE 16
 #define PAL_CPU_MODEL_NAME_SIZE 64
 
+/**
+ * @enum PalCpuArch
+ * @brief CPU achitecture This is not a bitmask.
+ *
+ * This is a build time achitecture. Example: Generating your project with x64
+ * will reflect PAL_CPU_ARCH_X86_64.
+ *
+ * @note All CPU achitectures follow the format `PAL_CPU_ARCH_**` for
+ * consistency and API use.
+ *
+ * @since Added in version 1.0.0.
+ * @ingroup system
+ */
 typedef enum {
+    /** Unknown Architecture.*/
     PAL_CPU_ARCH_UNKNOWN,
-    PAL_CPU_ARCH_X86,    /** < 32 bit Architecture.*/
-    PAL_CPU_ARCH_X86_64, /** < 64 bit Architecture.*/
+
+    /** 32 bit Architecture.*/
+    PAL_CPU_ARCH_X86,
+
+    /** 64 bit Architecture.*/
+    PAL_CPU_ARCH_X86_64,
+
+    /** Arm Architecture.*/
     PAL_CPU_ARCH_ARM,
+
+    /** Arm64 Architecture.*/
     PAL_CPU_ARCH_ARM64
 } PalCpuArch;
 
+/**
+ * @enum PalCpuFeatures
+ * @brief CPU features (instruction sets).
+ *
+ * @note All CPU features sets follow the format `PAL_CPU_FEATURE_**` for
+ * consistency and API use.
+ *
+ * @sa PalCPUInfo
+ * @sa palGetCPUInfo()
+ *
+ * @since Added in version 1.0.0.
+ * @ingroup system
+ */
 typedef enum {
+    /** SSE (SIMD operations) instruction set.*/
     PAL_CPU_FEATURE_SSE = PAL_BIT(0),
+
+    /** SSE2 (SIMD operations) instruction set.*/
     PAL_CPU_FEATURE_SSE2 = PAL_BIT(1),
+
+    /** SSE3 (SIMD operations) instruction set.*/
     PAL_CPU_FEATURE_SSE3 = PAL_BIT(2),
+
+    /** SSSE3 (SIMD operations) instruction set.*/
     PAL_CPU_FEATURE_SSSE3 = PAL_BIT(3),
-    PAL_CPU_FEATURE_SSE41 = PAL_BIT(4), /** < SSE4.1 instruction set.*/
-    PAL_CPU_FEATURE_SSE42 = PAL_BIT(5), /** < SSE4.2 instruction set.*/
+
+    /** SSE4.1 (SIMD operations) instruction set.*/
+    PAL_CPU_FEATURE_SSE41 = PAL_BIT(4),
+
+    /** SSE4.2 (SIMD operations) instruction set.*/
+    PAL_CPU_FEATURE_SSE42 = PAL_BIT(5),
+
+    /** AVX (SIMD operations) instruction set.*/
     PAL_CPU_FEATURE_AVX = PAL_BIT(6),
+
+    /** AVX2 (SIMD operations) instruction set.*/
     PAL_CPU_FEATURE_AVX2 = PAL_BIT(7),
+
+    /** AVX512F (SIMD operations) instruction set.*/
     PAL_CPU_FEATURE_AVX512F = PAL_BIT(8),
+
+    /** FMA3 instruction set.*/
     PAL_CPU_FEATURE_FMA3 = PAL_BIT(9),
+
+    /** BMI1 instruction set.*/
     PAL_CPU_FEATURE_BMI1 = PAL_BIT(10),
+
+    /** BMI2 instruction set.*/
     PAL_CPU_FEATURE_BMI2 = PAL_BIT(11)
 } PalCpuFeatures;
 
+/**
+ * @enum PalPlatformType
+ * @brief Platform types. This is not a bitmask.
+ *
+ * This is the family name (eg. This does not show if its Windows 7 or Windows 8
+ * etc)
+ *
+ * @note All platform types follow the format `PAL_PLATFORM_**` for
+ * consistency and API use.
+ *
+ * @since Added in version 1.0.0.
+ * @ingroup system
+ */
 typedef enum {
+    /** Windows Platform (OS).*/
     PAL_PLATFORM_WINDOWS,
+
+    /** Linux Platform (OS).*/
     PAL_PLATFORM_LINUX,
+
+    /** MacOS Platform (OS).*/
     PAL_PLATFORM_MACOS,
+
+    /** Android Platform (OS).*/
     PAL_PLATFORM_ANDROID,
+
+    /** IOS Platform (OS).*/
     PAL_PLATFORM_IOS
 } PalPlatformType;
 
+/**
+ * @enum PalPlatformApiType
+ * @brief Platform API types. This is not a bitmask.
+ *
+ * This is the API the playform uses. Most platforms support only one (eg.
+ * Windows)
+ *
+ * @note All platform API types follow the format `PAL_PLATFORM_API_**` for
+ * consistency and API use.
+ *
+ * @since Added in version 1.0.0.
+ * @ingroup system
+ */
 typedef enum {
+    /** Win32 API.*/
     PAL_PLATFORM_API_WIN32,
+
+    /** Wayland API.*/
     PAL_PLATFORM_API_WAYLAND,
+
+    /** X11 API.*/
     PAL_PLATFORM_API_X11
 } PalPlatformApiType;
 
+/**
+ * @struct PalPlatformInfo
+ * @brief Information about a platform (OS).
+ *
+ * @sa palGetPlatformInfo()
+ *
+ * @since Added in version 1.0.0.
+ * @ingroup system
+ */
 typedef struct {
+    /** Platform family type. See PalPlatformType.*/
     PalPlatformType type;
+
+    /** Platform API type. See PalPlatformApiType.*/
     PalPlatformApiType apiType;
-    Uint32 totalMemory; /** < Total Disk memory*/
-    Uint32 totalRAM;    /** < Total CPU memory*/
-    PalVersion version; /** < Platform version*/
+
+    /** Total Disk space (memory) in GB.*/
+    Uint32 totalMemory;
+
+    /** Total CPU RAM (memory) in MB.*/
+    Uint32 totalRAM;
+
+    /** < Use this to check a specific platform aside the family.*/
+    PalVersion version;
+
+    /** < This is the platform name with the version combined as a UTF-8
+     * encoding string. (eg. Windows 11.22000)*/
     char name[PAL_PLATFORM_NAME_SIZE];
 } PalPlatformInfo;
 
+/**
+ * @struct PalCPUInfo
+ * @brief Information about a CPU.
+ *
+ * @sa palGetCPUInfo()
+ *
+ * @since Added in version 1.0.0.
+ * @ingroup system
+ */
 typedef struct {
-    Uint32 numCores;             /** < Number of cores*/
-    Uint32 cache1;               /** < L1 cache in KB*/
-    Uint32 cache2;               /** < L2 cache in KB*/
-    Uint32 cache3;               /** < L3 cache in KB*/
-    Uint32 numLogicalProcessors; /** < Number of threads that can run
-                                    simultaneously*/
-    PalCpuArch architecture; /** < Build architecture. Based on how the project
-                                will be built.*/
-    PalCpuFeatures features; /** < Supported instruction sets*/
+    /** Number of CPU cores.*/
+    Uint32 numCores;
+
+    /** L1 cache in KB.*/
+    Uint32 cacheL1;
+
+    /** L2 cache in KB.*/
+    Uint32 cacheL2;
+
+    /** L3 cache in KB.*/
+    Uint32 cacheL3;
+
+    /** Number of threads that can run simultaneously (CPUs).*/
+    Uint32 numLogicalProcessors;
+
+    /** Based on how the project will be or built. See PalCpuArch.*/
+    PalCpuArch architecture;
+
+    /** Supported CPU instruction sets.*/
+    PalCpuFeatures features;
+
+    /** CPU vendor name. (eg. GenuineIntel).*/
     char vendor[PAL_CPU_VENDOR_NAME_SIZE];
+
+    /** CPU modal name.*/
     char model[PAL_CPU_MODEL_NAME_SIZE];
 } PalCPUInfo;
 
 /**
  * @brief Get platform (OS) information.
  *
- * @param[out] info Pointer to receive the platform info.
+ * @param[out] info Pointer to a PalPlatformInfo to receive the platform info.
  *
  * @return `PAL_RESULT_SUCCESS` on success or an appropriate result code on
- * failure.
+ * failure. Call palFormatResult() for more information.
  *
  * @note This function is not thread-safe.
  *
  * @sa PalPlatformInfo
+ *
+ * @since Added in version 1.0.0.
  * @ingroup system
  */
 PAL_API PalResult PAL_CALL palGetPlatformInfo(PalPlatformInfo* info);
 
 /**
  * @brief Get CPU information.
  *
- * @param[in] allocator Optional user provided allocator. Set to `nullptr` to
+ * @param[in] allocator Optional user provided allocator. Set to nullptr to
  * use default.
- * @param[out] info Pointer to receive the CPU info.
+ * @param[out] info Pointer to a PalCPUInfo to receive the CPU info.
  *
  * @return `PAL_RESULT_SUCCESS` on success or an appropriate result code on
- * failure.
+ * failure. Call palFormatResult() for more information.
  *
  * @note This function is not thread-safe.
  *
- * @sa PalAllocator, PalCPUInfo
+ * @sa PalAllocator
+ * @sa PalCPUInfo
+ *
+ * @since Added in version 1.0.0.
  * @ingroup system
  */
 PAL_API PalResult PAL_CALL palGetCPUInfo(

src/opengl/pal_opengl_win32.c

@@ -300,7 +300,7 @@ PalResult PAL_CALL palInitGL(const PalAllocator* allocator)
 
     s_Wgl.wglMakeCurrent =
         (wglMakeCurrentFn)GetProcAddress(s_Wgl.opengl, "wglMakeCurrent");
-
+        
     s_Wgl.wglShareLists =
         (wglShareListsFn)GetProcAddress(s_Wgl.opengl, "wglShareLists");