binding.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file binding.h
//! \brief Defines functions for registering and loading Lua bindings
//!
//! This file contains functions for registering and loading Lua bindings for the
//! VREngage system. It provides a mechanism to register C++ functions that will
//! be exposed to Lua scripts, allowing Lua code to interact with the native
//! functionality of the VREngage application.
 
#pragma once
 
#include "vreLuaBindings/export.h"
 
struct lua_State;
 
namespace makVre
{
//! \brief Function pointer type for Lua binding registration functions
//!
//! This type represents functions that register C++ functionality with Lua.
//! These functions take a lua_State pointer and return an integer representing
//! the number of values pushed onto the Lua stack.
typedef int (*DtLuaRegistrationFunc)(lua_State* L);
 
//! \brief Loads all registered VREngage bindings into a Lua state
//! \param L Pointer to the Lua state to load bindings into
//!
//! This function loads all registered VREngage bindings into the specified Lua state.
//! It should be called once for each Lua state that needs access to VREngage functionality.
void VRELUABINDING_DLL DtLoadVreBindings(lua_State* L);
 
//! \brief Initializes the default set of VREngage Lua bindings
//!
//! This function registers the default set of VREngage Lua bindings.
//! It should be called once during application startup before any Lua states
//! are created or any custom bindings are registered.
void VRELUABINDING_DLL DtInitializeDefaultBindings();
 
//! \brief Registers a custom binding function
//! \param func Function pointer to the binding function to register
//!
//! This function registers a custom binding function that will be called
//! when DtLoadVreBindings is called. Use this to extend the Lua scripting
//! capabilities with custom functionality.
void VRELUABINDING_DLL DtRegisterBindingFunction(DtLuaRegistrationFunc func);
} // namespace makVre