Octane Standalone Documentation

The OSL texture node is a scriptable node that lets you write scripts using OSL (Open Shader Language) to define arbitrary texture types and create customized OctaneRender® materials and shaders. To learn about the generic OSL standard, please read the OSL Readme and PDF documentation.

An OSL script is written into the OSL texture node from the Script Editor window. Click on the Pencil icon to open the Script Editor. If the script exists as an external OSL file, click the Load icon to insert the OSL file into the node. You can edit any existing file used within an OSL texture node. To refresh the file after editing, click the Reload icon.

Figure 1: Reload icon

The OSL texture requires one output color. One OSL texture node is one OSL compilation unit, which contains only one shader. The OSL texture node has one Output attribute pin that connects to the Texture input pin of other Texture nodes (like Turbulence), or to the Texture input pin of Octane materials (like Diffuse).

OctaneRender® supports most of the texturing functions (like Textures or Noises) in the OSL Specification.

When you invoke an OSL texture, it comes with an initial script that has declaration component and includes one output variable, which represents a color. The initial script’s function body then initializes the color to black based on the standard RGB color mode. You can customize the script to create a customized OSL texture shader. A custom script may have many variables, some of which require input through the Input nodes. Depending on the custom script, the OSL texture may have an input of 0, or many Input nodes.

Figure 2: An OSL texture node’s initial script containing an OSL program code to calculate the output color

Figure 3: The Compile button

 

The example in Figure 4 below shows an OSL shader that adds two RGB textures.

Shader Add (

color a = 0,

color b = 0,

output color c = 0)

{

c = a + b;

}

The script’s declaration component has three variables: two are input variables of Input Type color, and the third one is the required output represented by a variable of Output Type color. The OSL Input/Output Type color corresponds to an Octane Texture attribute node. The script’s function body adds the two input parameters and places the result into the output variable.

For a list of OSL variable declaration Input/Output types in the OSL dpecification that OctaneRender® supports, see the Appendix topic on OSL Implementation in OctaneRender® in this manual. To learn more about scripting within OctaneRender® using OSL, see the The Octane OSL Guide.

Figure 4: An example of an OSL Texture node with an OSL script to add two Input texture nodes and send the result to one output

 

Once the OSL texture is available, OctaneRender® plugs it into a Material node's Texture input pin. Similar to other Procedural texture types, it can replace its own initial attributes with other applicable texture types in the course of the texturing process. For example, the OctaneRender® Texture attribute in Figure 3 is an RGB Color texture at first, but you can change it to any applicable OctaneRender® texture from its representation on the Inspector node to further customize the OSL shader (Figure 5).

Figure 5: Changing the input node to customize the OSL shader

 

To learn more about the OSL implementation in OctaneRender®, see the Appendix in this manual for more OSL-related topics.