v1.2.0
Quickstart
Introduction
Build
Examples
Version matrix
License
Building
Cloning
Build requirements
Build options
Project version
Building on Windows
Building on Linux natively
Viewer
ramses-logic-viewer
Lua configuration API
Lua Syntax
Quick start
Basics of Lua
Declaring an interface() and a run() function
Global variables and the init() function
Custom functions
Environments and isolation
Indexing inside Lua
Errors in scripts
Using Lua modules
Additional Lua syntax specifics
API
Overview
Logic node creation
Object lifecycle
Creating links between nodes
Linking logic nodes to Ramses scenes
Dynamic sorting of content
Animations
Error handling
Iterating over object collections
Saving/Loading from file
Logging
Security and memory safety
Performance
List of all examples
Class Index
Class Index
ChangeLog
master
Unreleased
v1.2.0
v1.1.1
v1.1.0
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v0.15.0
v0.14.2
v0.14.1
v0.14.0
v0.13.0
v0.12.0
v0.11.0
v0.10.2
v0.10.1
v0.10.0
v0.9.1
v0.9.0
v0.8.1
v0.8.0
v0.7.0
v0.6.2
v0.6.1
v0.6.0
v0.5.3
v0.5.2
v0.5.0
v0.4.2
v0.4.1
v0.4.0
v0.3.1
v0.3.0
v0.2.0
v0.1.0
Developers
Understand RAMSES Logic architecture and design
Developer guidelines
Contributing
Pull requests
Commit guidelines
Review
Code style
Continuous integration
Branching
ramses_logic
Docs
»
Index
Edit on GitHub
Index
Symbols
|
L
|
R
Symbols
--exec-lua=<lua>
ramses-logic-viewer command line option
--exec=<luafunction>
ramses-logic-viewer command line option
--headless
ramses-logic-viewer command line option
--height HEIGHT
ramses-logic-viewer command line option
--log-level-console [off|fatal|error|warn|info|debug|trace]
ramses-logic-viewer command line option
--msaa SAMPLES
ramses-logic-viewer command line option
--no-offscreen
ramses-logic-viewer command line option
--width WIDTH
ramses-logic-viewer command line option
--write-config [filename]
ramses-logic-viewer command line option
L
Logger::rlogic::SetDefaultLogging (C++ function)
Logger::rlogic::SetLogHandler (C++ function)
R
ramses-logic-viewer command line option
--exec-lua=<lua>
--exec=<luafunction>
--headless
--height HEIGHT
--log-level-console [off|fatal|error|warn|info|debug|trace]
--msaa SAMPLES
--no-offscreen
--width WIDTH
--write-config [filename]
rlogic::AnchorPoint (C++ class)
rlogic::AnchorPoint::AnchorPoint (C++ function)
,
[1]
,
[2]
rlogic::AnchorPoint::getRamsesCamera (C++ function)
rlogic::AnchorPoint::getRamsesNode (C++ function)
rlogic::AnchorPoint::m_anchorPointImpl (C++ member)
rlogic::AnchorPoint::operator= (C++ function)
,
[1]
rlogic::AnchorPoint::~AnchorPoint (C++ function)
rlogic::AnimationChannel (C++ struct)
rlogic::AnimationChannel::interpolationType (C++ member)
rlogic::AnimationChannel::keyframes (C++ member)
rlogic::AnimationChannel::name (C++ member)
rlogic::AnimationChannel::operator!= (C++ function)
rlogic::AnimationChannel::operator== (C++ function)
rlogic::AnimationChannel::tangentsIn (C++ member)
rlogic::AnimationChannel::tangentsOut (C++ member)
rlogic::AnimationChannel::timeStamps (C++ member)
rlogic::AnimationNode (C++ class)
rlogic::AnimationNode::AnimationNode (C++ function)
,
[1]
,
[2]
rlogic::AnimationNode::getChannels (C++ function)
rlogic::AnimationNode::m_animationNodeImpl (C++ member)
rlogic::AnimationNode::operator= (C++ function)
,
[1]
rlogic::AnimationNode::~AnimationNode (C++ function)
rlogic::AnimationNodeConfig (C++ class)
rlogic::AnimationNodeConfig::addChannel (C++ function)
rlogic::AnimationNodeConfig::AnimationNodeConfig (C++ function)
,
[1]
rlogic::AnimationNodeConfig::getChannels (C++ function)
rlogic::AnimationNodeConfig::getExposingOfChannelDataAsProperties (C++ function)
rlogic::AnimationNodeConfig::m_impl (C++ member)
rlogic::AnimationNodeConfig::operator= (C++ function)
,
[1]
rlogic::AnimationNodeConfig::setExposingOfChannelDataAsProperties (C++ function)
rlogic::AnimationNodeConfig::~AnimationNodeConfig (C++ function)
rlogic::Collection (C++ class)
rlogic::Collection::begin (C++ function)
,
[1]
rlogic::Collection::cbegin (C++ function)
rlogic::Collection::cend (C++ function)
rlogic::Collection::Collection (C++ function)
,
[1]
,
[2]
rlogic::Collection::const_iterator (C++ type)
rlogic::Collection::end (C++ function)
,
[1]
rlogic::Collection::iterator (C++ type)
rlogic::Collection::operator= (C++ function)
rlogic::Collection::pointer (C++ type)
rlogic::Collection::reference (C++ type)
rlogic::Collection::size (C++ function)
rlogic::Collection::value_type (C++ type)
rlogic::Collection::~Collection (C++ function)
rlogic::DataArray (C++ class)
rlogic::DataArray::DataArray (C++ function)
,
[1]
,
[2]
rlogic::DataArray::getData (C++ function)
rlogic::DataArray::getDataType (C++ function)
rlogic::DataArray::getNumElements (C++ function)
rlogic::DataArray::m_impl (C++ member)
rlogic::DataArray::operator= (C++ function)
,
[1]
rlogic::DataArray::~DataArray (C++ function)
rlogic::EFeatureLevel (C++ enum)
rlogic::EFeatureLevel::EFeatureLevel_01 (C++ enumerator)
rlogic::EFeatureLevel::EFeatureLevel_02 (C++ enumerator)
rlogic::EFeatureLevel::EFeatureLevel_03 (C++ enumerator)
rlogic::EInterpolationType (C++ enum)
rlogic::EInterpolationType::Cubic (C++ enumerator)
rlogic::EInterpolationType::Cubic_Quaternions (C++ enumerator)
rlogic::EInterpolationType::Linear (C++ enumerator)
rlogic::EInterpolationType::Linear_Quaternions (C++ enumerator)
rlogic::EInterpolationType::Step (C++ enumerator)
rlogic::ELogMessageType (C++ enum)
rlogic::ELogMessageType::Debug (C++ enumerator)
rlogic::ELogMessageType::Error (C++ enumerator)
rlogic::ELogMessageType::Fatal (C++ enumerator)
rlogic::ELogMessageType::Info (C++ enumerator)
rlogic::ELogMessageType::Off (C++ enumerator)
rlogic::ELogMessageType::Trace (C++ enumerator)
rlogic::ELogMessageType::Warn (C++ enumerator)
rlogic::EPropertyType (C++ enum)
rlogic::EPropertyType::Array (C++ enumerator)
rlogic::EPropertyType::Bool (C++ enumerator)
rlogic::EPropertyType::Float (C++ enumerator)
rlogic::EPropertyType::Int32 (C++ enumerator)
rlogic::EPropertyType::Int64 (C++ enumerator)
rlogic::EPropertyType::String (C++ enumerator)
rlogic::EPropertyType::Struct (C++ enumerator)
rlogic::EPropertyType::Vec2f (C++ enumerator)
rlogic::EPropertyType::Vec2i (C++ enumerator)
rlogic::EPropertyType::Vec3f (C++ enumerator)
rlogic::EPropertyType::Vec3i (C++ enumerator)
rlogic::EPropertyType::Vec4f (C++ enumerator)
rlogic::EPropertyType::Vec4i (C++ enumerator)
rlogic::ERotationType (C++ enum)
rlogic::ERotationType::Euler_XYZ (C++ enumerator)
rlogic::ERotationType::Euler_XZY (C++ enumerator)
rlogic::ERotationType::Euler_YXZ (C++ enumerator)
rlogic::ERotationType::Euler_YZX (C++ enumerator)
rlogic::ERotationType::Euler_ZXY (C++ enumerator)
rlogic::ERotationType::Euler_ZYX (C++ enumerator)
rlogic::ERotationType::Quaternion (C++ enumerator)
rlogic::ErrorData (C++ struct)
rlogic::ErrorData::message (C++ member)
rlogic::ErrorData::object (C++ member)
rlogic::ErrorData::type (C++ member)
rlogic::EStandardModule (C++ enum)
rlogic::EStandardModule::All (C++ enumerator)
rlogic::EStandardModule::Base (C++ enumerator)
rlogic::EStandardModule::Debug (C++ enumerator)
rlogic::EStandardModule::Math (C++ enumerator)
rlogic::EStandardModule::String (C++ enumerator)
rlogic::EStandardModule::Table (C++ enumerator)
rlogic::GetRamsesLogicVersion (C++ function)
rlogic::IsPrimitiveProperty (C++ struct)
rlogic::Iterator (C++ class)
rlogic::Iterator::difference_type (C++ type)
rlogic::Iterator::Iterator (C++ function)
,
[1]
,
[2]
,
[3]
rlogic::Iterator::iterator_category (C++ type)
rlogic::Iterator::operator!= (C++ function)
rlogic::Iterator::operator* (C++ function)
rlogic::Iterator::operator++ (C++ function)
,
[1]
rlogic::Iterator::operator-> (C++ function)
rlogic::Iterator::operator= (C++ function)
,
[1]
rlogic::Iterator::operator== (C++ function)
rlogic::Iterator::pointer (C++ type)
rlogic::Iterator::reference (C++ type)
rlogic::Iterator::value_type (C++ type)
rlogic::Iterator::~Iterator (C++ function)
rlogic::LogicEngine (C++ class)
rlogic::LogicEngine::createAnchorPoint (C++ function)
rlogic::LogicEngine::createAnimationNode (C++ function)
rlogic::LogicEngine::createDataArray (C++ function)
rlogic::LogicEngine::createLuaInterface (C++ function)
rlogic::LogicEngine::createLuaModule (C++ function)
rlogic::LogicEngine::createLuaScript (C++ function)
rlogic::LogicEngine::createRamsesAppearanceBinding (C++ function)
rlogic::LogicEngine::createRamsesCameraBinding (C++ function)
rlogic::LogicEngine::createRamsesCameraBindingWithFrustumPlanes (C++ function)
rlogic::LogicEngine::createRamsesNodeBinding (C++ function)
rlogic::LogicEngine::createRamsesRenderGroupBinding (C++ function)
rlogic::LogicEngine::createRamsesRenderPassBinding (C++ function)
rlogic::LogicEngine::createTimerNode (C++ function)
rlogic::LogicEngine::destroy (C++ function)
rlogic::LogicEngine::enableUpdateReport (C++ function)
rlogic::LogicEngine::extractLuaDependencies (C++ function)
rlogic::LogicEngine::findByName (C++ function)
,
[1]
rlogic::LogicEngine::findLogicObjectById (C++ function)
,
[1]
rlogic::LogicEngine::getCollection (C++ function)
rlogic::LogicEngine::getErrors (C++ function)
rlogic::LogicEngine::getFeatureLevel (C++ function)
rlogic::LogicEngine::GetFeatureLevelFromBuffer (C++ function)
rlogic::LogicEngine::GetFeatureLevelFromFile (C++ function)
rlogic::LogicEngine::getLastUpdateReport (C++ function)
rlogic::LogicEngine::getPropertyLinks (C++ function)
rlogic::LogicEngine::getSerializedSize (C++ function)
rlogic::LogicEngine::getTotalSerializedSize (C++ function)
rlogic::LogicEngine::isLinked (C++ function)
rlogic::LogicEngine::link (C++ function)
rlogic::LogicEngine::linkWeak (C++ function)
rlogic::LogicEngine::loadFromBuffer (C++ function)
rlogic::LogicEngine::loadFromFile (C++ function)
rlogic::LogicEngine::LogicEngine (C++ function)
,
[1]
,
[2]
,
[3]
rlogic::LogicEngine::m_impl (C++ member)
rlogic::LogicEngine::operator= (C++ function)
,
[1]
rlogic::LogicEngine::saveToFile (C++ function)
rlogic::LogicEngine::setStatisticsLoggingRate (C++ function)
rlogic::LogicEngine::setStatisticsLogLevel (C++ function)
rlogic::LogicEngine::unlink (C++ function)
rlogic::LogicEngine::update (C++ function)
rlogic::LogicEngine::validate (C++ function)
rlogic::LogicEngine::~LogicEngine (C++ function)
rlogic::LogicEngineReport (C++ class)
rlogic::LogicEngineReport::getNodesExecuted (C++ function)
rlogic::LogicEngineReport::getNodesSkippedExecution (C++ function)
rlogic::LogicEngineReport::getTopologySortExecutionTime (C++ function)
rlogic::LogicEngineReport::getTotalLinkActivations (C++ function)
rlogic::LogicEngineReport::getTotalUpdateExecutionTime (C++ function)
rlogic::LogicEngineReport::LogicEngineReport (C++ function)
,
[1]
,
[2]
,
[3]
rlogic::LogicEngineReport::LogicNodeTimed (C++ type)
rlogic::LogicEngineReport::operator= (C++ function)
,
[1]
rlogic::LogicEngineReport::~LogicEngineReport (C++ function)
rlogic::LogicNode (C++ class)
rlogic::LogicNode::getInputs (C++ function)
,
[1]
rlogic::LogicNode::getOutputs (C++ function)
rlogic::LogicNode::LogicNode (C++ function)
,
[1]
rlogic::LogicNode::m_impl (C++ member)
rlogic::LogicNode::operator= (C++ function)
,
[1]
rlogic::LogicNode::~LogicNode (C++ function)
rlogic::LogicObject (C++ class)
rlogic::LogicObject::as (C++ function)
,
[1]
rlogic::LogicObject::getId (C++ function)
rlogic::LogicObject::getName (C++ function)
rlogic::LogicObject::getUserId (C++ function)
rlogic::LogicObject::LogicObject (C++ function)
rlogic::LogicObject::operator= (C++ function)
rlogic::LogicObject::setName (C++ function)
rlogic::LogicObject::setUserId (C++ function)
rlogic::LogicObject::~LogicObject (C++ function)
rlogic::LuaConfig (C++ class)
rlogic::LuaConfig::addDependency (C++ function)
rlogic::LuaConfig::addStandardModuleDependency (C++ function)
rlogic::LuaConfig::LuaConfig (C++ function)
,
[1]
rlogic::LuaConfig::m_impl (C++ member)
rlogic::LuaConfig::operator= (C++ function)
,
[1]
rlogic::LuaConfig::~LuaConfig (C++ function)
rlogic::LuaInterface (C++ class)
rlogic::LuaInterface::LuaInterface (C++ function)
,
[1]
,
[2]
rlogic::LuaInterface::m_interface (C++ member)
rlogic::LuaInterface::operator= (C++ function)
,
[1]
rlogic::LuaInterface::~LuaInterface (C++ function)
rlogic::LuaModule (C++ class)
rlogic::LuaModule::LuaModule (C++ function)
,
[1]
,
[2]
rlogic::LuaModule::m_impl (C++ member)
rlogic::LuaModule::operator= (C++ function)
,
[1]
rlogic::LuaModule::~LuaModule (C++ function)
rlogic::LuaScript (C++ class)
rlogic::LuaScript::LuaScript (C++ function)
,
[1]
,
[2]
rlogic::LuaScript::m_script (C++ member)
rlogic::LuaScript::operator= (C++ function)
,
[1]
rlogic::LuaScript::~LuaScript (C++ function)
rlogic::Property (C++ class)
rlogic::Property::get (C++ function)
rlogic::Property::getChild (C++ function)
,
[1]
,
[2]
,
[3]
rlogic::Property::getChildCount (C++ function)
rlogic::Property::getIncomingLink (C++ function)
rlogic::Property::getName (C++ function)
rlogic::Property::getOutgoingLink (C++ function)
rlogic::Property::getOutgoingLinksCount (C++ function)
rlogic::Property::getOwningLogicNode (C++ function)
,
[1]
rlogic::Property::getType (C++ function)
rlogic::Property::hasChild (C++ function)
rlogic::Property::hasIncomingLink (C++ function)
rlogic::Property::hasOutgoingLink (C++ function)
rlogic::Property::isLinked (C++ function)
rlogic::Property::m_impl (C++ member)
rlogic::Property::operator= (C++ function)
,
[1]
rlogic::Property::Property (C++ function)
,
[1]
,
[2]
rlogic::Property::set (C++ function)
rlogic::Property::~Property (C++ function)
rlogic::PropertyEnumToType (C++ struct)
rlogic::PropertyLink (C++ struct)
rlogic::PropertyTypeToEnum (C++ struct)
rlogic::RamsesAppearanceBinding (C++ class)
rlogic::RamsesAppearanceBinding::getRamsesAppearance (C++ function)
rlogic::RamsesAppearanceBinding::m_appearanceBinding (C++ member)
rlogic::RamsesAppearanceBinding::operator= (C++ function)
,
[1]
rlogic::RamsesAppearanceBinding::RamsesAppearanceBinding (C++ function)
,
[1]
,
[2]
rlogic::RamsesAppearanceBinding::~RamsesAppearanceBinding (C++ function)
rlogic::RamsesBinding (C++ class)
rlogic::RamsesBinding::operator= (C++ function)
,
[1]
rlogic::RamsesBinding::RamsesBinding (C++ function)
,
[1]
,
[2]
rlogic::RamsesBinding::~RamsesBinding (C++ function)
rlogic::RamsesCameraBinding (C++ class)
rlogic::RamsesCameraBinding::getRamsesCamera (C++ function)
rlogic::RamsesCameraBinding::m_cameraBinding (C++ member)
rlogic::RamsesCameraBinding::operator= (C++ function)
,
[1]
rlogic::RamsesCameraBinding::RamsesCameraBinding (C++ function)
,
[1]
,
[2]
rlogic::RamsesCameraBinding::~RamsesCameraBinding (C++ function)
rlogic::RamsesNodeBinding (C++ class)
rlogic::RamsesNodeBinding::getRamsesNode (C++ function)
rlogic::RamsesNodeBinding::getRotationType (C++ function)
rlogic::RamsesNodeBinding::m_nodeBinding (C++ member)
rlogic::RamsesNodeBinding::operator= (C++ function)
,
[1]
rlogic::RamsesNodeBinding::RamsesNodeBinding (C++ function)
,
[1]
,
[2]
rlogic::RamsesNodeBinding::~RamsesNodeBinding (C++ function)
rlogic::RamsesRenderGroupBinding (C++ class)
rlogic::RamsesRenderGroupBinding::getRamsesRenderGroup (C++ function)
,
[1]
rlogic::RamsesRenderGroupBinding::m_renderGroupBinding (C++ member)
rlogic::RamsesRenderGroupBinding::operator= (C++ function)
,
[1]
rlogic::RamsesRenderGroupBinding::RamsesRenderGroupBinding (C++ function)
,
[1]
,
[2]
rlogic::RamsesRenderGroupBinding::~RamsesRenderGroupBinding (C++ function)
rlogic::RamsesRenderGroupBindingElements (C++ class)
rlogic::RamsesRenderGroupBindingElements::addElement (C++ function)
,
[1]
rlogic::RamsesRenderGroupBindingElements::m_impl (C++ member)
rlogic::RamsesRenderGroupBindingElements::RamsesRenderGroupBindingElements (C++ function)
rlogic::RamsesRenderPassBinding (C++ class)
rlogic::RamsesRenderPassBinding::getRamsesRenderPass (C++ function)
,
[1]
rlogic::RamsesRenderPassBinding::m_renderPassBinding (C++ member)
rlogic::RamsesRenderPassBinding::operator= (C++ function)
,
[1]
rlogic::RamsesRenderPassBinding::RamsesRenderPassBinding (C++ function)
,
[1]
,
[2]
rlogic::RamsesRenderPassBinding::~RamsesRenderPassBinding (C++ function)
rlogic::SaveFileConfig (C++ class)
rlogic::SaveFileConfig::m_impl (C++ member)
rlogic::SaveFileConfig::operator= (C++ function)
,
[1]
rlogic::SaveFileConfig::SaveFileConfig (C++ function)
,
[1]
rlogic::SaveFileConfig::setExporterVersion (C++ function)
rlogic::SaveFileConfig::setMetadataString (C++ function)
rlogic::SaveFileConfig::setValidationEnabled (C++ function)
rlogic::SaveFileConfig::~SaveFileConfig (C++ function)
rlogic::TimerNode (C++ class)
rlogic::TimerNode::m_timerNodeImpl (C++ member)
rlogic::TimerNode::operator= (C++ function)
,
[1]
rlogic::TimerNode::TimerNode (C++ function)
,
[1]
,
[2]
rlogic::TimerNode::~TimerNode (C++ function)
rlogic::WarningData (C++ struct)
rlogic::WarningData::message (C++ member)
rlogic::WarningData::object (C++ member)
rlogic::WarningData::type (C++ member)
Read the Docs
v: v1.2.0
Versions
latest
stable
v1.2.0
v1.1.1
v1.1.0
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v0.15.0
v0.14.2
v0.14.1
v0.14.0
v0.13.0
v0.12.0
v0.11.0
v0.10.2
v0.10.1
v0.10.0
v0.9.1
v0.9.0
v0.8.0
v0.7.0
v0.6.2
v0.6.1
v0.6.0
v0.5.3
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.