rampField

rampField

Field that produces values that fade from one value to another along an axis or line.

Parameters

Name Description Regular Handling Read-Only Handling
Enable
Coordinate Mode

Whether to specify the ends of the ramp using an axis or arbitrary points.

  • Axis:
  • Endpoints:
Axis

Which axis of the position (or coord input) the ramp should use.

Semi-Baked Semi-Baked
  • X:
  • Y:
  • Z:
  • Distance From Origin:
Coordinate Range

The start and end of the ramp along the chosen axis.

Runtime Baked
Point 1

The start point when using arbitrary points.

Runtime Baked
Point 2

The ened point when using arbitrary points.

Runtime Baked
Extend Mode

How to handle points outside the specified range.

Semi-Baked Semi-Baked
  • Hold:
  • Zero:
  • Repeat:
  • Mirror:
Return Type

What type of values to produce (single number floats or vectors).

  • Float:
  • Vector:
Value 1

The value at the start of the ramp. If in float mode only the first part is used.

Runtime Baked
Value 2

The value at the end of the ramp. If in float mode only the first part is used.

Runtime Baked
Coord Type
  • Auto:
  • 1D:
  • 2D:
  • 3D:

Inputs

  • Coordinate Field: (required)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4
  • Point 1 Field: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4
  • Point 2 Field: (optional)
    • Coordinate Types: float vec2 vec3 vec4
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float vec4
  • Easing Function: (optional)
    • Coordinate Types: float
    • Context Types: Context MaterialContext CameraContext LightContext RayContext ParticleContext VertexContext PixelContext
    • Return Types: float