C/C++ SDK / C ABI / Editor

Editor

Constants and types of this part of kroys/kroys_plugin.h.

Headerkroys/kroys_plugin.h

SDK2.2.0

Structs and enums

KroysCommandDescA command (editor->RegisterCommand): command palette, Tools > Plugins menu, optional toolbar button and shortcut.KroysCommandCallbacksWhat a command runs (main thread).KroysPanelDescA dockable panel (editor->RegisterPanel), listed under Window.KroysDrawArgsPassed to every draw callback (panels, settings pages, viewport tools).KroysDrawCallbacksA draw callback (panels and settings pages).KroysSettingsPageDescA page in Settings > PLUGINS (editor->RegisterSettingsPage).KroysFileJobA file conversion running on a worker thread (import or export).KroysImporterDescAn importer (editor->RegisterImporter): File > Import and content drops of its extensions.KroysExporterDescAn exporter (editor->RegisterExporter): File > Export with Plugin.KroysFileJobCallbacksWhat an importer or exporter runs.KroysByteSinkReceives bytes: the plugin writes into it (asset hooks), the host writes into it (assets->ReadContentFile).KroysAssetTypeDescA plugin asset type (editor->RegisterAssetType): files with its extension in the Content Browser.KroysAssetTypeCallbacksThe hooks of a plugin asset type (all optional; main thread).KroysServiceCallbacksA per-frame editor service (editor->RegisterService).KroysAutomationJobContext of an automation step run by a capture script.KroysAutomationCallbacksAn automation step (editor->RegisterAutomationStep): capture scripts run it as `plugin-step [argument]`.KroysOperationCallbacksProgress and result of a long-running editor operation (editor->StartOperation, 2.2).KroysEditorApiThe editor: registrations, commands, notifications, the document scene, selection and undo transactions.

REFERENCE

Constants and types

Constants

##define KROYS_PANEL_CATEGORY_AUTHORING 0u

Not documented yet.

constant

##define KROYS_PANEL_CATEGORY_WORLD 1u

Not documented yet.

constant

##define KROYS_PANEL_CATEGORY_RUNTIME 2u

Not documented yet.

constant

##define KROYS_PANEL_CATEGORY_DIAGNOSTICS 3u

Not documented yet.

constant

##define KROYS_PANEL_SLOT_FLOATING 0u

Not documented yet.

constant

##define KROYS_PANEL_SLOT_RIGHT 1u

Not documented yet.

constant

##define KROYS_PANEL_SLOT_BOTTOM 2u

Not documented yet.

constant

##define KROYS_PANEL_SLOT_LEFT 3u

Not documented yet.

constant

kroys_plugin.h

#define KROYS_PANEL_CATEGORY_AUTHORING 0u
#define KROYS_PANEL_CATEGORY_WORLD 1u
#define KROYS_PANEL_CATEGORY_RUNTIME 2u
#define KROYS_PANEL_CATEGORY_DIAGNOSTICS 3u
#define KROYS_PANEL_SLOT_FLOATING 0u
#define KROYS_PANEL_SLOT_RIGHT 1u
#define KROYS_PANEL_SLOT_BOTTOM 2u
#define KROYS_PANEL_SLOT_LEFT 3u

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.