text.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file text.h
//! \brief Defines Lua bindings for text rendering functionality
//!
//! This file contains the function for registering text rendering functionality
//! with Lua. It allows Lua scripts to create and manipulate text elements in the
//! VREngage system, enabling the display of dynamic textual information in the
//! 3D environment for user interfaces, annotations, and other visual elements.
 
#pragma once
 
#include "vreLuaBindings/export.h"
 
struct lua_State;
 
namespace makVre
{
//! \brief Registers text rendering 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 text rendering functionality with the specified
//! Lua state. It creates a Text table in Lua with functions for creating and
//! manipulating text elements in the VREngage system. Text elements can be used
//! to display dynamic textual information in the 3D environment, including
//! labels, captions, status indicators, and other informational displays.
int VRELUABINDING_DLL luaopen_Text(lua_State* L);
} // namespace makVre