PolyphasePluginDesc Struct Reference

Plugin descriptor returned by PolyphasePlugin_GetDesc. More...

#include <PolyphasePluginAPI.h>

Public Attributes
uint32_t	apiVersion
const char *	pluginName
const char *	pluginVersion
int(*	OnLoad )(PolyphaseEngineAPI *api)
void(*	OnUnload )()
void(*	Tick )(float deltaTime)
void(*	TickEditor )(float deltaTime)
void(*	RegisterTypes )(void *nodeFactory)
void(*	RegisterScriptFuncs )(struct lua_State *L)
void(*	RegisterEditorUI )(EditorUIHooks *hooks, uint64_t hookId)
void(*	OnEditorPreInit )()
	Called before the editor ImGui context is fully initialized.
void(*	OnEditorReady )()
	Called after the editor is fully initialized, before the main loop starts.

Detailed Description

Plugin descriptor returned by PolyphasePlugin_GetDesc.

Contains plugin metadata and callback function pointers. All function pointers may be nullptr if not implemented.

Member Data Documentation

apiVersion

uint32_t PolyphasePluginDesc::apiVersion

OnEditorPreInit

void(* PolyphasePluginDesc::OnEditorPreInit) ()

Called before the editor ImGui context is fully initialized.

Use this to configure ImGui settings, add custom fonts, or set configuration flags before the UI is created. The ImGui context exists but has not been fully configured yet.

Set to nullptr if not needed.

OnEditorReady

void(* PolyphasePluginDesc::OnEditorReady) ()

Called after the editor is fully initialized, before the main loop starts.

At this point all editor systems are ready: ImGui is configured, the project is loaded (if any), and the UI is about to be shown. Safe to query project state, open windows, etc.

Set to nullptr if not needed.

OnLoad

int(* PolyphasePluginDesc::OnLoad) (PolyphaseEngineAPI *api)

OnUnload

void(* PolyphasePluginDesc::OnUnload) ()

pluginName

const char* PolyphasePluginDesc::pluginName

pluginVersion

const char* PolyphasePluginDesc::pluginVersion

RegisterEditorUI

void(* PolyphasePluginDesc::RegisterEditorUI) (EditorUIHooks *hooks, uint64_t hookId)

RegisterScriptFuncs

void(* PolyphasePluginDesc::RegisterScriptFuncs) (struct lua_State *L)

RegisterTypes

void(* PolyphasePluginDesc::RegisterTypes) (void *nodeFactory)

Tick

void(* PolyphasePluginDesc::Tick) (float deltaTime)

TickEditor

void(* PolyphasePluginDesc::TickEditor) (float deltaTime)

---

The documentation for this struct was generated from the following file:

• Engine/Source/Plugins/PolyphasePluginAPI.h