overlay.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file overlay.h
//! \brief Defines Lua bindings for overlay functionality in VREngage
//!
//! This file contains the function for registering overlay functionality with Lua.
//! It allows Lua scripts to create and manipulate 2D overlays in the 3D environment,
//! enabling the creation of heads-up displays, user interfaces, and other 2D visual
//! elements within the VREngage system.
 
#pragma once
 
#include "vreLuaBindings/export.h"
 
struct lua_State;
 
namespace makVre
{
//! \brief Registers overlay functions with a Lua state
//! \param L Pointer to the Lua state to register with
//! \return Number of values pushed onto the Lua stack
//!
//! This function registers overlay functionality with the specified Lua state.
//! It creates an Overlay table in Lua with functions for creating and manipulating
//! 2D overlays in the 3D environment. Overlays can be used to create heads-up displays,
//! user interfaces, and other 2D visual elements that can be positioned and oriented
//! within the VREngage 3D world.
int VRELUABINDING_DLL luaopen_Overlay(lua_State* L);
} // namespace makVre