Namespace containing functions relating to the Blamite C# Interoperability API. More...

Namespaces
	DotNETHelpers
	Old namespace used for interacting with C#/.NET.

Functions
BLAM_EXT_API bool	MainWindowProcedure (SDL_Event event)
	Window Procedure for the main application window. More...

BLAM_EXT_API int	StartEngine (int args_count, char args[], SDL_Window window)
	Entry point for the engine. More...

BLAM_EXT_API void	MainLoop ()
	Function for the engine's main loop. More...

BLAM_EXT_API int	EngineThreadInit ()
	Performs any additional engine initialization that needs to be called within the engine loop thread. More...

BLAM_EXT_API void	CleanupEngineResources ()
	Instructs the engine to clean up any resources. More...

Detailed Description

Namespace containing functions relating to the Blamite C# Interoperability API.

The API calls available through this namespace are intended exclusively for hooking to the engine from C#. For a more general-purpose API, see Blam::API

Function Documentation

◆ CleanupEngineResources()

void Blam::InteropAPI::CleanupEngineResources ( )

Instructs the engine to clean up any resources.

Should be called at shutdown.

◆ EngineThreadInit()

int Blam::InteropAPI::EngineThreadInit ( )

Performs any additional engine initialization that needs to be called within the engine loop thread.

When using multiple threads for engine and main loop, this MUST be called from the same thread that MainLoop is called from.

◆ MainLoop()

void Blam::InteropAPI::MainLoop ( )

Function for the engine's main loop.

Should be called from the parent application's message loop.

◆ MainWindowProcedure()

bool Blam::InteropAPI::MainWindowProcedure ( SDL_Event event )

Window Procedure for the main application window.

The engine will let ImGUI try to handle the procedure first. If it doesn't, then it allows us to do so. This is the top-level function to control things like window resizing, keyboard input, menu bar interaction, and so on.

Note: If this function returns false, the parent loop should break and shutdown should be initiated.

Parameters

event - The SDL event that was fired.

Returns: false if the window should start closing, otherwise returns true.

◆ StartEngine()

int Blam::InteropAPI::StartEngine	(	int	args_count,
		char *	args[],
		SDL_Window *	window
	)

Entry point for the engine.