diff --git a/doc/programming/index.rst b/doc/programming/index.rst index 3f4ca34e..c0cef0bc 100644 --- a/doc/programming/index.rst +++ b/doc/programming/index.rst @@ -122,6 +122,9 @@ target directory. 5. Select the directory: ``cmake $PATH_TO_CLONED_REPO -DCMAKE_INSTALL_PREFIX=`` #. After building, install with ``cmake --install .`` +When building on Windows, use Visual Studio 2019 or later and make sure Windows SDK version 10.0.22000 or later is +installed (see `here `__ for more details). + .. tip:: As a reference, a working build configuration can be found in MuJoCo's `continuous integration setup `_ on GitHub. @@ -134,34 +137,34 @@ Header files The distribution contains several header files which are identical on all platforms. They are also available from the links below, to make this documentation self-contained. -mujoco.h   `(source) `__ +`mujoco.h `__ This is the main header file and must be included in all programs using MuJoCo. It defines all API functions and global variables, and includes the all other header files except mjxmacro.h. -mjmodel.h   `(source) `__ +`mjmodel.h `__ Defines the C structure :ref:`mjModel` which is the runtime representation of the model being simulated. It also defines a number of primitive types and other structures needed to define mjModel. -mjdata.h   `(source) `__ +`mjdata.h `__ Defines the C structure :ref:`mjData` which is the workspace where all computations read their inputs and write their outputs. It also defines primitive types and other structures needed to define mjData. -mjvisualize.h   `(source) `__ +`mjvisualize.h `__ Defines the primitive types and structures needed by the abstract visualizer. -mjrender.h   `(source) `__ +`mjrender.h `__ Defines the primitive types and structures needed by the OpenGL renderer. -mjui.h   `(source) `__ +`mjui.h `__ Defines the primitive types and structures needed by the UI framework. -mjtnum.h   `(source) `__ +`mjtnum.h `__ Defines MuJoCo's ``mjtNum`` floating-point type to be either ``double`` or ``float``. See :ref:`mjtNum`. -mjmacro.h   `(source) `__ +`mjmacro.h `__ Defines C macros that are useful in user code. -mjxmacro.h   `(source) `__ +`mjxmacro.h `__ This file is optional and is not included by mujoco.h. It defines :ref:`X Macros ` that can automate the mapping of mjModel and mjData into scripting languages, as well as other operations that require accessing all fields of mjModel and mjData. See code sample :ref:`testxml.cc `. -mjexport.h   `(source) `__ +`mjexport.h `__ Macros used for exporting public symbols from the MuJoCo library. This header should not be used directly by client code. -mjplugin.h   `(source) `__ +`mjplugin.h `__ Defines data structures required by :ref:`engine plugins`. .. _inVersion: