export_on_save
prince

Structure

    |- .forge => for now it is quite empty. But you can check REY_LoggerNUtils/.forge to understand what this really is for
    |- .install => `cmake install`
    |- .CMakeFiles
        |- REY_FetchV4 from REY_LoggerNUtils
    |-
    |- amVK => smol lil library for vulkan 😄
        |- guide => a vulkan guide by REYNEP
    |- intern
    |- REY_LoggerNUtils:- [GIT-SUBMODULE] /see ## libraries section in this doc
    |
    |- amGHOST_logWIN32.hh = 😉 [wrapper around REY_LoggerNUtils]
    |- amGHOST_System.hh = Like an Platform Agnostic "INTERFACE"
    |- amGHOST_Window.hh = same as above
    |- amGHOST_<smth>.hh = more like the above two

Tutorial

• One of my 2025 goal is to create a LIVE Video on this, 😄> where I show the creation of amGHOST from ground up / void / nada / null 😉.

ex. 1

#include "amGHOST/amGHOST_System.hh"

int main(int argumentCount, char* argumentVector[]) {
    REY::cout << "\n";

    amGHOST_System::create_system();    // initializes amG_HEART
    
    amGHOST_Window* W = amG_HEART->new_window_interface();
    W->create(L"Whatever", 0, 0, 500, 600);

    REY::cin.get();     // wait for terminal input
    W->destroy();

    REY::cout << "\n";
    return 0;
}

ex. 2 - vulkan

amGHOST_Window* W = amG_HEART->new_window_interface();
W->create(L"Whatever", 0, 0, 500, 600);

const char* extName = amGHOST_System::get_vulkan_os_surface_ext_name());

#include "amGHOST_VkSurfaceKHR.hh"
VkSurfaceKHR VK_S = amGHOST_VkSurfaceKHR::create_surface(W, amVK_Instance::s_vk);

amGHOST_<smth>.hh:- e.g. amGHOST_System.hh

• These are "INTERFACE" objects.
  • i.e. class amGHOST_System has pure virtual functions.
• under the hood class amGHOST_SystemWIN32/X11 or XLIB/WAYLAND/cocoa gets created.
  • check files inside ./intern/
• same kinda thingy happens to all other amGHOST_<smth>.hh
• These .hh files serve as both INTERFACE + DOCUMENTATION 😉

docs

• Treat amGHOST_<smth>.hh files as INTERFACE + DOCUMENTATION 😉!
• Everything that you can do with amGHOST will be listed inside these files. That is, basically functions and documentation for them.

amVK vs amGHOST

• Listed inside ./amVK/readme.md

Usage / Building

• ensure you got the libraries / modules listed below

Libraries / Modules / External Stuffs [.forge]

1. REY_LoggerNUtils:- Automatically-Handled using cmake

   • [GIT-SUBMODULE] + [REY_FetchV4_Way3_SUBMODULE]
   • even tho it's a git-submodule. we fetch/grab/do-shits using CMAKE Scripts like .CMakeFiles/REY_FetchV4_REY_LoggerNUtils.cmake instead of git submodule --update --init

2. vulkan:- [REY_FetchV4_SCOUT]

   1. download vulkan-sdk from:- https://vulkan.lunarg.com/sdk/home
      • make sure VULKAN_SDK & VK_SDK_PATH environment variables are set
      • restart VSCode after installing vulkanSDK.

3. cmake:- download & install cmake ☺️

Todo

1. auto grab it if vulkan-sdk is not found.... using REY_FetchV4::Zip

C/C++ Extension [vscode]

{
    ...
        // C/C++ intelliSense Extension
    "C_Cpp.files.exclude": {
       "C:\\Users\\REY\\Desktop\\idk\\amGHOST\\amVK\\guide": true,
    },
    ...
}

Common Principles I Followed

1. Logs are better than RETURN VALUES.
   • The way that we need to check RETURN VALUES of every single VULKAN FUNCTION. Wrapping every vulkan function call around with a RESULT/VK_CHECK wrapper.... [all of it felt really frickin hectic >_<>] .... is exactly what led me to take this decision.