diff --git a/doc/index.html b/doc/index.html index b9517ea..54fa0b0 100644 --- a/doc/index.html +++ b/doc/index.html @@ -9,10 +9,13 @@

Table of Contents

- Mw/Button.h + Mw/Constants.h
- MwButtonClass + MwDIRECTION +
+
+ MwORIENTATION
Mw/Core.h @@ -86,6 +89,9 @@
MwGetBeforeStep
+
+ MwForceRender +
Mw/Default.h
@@ -95,18 +101,27 @@
MwDefaultForeground
+
+ MwDefaultBorderWidth +
Mw/Draw.h
MwParseColor
+
+ MwLightenColor +
MwDrawRect
MwDrawFrame
+
+ MwDrawTriangle +
MwDrawFrameEx
@@ -146,145 +161,167 @@
MwBoldFontData[]
-
- Mw/Frame.h -
-
- MwFrameClass -
-
- Mw/Image.h -
-
- MwImageClass -
Mw/LowLevel.h
Mw/MachDep.h
-
- Mw/Menu.h -
-
- MwMenuClass -
-
- MwMenuAdd -
Mw/Milsko.h
-
- Mw/OpenGL.h -
-
- MwOpenGLClass -
-
- MwOpenGLMakeCurrent -
-
- MwOpenGLGetProcAddress -
-
- MwOpenGLSwapBuffer -
Mw/StringDefs.h
-
- Mw/SubMenu.h -
-
- MwSubMenuClass -
Mw/TypeDefs.h
- Mw/Vulkan.h + Mw/Widget/Button.h
- MwVulkanClass -
-
- MwVulkanEnableExtension -
-
- MwVulkanEnableLayer -
-
- MwVulkanConfig_T -
-
- api_version -
-
- vk_version -
-
- validation_layers -
-
- MwVulkanConfigure -
-
- MwVulkanField_T -
-
- MwVulkanField_GetInstanceProcAddr -
-
- MwVulkanField_Instance -
-
- MwVulkanField_Surface -
-
- MwVulkanField_PhysicalDevice -
-
- MwVulkanField_LogicalDevice -
-
- MwVulkanField_GraphicsQueueIndex -
-
- MwVulkanField_PresentQueueIndex -
-
- MwVulkanField_PresentQueue -
-
- MwVulkanField -
-
- MwVulkanGetField -
-
- MwVulkanSupported + MwButtonClass
- Mw/Window.h + Mw/Widget/Frame.h
- MwWindowClass + MwFrameClass +
+
+ Mw/Widget/Image.h +
+
+ MwImageClass +
+
+ Mw/Widget/Menu.h +
+
+ MwMenuClass +
+
+ MwMenuAdd +
+
+ Mw/Widget/OpenGL.h +
+
+ MwOpenGLClass +
+
+ MwOpenGLMakeCurrent +
+
+ MwOpenGLGetProcAddress +
+
+ MwOpenGLSwapBuffer +
+
+ Mw/Widget/ScrollBar.h +
+
+ MwScrollBarClass +
+
+ MwScrollBarGetVisibleLength +
+
+ Mw/Widget/SubMenu.h +
+
+ MwSubMenuClass +
+
+ Mw/Widget/Vulkan.h +
+
+ MwVulkanClass +
+
+ MwVulkanEnableExtension +
+
+ MwVulkanEnableLayer +
+
+ MwVulkanConfig_T +
+
+ api_version +
+
+ vk_version +
+
+ validation_layers +
+
+ MwVulkanConfigure +
+
+ MwVulkanField_T +
+
+ MwVulkanField_GetInstanceProcAddr +
+
+ MwVulkanField_Instance +
+
+ MwVulkanField_Surface +
+
+ MwVulkanField_PhysicalDevice +
+
+ MwVulkanField_LogicalDevice +
+
+ MwVulkanField_GraphicsQueueIndex +
+
+ MwVulkanField_PresentQueueIndex +
+
+ MwVulkanField_PresentQueue +
+
+ MwVulkanField +
+
+ MwVulkanGetField +
+
+ MwVulkanSupported +
+
+ Mw/Widget/Window.h +
+
+ MwWindowClass
-

Mw/Button.h

