crt.hpp File Reference

CRT - Main entry point of a hikogui program. More...

#include <vma/vk_mem_alloc.h>
#include "win32_headers.hpp"

Go to the source code of this file.

Functions
	hi_warning_push ()
	hi_warning_ignore_clang ("-Wunused-variable")
	hi_warning_ignore_clang ("-Wreorder")
	hi_warning_ignore_clang ("-Wunused-private-field")
	hi_warning_ignore_msvc (4127)
	hi_warning_ignore_msvc (6011)
	hi_warning_ignore_msvc (6386)
	hi_warning_ignore_msvc (6387)
	hi_warning_ignore_msvc (4701)
	hi_warning_ignore_msvc (4703)
	hi_warning_ignore_msvc (4189)
	hi_warning_pop ()
int	hi_main (int argc, char *argv[])
	Main entry-point.
int WINAPI	WinMain (_In_ HINSTANCE hInstance, _In_opt_ HINSTANCE hPrevInstance, _In_ LPSTR lpCmdLine, _In_ int nShowCmd)
	Windows entry-point.

Detailed Description

CRT - Main entry point of a hikogui program.

This header file will abstract the entry point for a program for different operating systems, and call the hi_main() function that should be defined as a portable entry point of the program.

This header should be included only once by a only a single translation-unit, as it defines main() or WinMain().

The work done by this abstraction is purposefully very limited, its task it to make sure the command-line arguments are split into tokens according to the rules of the operating system's shell. And that the command line arguments are encoded as UTF-8.

Function Documentation

hi_main()

int hi_main	(	int	argc,
		char *	argv[] )

Main entry-point.

Parameters

argc	Number of arguments
argv	A nullptr terminated list of pointers to null terminated strings.

Returns

Exit code.

WinMain()

int WINAPI WinMain	(	_In_ HINSTANCE	hInstance,
		_In_opt_ HINSTANCE	hPrevInstance,
		_In_ LPSTR	lpCmdLine,
		_In_ int	nShowCmd )

Windows entry-point.

This function will call hi_main().

It will use GetCommandLineW() to retrieve the command line in Unicode.

The nShowCmd is used to insert add a command line argument at index 1:

• 1,4,5,8,9,10: (No command line argument added)
• 3: –window-state=maximize
• 0,2,6,7,11: –window-state=minimize