Logo
latest

Quickstart

  • Table of Contents
  • What is RAMSES
  • Obtaining the source code
  • Build instructions
  • License

Building

  • Cloning
  • Build requirements
  • Build options
  • Project version
  • Building on Windows
  • Building on Linux natively

Core API

  • Ramses Core overview
  • Advanced concepts
  • List of all examples

Logic API

  • Overview
  • Logic node creation
  • Object lifecycle
  • Creating links between nodes
  • Linking logic nodes to Ramses scene objects
  • Dynamic sorting of content
  • Animations
  • Error handling
  • Iterating over object collections
  • Security and memory safety
  • Performance
  • List of all logic examples

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

Viewer

  • ramses-viewer
  • Lua configuration API

Performance and Profiling

  • Performance and Profiling
  • Inspecting the contents of your scene and optimizing it
  • Looking at the Ramses periodic performance logs
  • Using specialized tools

Class Index

  • Class Index

ChangeLog

  • Ramses Changelog

Developers

  • Understand RAMSES Logic architecture and design
  • Developer guidelines
  • Contributing
  • Pull requests
  • Commit guidelines
  • Review
  • Code style
  • Continuous integration
  • Branching
ramses
  • Search

© Copyright 2020, BMW AG. Revision 068163a6.

Built with Sphinx using a theme provided by Read the Docs.