docs: add plugin setup guide

2026-05-30 18:33:24 +12:00
parent f3db41c402
commit b61043a3fe
1776 changed files with 122386 additions and 2 deletions
@@ -0,0 +1,30 @@
+#pragma once
+
+namespace RE
+{
+	class __declspec(novtable) hkMemoryAllocator
+	{
+	public:
+		static constexpr auto RTTI{ RTTI::hkMemoryAllocator };
+		static constexpr auto VTABLE{ VTABLE::hkMemoryAllocator };
+
+		class ExtendedInterface;
+		class MemoryStatistics;
+
+		virtual ~hkMemoryAllocator() = default;  // 00
+
+		// add
+		virtual void*              BlockAlloc(std::int32_t a_numBytesIn) = 0;                                              // 01
+		virtual void               BlockFree(void* a_ptr, std::int32_t a_numBytesIn) = 0;                                  // 02
+		virtual void*              BufAlloc(std::int32_t& a_reqNumBytesInOut) { return BlockAlloc(a_reqNumBytesInOut); }   // 03
+		virtual void               BufFree(void* a_ptr, std::int32_t a_numBytes) { BlockFree(a_ptr, a_numBytes); }         // 04
+		virtual void*              BufRealloc(void* a_old, std::int32_t a_oldNumBytes, std::int32_t& a_reqNumBytesInOut);  // 05
+		virtual void               BlockAllocBatch(void** a_ptrsOut, std::int32_t a_numPtrs, std::int32_t a_blockSize);    // 06
+		virtual void               BlockFreeBatch(void** a_ptrsIn, std::int32_t a_numPtrs, std::int32_t a_blockSize);      // 07
+		virtual void               GetMemoryStatistics(MemoryStatistics& a_stats) const = 0;                               // 08
+		virtual std::int32_t       GetAllocatedSize(const void* a_obj, std::int32_t a_numBytes) const = 0;                 // 09
+		virtual void               ResetPeakMemoryStatistics() { return; }                                                 // 0A
+		virtual ExtendedInterface* GetExtendedInterface() { return nullptr; }                                              // 0B
+	};
+	static_assert(sizeof(hkMemoryAllocator) == 0x08);
+}