customOp

beta
Input 1
Input 2
Input 3
Input 4
Input 5
Input 6
Input 7
Input 8
custom
customOp
RayTK
v0.42

A custom operator that integrates blocks of custom shader code into a RayTK network.

When created, the operator will also create several docked operators that are used to provide define behavior.

Shader Code

The Function code is the main block that defines the behavior of the op. It contains the definition of a function named thismap. This function must take two parameters: a coordinate named p, and a context value named ctx. The function returns some supported type of value.

Type Aliases

Within shader code, CoordT, ContextT, and ReturnT are replaced with the actual types that the OP is using. This allows you to define an OP as using whatever kind of coordinates its input uses (e.g. vec2 or vec3) without having to change the code.

ReturnT thismap(CoordT p, ContextT ctx)  {
  // custom code goes here
}

Prefixes and Uniqueness

Any functions, global variables, and macros defined in the shader code will be inserted into the generated shader. This means that they cannot conflict with things defined in any other OP or in the toolkit’s libraries. This can be a problem when copying and pasting code from Shadertoy or elsewhere.

To avoid this, when defining any functions, global variables, or macros, use the prefix THIS_, which gets replaced with a unique op-specific prefix.

float THIS_helperFunc(vec2 foo) {
  return foo.x * 12 + foo.y;
}
#define THIS_helperMacro    1.2345
float THIS_globalVar = 3;

ReturnT thismap(CoordT p, ContextT ctx) {
  if (p.y > THIS_globalVar) {
    THIS_globalVar = p.y;
  }
  return vec4(THIS_helperFunc(p.xy), THIS_helperMacro, THIS_globalVar, 0.);
}

Using Inputs

ROPs connected to the inputs of the customOp are available to be called as functions named inputOp1, inputOp2, etc. When calling these, pass in some type of coordinate value and the ctx context value passed into the thismap function.

ReturnT thismap(CoordT p, ContextT ctx) {
    return inputOp1(p.xz + vec2(THIS_Foo, 1.0), ctx);
}

More Information About Shader Code

See Writing ROP Code for more details about ROP code. Note that some features described there may not be available for use with customOp.

Custom Parameters

In order to control the behavior of the op, you can create custom parameters on the associated “params” COMP which is created along with the customOp. These parameters can be used in the shader code as variables named like THIS_Paramname.

The customOp’s “Tools” parameter page includes several pulse parameters that can help automatically manage these custom parameters based on the shader code. For example, ‘Createmissingparams’ will add new custom parameters that are referenced in the shader code but are missing on the “params” COMP.

For multi-part parameters (Par styles including XYZ, RGBA, UV and Float/Int with more than 1 part) the alias evaluates to a value of the relevant vec* type, with the name of the tuplet without any suffix, which combines all of those parts (e.g. THIS_Translate).

Parameters

Name Description Regular Handling Read-Only Handling
Enable
Code
Op Globals
Init Code
Function

DAT with the main shader function.
Material Code

DAT with the optional material snippet.
Settings
Macro Table
Buffer Table
Texture Table
Library Names
  • hg_sdf:
  • raytkCommon:
  • raytkSdf:
  • raytkMaterial:
Types
Coord Type

The type of coordinates that the op uses.
  • Auto:
  • 1D:
  • 2D:
  • 3D:
Return Type

The type of return value produced by the op.
  • SDF Result:
  • Float:
  • Vector4:
  • Ray:
  • Light:
Context Type

The type of return value produced by the op.
  • Auto:
  • Context: The most commonly used context type, used for the main scene graph.
  • MaterialContext:
  • CameraContext:
  • LightContext:
  • RayContext:
Params OP

The COMP that contains any custom parameters used by the op.
Create Op Globals
Create Init
Create Function
Create Material
Create Params OP

Creates and attaches a new COMP for Paramsop, if there is none.
Create Missing Params

Adds any parameters referred to by shader code that aren’t defined in the Paramsop.
Remove Unused Params

Removes any custom parameters from the Paramsop that aren’t used in the shader code.
Auto Create Missing Params

Automatically create custom parameters whenever shader code changes.
Use Input Coord Type
Use Input Return Type
Use Input Context Type
Variable Table
Create Stage Init
Create Buffer Table
Create Macro Table
Create Texture Table
Create Variable Table

Inputs

  • Input 1: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4 Sdf Volume Ray Light Particle
  • Input 2: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4 Sdf Volume Ray Light Particle
  • Input 3: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4 Sdf Volume Ray Light Particle
  • Input 4: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4 Sdf Volume Ray Light Particle
  • Input 5: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4 Sdf Volume Ray Light Particle
  • Input 6: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4 Sdf Volume Ray Light Particle
  • Input 7: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4 Sdf Volume Ray Light Particle
  • Input 8: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4 Sdf Volume Ray Light Particle