nishi/milsko
1
Fork 0
mirror of https://gitea.nishi.boats/pyrite-dev/milsko synced 2026-01-03 16:10:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

update doc

Browse Source 
git-svn-id: http://svn2.nishi.boats/svn/milsko/trunk@115 b9cfdab3-6d41-4d17-bbe4-086880011989
This commit is contained in:
IoIxD
2025-10-01 21:54:39 +00:00
parent 31f5208114
commit 6b87beb090
1 changed files with 155 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
doc/index.html
View File

@@ -123,11 +123,17 @@
<a href="#Mw_Error_h">Mw/Error.h</a>
</dt>
<dd>
<a href="#Mw_Error_h__MwErrorEnum">MwErrorEnum</a>
<a href="#Mw_Error_h__MwErrorEnum_T">MwErrorEnum_T</a>
</dd>
<dd>
<a href="#Mw_Error_h___MwEsuccess_"> MwEsuccess </a>
</dd>
<dd>
<a href="#Mw_Error_h___MwEerror_"> MwEerror,</a>
</dd>
<dd>
<a href="#Mw_Error_h__MwGetLastError__">MwGetLastError()</a>
</dd>
<dt>
<a href="#Mw_Font_h">Mw/Font.h</a>
</dt>
@@ -191,6 +197,42 @@
<dd>
<a href="#Mw_Vulkan_h__MwVulkanClass">MwVulkanClass</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h__MwVulkanEnableExtension">MwVulkanEnableExtension</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h__MwVulkanField_T">MwVulkanField_T</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h___MwVulkanField_GetInstanceProcAddr_"> MwVulkanField_GetInstanceProcAddr </a>
</dd>
<dd>
<a href="#Mw_Vulkan_h___MwVulkanField_Instance_"> MwVulkanField_Instance,</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h___MwVulkanField_Surface_"> MwVulkanField_Surface,</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h___MwVulkanField_PhysicalDevice_"> MwVulkanField_PhysicalDevice,</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h___MwVulkanField_LogicalDevice_"> MwVulkanField_LogicalDevice,</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h___MwVulkanField_GraphicsQueueIndex_"> MwVulkanField_GraphicsQueueIndex,</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h___MwVulkanField_PresentQueueIndex_"> MwVulkanField_PresentQueueIndex,</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h___MwVulkanField_PresentQueue_"> MwVulkanField_PresentQueue,</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h__MwVulkanField">MwVulkanField</a>
</dd>
<dd>
<a href="#Mw_Vulkan_h__MwVulkanGetField">MwVulkanGetField</a>
</dd>
<dt>
<a href="#Mw_Window_h">Mw/Window.h</a>
</dt>
@@ -1200,20 +1242,34 @@
</dt>
</dl>
<hr>
<pre id="Mw_Error_h__MwErrorEnum"><code>enum MwErrorEnum;</code></pre>
<pre id="Mw_Error_h__MwErrorEnum_T"><code>typedef enum MwErrorEnum_T;</code></pre>
<dl>
<dd>
Error code enumeration.
</dd>
</dl>
<hr>
<pre id="Mw_Error_h___MwEsuccess_"><code> MwEsuccess = 0</code></pre>
<pre id="Mw_Error_h___MwEsuccess_"><code> MwEsuccess = 0,</code></pre>
<dl>
<dd>
No error.
</dd>
</dl>
<hr>
<pre id="Mw_Error_h___MwEerror_"><code> MwEerror,</code></pre>
<dl>
<dd>
There was an error.
</dd>
</dl>
<hr>
<pre id="Mw_Error_h__MwGetLastError__"><code>MWDECL const char* MwGetLastError();</code></pre>
<dl>
<dd>
Get the last error.
</dd>
</dl>
<hr>
<h2 align="center" id="Mw_Font_h">Mw/Font.h</h2>
<dl>
<dt>
@@ -1444,6 +1500,102 @@
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h__MwVulkanEnableExtension"><code>MWDECL void MwVulkanEnableExtension (
const char* ext_name
);</code></pre>
<dl>
<dd>
Add an extension to the list of extensions to enable prior to initialization.
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h__MwVulkanField_T"><code>typedef enum MwVulkanField_T;</code></pre>
<dl>
<dd>
Field that can be gotten from Vulkan.
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h___MwVulkanField_GetInstanceProcAddr_"><code> MwVulkanField_GetInstanceProcAddr = 0,</code></pre>
<dl>
<dd>
The address of the vulkan widget's vkGetInstanceProcAddr function (PFN_vkGetInstanceProcAddr).
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h___MwVulkanField_Instance_"><code> MwVulkanField_Instance,</code></pre>
<dl>
<dd>
The address of the vulkan widget's instance (VkInstance).
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h___MwVulkanField_Surface_"><code> MwVulkanField_Surface,</code></pre>
<dl>
<dd>
The address of the vulkan widget's surface (VkSurfaceKHR).
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h___MwVulkanField_PhysicalDevice_"><code> MwVulkanField_PhysicalDevice,</code></pre>
<dl>
<dd>
The address of the vulkan widget's physical device (VkPhysicalDevice).
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h___MwVulkanField_LogicalDevice_"><code> MwVulkanField_LogicalDevice,</code></pre>
<dl>
<dd>
The address of the vulkan widget's logical device (VkDevice).
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h___MwVulkanField_GraphicsQueueIndex_"><code> MwVulkanField_GraphicsQueueIndex,</code></pre>
<dl>
<dd>
The address of the index that the vulkan widget uses for the graphics queue (uint32_t *).
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h___MwVulkanField_PresentQueueIndex_"><code> MwVulkanField_PresentQueueIndex,</code></pre>
<dl>
<dd>
The address of the index that the vulkan widget uses for the present queue (uint32_t *).
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h___MwVulkanField_PresentQueue_"><code> MwVulkanField_PresentQueue,</code></pre>
<dl>
<dd>
The address of the vulkan widget's graphics queue (VkQueue).
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h__MwVulkanField"><code>} MwVulkanField;</code></pre>
<dl>
<dd>
The address of the vulkan widget's present queue (VkQueue).
</dd>
</dl>
<hr>
<pre id="Mw_Vulkan_h__MwVulkanGetField"><code>MWDECL void* MwVulkanGetField (
MwWidget handle,
MwVulkanField field,
MwErrorEnum* out
);</code></pre>
<dl>
<dd>
Function for getting a field from within Vulkan.
</dd>
<dt>
<img src="warning.gif" alt="warning">
</dt>
<dd>
Consult the documentation for MwVulkanField to know what type is expected for out.
</dd>
</dl>
<hr>
<h2 align="center" id="Mw_Window_h">Mw/Window.h</h2>
<dl>
<dt>