This page provides information on the OSL Material.
The VRayOSLMtl material can be used to load OSL shader code files (.osl) or OSL object code files (.oso) and render them directly with V-Ray.
The VRayOSLMtl plug-in can be used with shaders that use closure color output parameters. See the OSL Support page for more detailed descriptions and examples for writing an OSL shader in V-Ray.
Use the Quick Shader area to manually edit the shader's code.
Coordinates and Noise
The Coordinates and Noise rollouts are standard 3ds Max texture rollouts.
The General rollout holds parameters that control common shader characteristics.
Shader file – Specifies the .osl or .oso file which contains the shader (object) code. This button control also supports a context menu with the following options:
Clear – Unloads the current shader and restores the plug-in as if no shaders have been loaded.
Reset – Reloads the shader and resets its parameters to the default values.
Reload – Reloads the shader but keeps the current parameter values.
Open Containing Folder – Reveals the shader location in Explorer.
Open in External Editor – Opens the shader in an appropriate text editor.
Open in Quick Shader – Opens the loaded file's code in the text editor of the Quick Shader.
Copy File Path – Puts the full path of the currently loaded file in the clipboard.
Copy Folder Path – Copies the parent directory of the currently loaded file into the clipboard.
Recent Files – Holds a list of the recently loaded shaders and an option to clear the list.
|O||Open Containing Folder|
|X||Open in External Editor|
|Q||Open in Quick Shader|
|F||Copy File Path|
|P||Copy Folder Path|
|1-0||The first 10 items of the Recent Files submenu have assigned shortcuts from 1 to 0|
If you edit your OSL shader, the new version would be loaded only after a Clear, Reset, or a Reload option has been selected.
Closure output – Specifies the closure color source for the materials's output. The built-in output closure color parameter Ci is selected by default.
Max ray depth – Specifies the maximum reflection/refraction depth for the shader.
Show preview – Determines whether to render a shader preview in the 3ds Max Material Editor.
Clamp shader result – Determines whether to force the result into the [0, clamping limit] range.
Clamping limit – Specifies the upper clamp limit if clamp shader result is enabled.
Viewport color – Specifies the diffuse component of the material used in viewport shading.
Wrap texture coordinates – Automatically wraps the texture coordinates for the OSL shader, passing only values in the [0.0, 1.0] range.
Flip textures – Flips all attached textures vertically for compatibility with 3ds Max OSL Map.
Use uvgen – Uses the information from the UV Generator of the VRayOSLMtl. When disabled, uses information from the UV Generator of textures used or the OSL node.
Export shader name to OSO – Saves the shader as *.oso file.
Help button which opens a URL provided by the shader.–
Any additional shader - Specific parameters (if any) are listed in this rollout.
The Compiler diagnostics rollout holds shader compilation and manipulation result messages.
If you want to manually modify the shader's code, you can do that in the Quick Shader area.
Enable – Makes the Quick Shader's text area active.
Once enabled, place the original code inside the text area. Alternatively, start writing in the blank area your own code.
If you have already loaded a shader in the material parameters, right-click on it and select Open in Quick Shader option.
Another way to do this is to activate the text area and drag and drop the .osl file in there. It will load the code instantly.
Right-clicking on the Quick Shader panel opens a context menu. You can Compile the code after doing changes or Compile and Reset Parameters, which affects the values of the parameters in the shader as well.
Once ready with editing, press the Compile button to refresh the UI. Modifications are updated in the UI and renderer after the successful code compilation. You can monitor the messages in the Compiler diagnostics rollout during compilation.
The shader file originally loaded in the material (if any) will not be affected in the compilation. You need to manually save your code.
OSL Include Paths
Custom Include Paths – Search paths list that is used when an osl module is not found in the available system paths. You can Add or Remove additional paths directly from the UI by pressing the corresponding button.
- The VRayOSLMtl material automatically compiles OSL shaders to object code (OSO format) upon shader selection. No following compilations occur (even at render events). If the loaded OSL shader is modified, use the context menu options Reset or Reload of the Shader file button for your changes to take effect.
- An OSL compiler that translates *.osl files to *.oso files can be found in the tools subdirectory of V-Ray's root installation folder.
- OSL home page at SPI - Open Shading Language home page at Sony Pictures Imageworks
- OSL Google Code page - Google Code project page for Open Shading Language
- OSL GitHub page - GitHub project page for Open Shading Language