+

Mw/Constants.h

- Button widget. + Constants.
-
MWDECL MwClass MwButtonClass;
+
enum MwDIRECTION;
- Button widget class. + Direction enumeration. +
+
+
+
enum MwORIENTATION;
+
+
+ Orientation.
@@ -301,11 +338,8 @@ Dispatches the handler of widget class.
- warning +
warningUsed internally.
-
- Used internally. -
Parameter x
@@ -326,11 +360,8 @@ Dispatches the handler of widget class.
- warning +
warningUsed internally.
-
- Used internally. -
Parameter x
@@ -799,11 +830,8 @@ Sets the default property.
- warning +
warningThis is called when widget is created.
-
- This is called when widget is created. -
Parameter handle
@@ -993,6 +1021,21 @@
+
MWDECL void MwForceRender (
+	MwWidget handle
+);
+
+
+ Forcefully makes widget render. +
+
+ Parameter handle +
+
+ Widget. +
+
+

Mw/Default.h

@@ -1014,6 +1057,13 @@
+
MWDECL const int MwDefaultBorderWidth;
+
+
+ Default border width. +
+
+

Mw/Draw.h

@@ -1049,6 +1099,55 @@
+
MWDECL MwLLColor MwLightenColor (
+	MwWidget handle,
+	MwLLColor color,
+	int r,
+	int g,
+	int b
+);
+
+
+ Lighten a color. +
+
+ Parameter handle +
+
+ Widget. +
+
+ Parameter color +
+
+ Color. +
+
+ Parameter r +
+
+ Red. +
+
+ Parameter g +
+
+ Green. +
+
+ Parameter b +
+
+ Blue. +
+
+ Returns +
+
+ Color. +
+
+
MWDECL void MwDrawRect (
 	MwWidget handle,
 	MwRect* rect,
@@ -1089,10 +1188,44 @@
 	Draws a frame.
 
 

-	warning
+	
warningrect gets changed to the area of rectangle inside.

+

+

+	Parameter handle
 

 

-	rect gets changed to the area of rectangle inside.
+	Widget.
+

+

+	Parameter rect
+

+

+	Rectangle area.
+

+

+	Parameter color
+

+

+	Color.
+

+

+	Parameter invert
+

+

+	Invert the 3D border color or not.
+

+
+

+
MWDECL void MwDrawTriangle (
+	MwWidget handle,
+	MwRect* rect,
+	MwLLColor color,
+	int invert,
+	int direction
+);

+

+

+	Draws a triangle.
 

 

 	Parameter handle
@@ -1132,11 +1265,8 @@
 	Draws a frame with specified border width.
 
 

-	warning
+	
warningrect gets changed to the area of rectangle inside.

 

-

-	rect gets changed to the area of rectangle inside.
-

 

 	Parameter handle
 

@@ -1352,45 +1482,14 @@
 
 

 

-
Mw/Frame.h

-

-

-	Frame widget.
-

-

-

-
MWDECL MwClass MwFrameClass;

-

-

-	Frame widget class.
-

-

-

-
Mw/Image.h

-

-

-	Image widget.
-

-

-

-
MWDECL MwClass MwImageClass;

-

-

-	Image widget class.
-

-

-

 
Mw/LowLevel.h

 

 

 	Low-level drawing API.
 

 

-	warning
+	
warningThis is used internally.

 

-

-	This is used internally.
-

 

 

 
Mw/MachDep.h

@@ -1400,21 +1499,84 @@
 
 
 

-
Mw/Menu.h

+
Mw/Milsko.h

+

+

+	Includes all headers.
+

+

+

+
Mw/StringDefs.h

+

+

+	String definitions for property.
+

+

+

+
Mw/TypeDefs.h

+

+

+	Type definitions.
+

+

+

+
Mw/Widget/Button.h

+

+

+	Button widget.
+

+

+

+
MWDECL MwClass MwButtonClass;

+

+

+	Button widget class.
+

+

+

+
Mw/Widget/Frame.h

+

+

+	Frame widget.
+

+

+

+
MWDECL MwClass MwFrameClass;

+

+

+	Frame widget class.
+

+

+

+
Mw/Widget/Image.h

+

+

+	Image widget.
+

+

+

+
MWDECL MwClass MwImageClass;

+

+

+	Image widget class.
+

+

+

+
Mw/Widget/Menu.h

 

 

 	Menu widget.
 

 

 

-
MWDECL MwClass MwMenuClass;

+
MWDECL MwClass MwMenuClass;

 

 

 	Menu widget class.
 

 

 

-
MWDECL MwMenu MwMenuAdd (
+
MWDECL MwMenu MwMenuAdd (
 	MwWidget handle,
 	MwMenu menu,
 	const char* name
@@ -1449,28 +1611,21 @@
 
 
 

-
Mw/Milsko.h

-

-

-	Includes all headers.
-

-

-

-
Mw/OpenGL.h

+
Mw/Widget/OpenGL.h

 

 

 	OpenGL widget.
 

 

 

-
MWDECL MwClass MwOpenGLClass;

+
MWDECL MwClass MwOpenGLClass;

 

 

 	OpenGL widget class.
 

 

 

-
MWDECL void MwOpenGLMakeCurrent (
+
MWDECL void MwOpenGLMakeCurrent (
 	MwWidget handle
 );

 

@@ -1485,7 +1640,7 @@
 
 

 

-
MWDECL void* MwOpenGLGetProcAddress (
+
MWDECL void* MwOpenGLGetProcAddress (
 	MwWidget handle,
 	const char* name
 );

@@ -1513,7 +1668,7 @@
 
 
 

-
MWDECL void MwOpenGLSwapBuffer (
+
MWDECL void MwOpenGLSwapBuffer (
 	MwWidget handle
 );

 

@@ -1528,55 +1683,73 @@
 
 

 

-
Mw/StringDefs.h

+
Mw/Widget/ScrollBar.h

 

 

-	String definitions for property.
+	ScrollBar widget.
 

 

 

-
Mw/SubMenu.h

+
MWDECL MwClass MwScrollBarClass;

+

+

+	ScrollBar widget class.
+

+

+

+
MWDECL int MwScrollBarGetVisibleLength (
+	MwWidget handle
+);

+

+

+	Calculates a visible length of scrollbar.
+

+

+	Parameter handle
+

+

+	Widget.
+

+

+	Returns
+

+

+	Visible length.
+

+

+

+
Mw/Widget/SubMenu.h

 

 

 	SubMenu widget.
 

 

 

-
MWDECL MwClass MwSubMenuClass;

+
MWDECL MwClass MwSubMenuClass;

 

 

 	SubMenu widget class.
 

 

 

-
Mw/TypeDefs.h

-

-

-	Type definitions.
-

-

-

-
Mw/Vulkan.h

+
Mw/Widget/Vulkan.h

 

 

 	Vulkan widget.
 

 

-	warning
+	
warningThis header is not documented yet.

 

-

-	This header is not documented yet.
-

 

 

-
MWDECL MwClass MwVulkanClass;

+
MWDECL MwClass MwVulkanClass;

 

 

 	Vulkan widget class.
 

 

 

-
MWDECL void MwVulkanEnableExtension (
+
MWDECL void MwVulkanEnableExtension (
 	const char* ext_name
 );

 

@@ -1584,14 +1757,11 @@
 	Add an extension to the list of extensions to enable prior to initialization.
 
 

-	warning
+	
warningThis must be called before MwCreateWidget.

 

-

-	This must be called before MwCreateWidget.
-

 

 

-
MWDECL void MwVulkanEnableLayer (
+
MWDECL void MwVulkanEnableLayer (
 	const char* ext_name
 );

 

@@ -1599,42 +1769,39 @@
 	Add an layer to the list of layers to enable prior to initialization.
 
 

-	warning
+	
warningThis must be called before MwCreateWidget.

 

-

-	This must be called before MwCreateWidget.
-

 

 

-
typedef struct MwVulkanConfig_T;

+
typedef struct MwVulkanConfig_T;

 

 

 	Configuration options that can be passed to setup Vulkan before a widget is created.
 

 

 

-
 uint32_t api_version;

+
 uint32_t api_version;

 

 

 	Vulkan API version (default: VK_API_VERSION_1_0).
 

 

 

-
 uint32_t vk_version;

+
 uint32_t vk_version;

 

 

 	Vulkan version (default: VK_VERSION_1_0).
 

 

 

-
 VkBool32 validation_layers;

+
 VkBool32 validation_layers;

 

 

 	Whether or not to enable validation layers (default: false).
 

 

 

-
MWDECL void MwVulkanConfigure (
+
MWDECL void MwVulkanConfigure (
 	MwVulkanConfig cfg
 );

 

@@ -1642,84 +1809,81 @@
 	Configure Vulkan prior to initializing the widget.
 
 

-	warning
+	
warningThe configuration provided will be used for future initializations of the Vulkan widget (unless it's changed).

 

-

-	The configuration provided will be used for future initializations of the Vulkan widget (unless it's changed).
-

 

 

-
typedef enum MwVulkanField_T;

+
typedef enum MwVulkanField_T;

 

 

 	Field that can be gotten from Vulkan.
 

 

 

-
 MwVulkanField_GetInstanceProcAddr = 0

+
 MwVulkanField_GetInstanceProcAddr = 0

 

 

 	The address of the vulkan widget's vkGetInstanceProcAddr function (PFN_vkGetInstanceProcAddr).
 

 

 

-
 MwVulkanField_Instance

+
 MwVulkanField_Instance

 

 

 	The address of the vulkan widget's instance (VkInstance).
 

 

 

-
 MwVulkanField_Surface

+
 MwVulkanField_Surface

 

 

 	The address of the vulkan widget's surface (VkSurfaceKHR).
 

 

 

-
 MwVulkanField_PhysicalDevice

+
 MwVulkanField_PhysicalDevice

 

 

 	The address of the vulkan widget's physical device (VkPhysicalDevice).
 

 

 

-
 MwVulkanField_LogicalDevice

+
 MwVulkanField_LogicalDevice

 

 

 	The address of the vulkan widget's logical device (VkDevice).
 

 

 

-
 MwVulkanField_GraphicsQueueIndex

+
 MwVulkanField_GraphicsQueueIndex

 

 

 	The address of the index that the vulkan widget uses for the graphics queue (uint32_t *).
 

 

 

-
 MwVulkanField_PresentQueueIndex

+
 MwVulkanField_PresentQueueIndex

 

 

 	The address of the index that the vulkan widget uses for the present queue (uint32_t *).
 

 

 

-
 MwVulkanField_PresentQueue

+
 MwVulkanField_PresentQueue

 

 

 	The address of the vulkan widget's graphics queue (VkQueue).
 

 

 

-
} MwVulkanField;

+
} MwVulkanField;

 

 

 	The address of the vulkan widget's present queue (VkQueue).
 

 

 

-
MWDECL void* MwVulkanGetField (
+
MWDECL void* MwVulkanGetField (
 	MwWidget handle,
 	MwVulkanField field,
 	MwErrorEnum* out
@@ -1729,14 +1893,11 @@
 	Function for getting a field from within Vulkan.
 
 

-	warning
+	
warningConsult the documentation for MwVulkanField to know what type is expected for out.

 

-

-	Consult the documentation for MwVulkanField to know what type is expected for out.
-

 
 

-
MWDECL VkBool32 MwVulkanSupported (
+
MWDECL VkBool32 MwVulkanSupported (
 	void
 );

 

@@ -1745,14 +1906,14 @@
 
 

 

-
Mw/Window.h

+
Mw/Widget/Window.h

 

 

 	Window widget.
 

 

 

-
MWDECL MwClass MwWindowClass;

+
MWDECL MwClass MwWindowClass;

 

 

 	Window widget class.
diff --git a/tools/doc.pl b/tools/doc.pl
index dbaeea2..4ef4f95 100755
--- a/tools/doc.pl
+++ b/tools/doc.pl
@@ -145,11 +145,8 @@ sub scan_dir {
                 foreach my $note (@notes) {
                     if (defined($kv{$note})) {
                         out("
");
-                        out("	\"$note\"");
+                        out("	
\"$note\"" . sentence($kv{$note}) . "
");
                         out("
");
-                        out("
");
-                        out("	" . sentence($kv{$note}));
-                        out("
");
                     }
                 }