Skip to end of metadata
Go to start of metadata

Page Contents ×

 

This page provides information on V-Ray SDK.

Overview

The V-Ray SDK is included with the installation of V-Ray for 3ds Max and allows the creation of V-Ray compatible materials, textures, lights, atmospheric effects, cameras, and custom geometric primitives. In addition, the V-Ray SDK includes the source code for some of the additional V-Ray plugins - for example, the VRayDomeCamera plugin.


Installation

The V-Ray SDK is installed with the "Workstation" installation type and is normally installed in the folder "C:\Program Files\Chaos Group\V-Ray\3ds Max NNNN" where NNNN is the version of 3ds Max (2020, 2021, etc.).


Folder Structure

The V-Ray SDK includes the following folders:

\docs – Includes general information about the V-Ray architecture as well as a help file vrayclasses.chm with documentation of the various classes in the SDK. The vrayclasses.chm file is automatically generated from the header files included with the SDK.

\include – Contains the header files for the V-Ray SDK needed for compiling 3ds Max plugins that use the V-Ray SDK.

\lib – Contains the library files needed for linking plugins that use the V-Ray SDK.

\samples – Includes the source code for some of the plugins that ship with V-Ray (e.g. the VRayDomeCamera plugin), as well as some additional samples (e.g. VRayBlinnMtl)


Compiling the Samples

The sample projects come with a CMake project that can be used to generate Microsoft Visual Studio 2017 solutions or Ninja projects.

A matching 3ds Max SDK is needed to build the example projects. The setup needs the CMake variable 3DSMAX_SDK_ROOT set to point to the 3ds Max SDK root.

V-Ray solutions have some options that are conditionally defined in few stages of the CMake configuration process. Because of this when using the CMake GUI one may have perform the configure step few times so all the options are set-up.

To get started with the samples for 3ds Max 2022:

  1. Open command prompt in the samples directory, e.g. C:\Program Files\Chaos Group\V-Ray\3ds Max 2022\samples
  2. Execute CMake, e.g. cmake -B"C:\build\VRay3dsMax2022Samples" -H"." -G"Visual Studio 15 2017" -A"x64" -T"v141" -D"3DSMAX_SDK_ROOT=D:\conan\pack\Max2022SDK"

If no errors occurred, the solutions should be in the output directory specified by "-B".

 

 If you are using V-Ray Next and older versions of 3ds Max, click here to see how to compile samples.

The project files for the samples are in .dsp file format and need to be converted for newer versions of Visual Studio.

To build the samples for 3ds Max 2013 and later, follow these steps:

  1. Open the respective Visual Studio version that you need for the particular 3ds Max version (Visual Studio 2010 for 3ds Max 2013 and 3ds Max 2014, Visual Studio 2012 for 3ds Max 2015);
  2. Click File > Open > Project/solution... and select the .dsp file for the project that you want to compile;
  3. Visual Studio asks whether you want to upgrade the project; click OK and let Visual Studio do the conversion;
  4. Right-click on the project in the Solution Explorer and select Properties;
  5. Click the Configuration Manager... button;
  6. Click the Active solution configuration drop-down and select <New...>;
  7. Type a name for the new configuration, i.e. "max 2013 release";

  8. Set the Copy settings from drop-down to the Max Release Official configuration;

    It is important to base the new configuration on the Max Release Official one; other configurations do not compile properly.

  9. Make sure the check-box Create new project configurations is enabled;

  10. Click OK to create the new configuration;
  11. Click on the Active solution platform drop-down and select <New...>;
  12. Select the x64 platform;
  13. In the Copy settings from drop-down, select Win32;
  14. Make sure that Create new project platforms option is selected;
  15. Click OK to add the new platform;
  16. In the General section of the configuration properties, set the Character Set property to Use Unicode Character Set (for 3ds Max 2012 and earlier, leave this to Use Multi-Byte Character Set);
  17. In the C/C++ section of the configuration, in the Addition Include Directories property, replace the occurrences of k:\3dsmax\maxsdk2013 with the path to your installation of the 3ds Max SDK;
  18. In the Linker section of the configuration, in the Additional Library Directories property, replace k:\3dsmax\max2014\Lib\x64 with the path to the library files from your installation of the 3ds Max SDK.

You should now be able to build the project successfully.