yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
yaze_extension Struct Reference

Extension interface for YAZE. More...

#include <yaze.h>

Public Attributes

const char * name
 
const char * version
 
const char * description
 
const char * author
 
int api_version
 
yaze_status(* initialize )(yaze_editor_context *context)
 Initialize the extension.
 
void(* cleanup )(void)
 Clean up the extension.
 
uint32_t(* get_capabilities )(void)
 Get extension capabilities.
 

Detailed Description

Extension interface for YAZE.

Defines the interface for YAZE extensions. Extensions can add new functionality to YAZE and can be written in C or other languages.

Definition at line 516 of file yaze.h.

Member Data Documentation

◆ name

const char* yaze_extension::name

Extension name (must not be NULL)

Definition at line 517 of file yaze.h.

◆ version

const char* yaze_extension::version

Extension version string

Definition at line 518 of file yaze.h.

◆ description

const char* yaze_extension::description

Brief description of functionality

Definition at line 519 of file yaze.h.

◆ author

const char* yaze_extension::author

Extension author

Definition at line 520 of file yaze.h.

◆ api_version

int yaze_extension::api_version

Required YAZE API version

Definition at line 521 of file yaze.h.

◆ initialize

yaze_status(* yaze_extension::initialize) (yaze_editor_context *context)

Initialize the extension.

Called when the extension is loaded. Use this to set up any resources or state needed by the extension.

Parameters
contextEditor context provided by YAZE
Returns
YAZE_OK on success, error code on failure

Definition at line 532 of file yaze.h.

Referenced by yaze::editor::ExtensionManager::LoadExtension().

◆ cleanup

void(* yaze_extension::cleanup) (void)

Clean up the extension.

Called when the extension is unloaded. Use this to clean up any resources or state used by the extension.

Definition at line 540 of file yaze.h.

◆ get_capabilities

uint32_t(* yaze_extension::get_capabilities) (void)

Get extension capabilities.

Returns a bitmask indicating what features this extension provides.

Returns
Capability flags (see YAZE_EXT_CAP_* constants)

Definition at line 549 of file yaze.h.


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