UserData

Overview

An object used to encapsulate arbitrary, user-specified primitive attributes. Geometry objects can specify a list UserData objects using the primitive_attributes parameter. The data is then available for shading or AOVs using an AttributeMap. See RdlPointGeometry for an example.


Attribute Reference

General attributes

bool_key

String
default:

key name for bool type user data

bool_values

BoolVector
default: {}

bool type user data values

color_key

String
default:

key name for color type user data

color_values_0

RgbVector
default: {}

color type user data values for motion step 0

color_values_1

RgbVector
default: {}

color type user data values for motion step 1

float_key

String
default:

key name for float type user data

float_values_0

FloatVector
default: {}

float type user data values for motion step 0

float_values_1

FloatVector
default: {}

float type user data values for motion step 1

int_key

String
default:

key name for integer type user data

int_values

IntVector
default: {}

integer type user data values

mat4f_key

String
default:

key name for mat4f type user data

mat4f_values_0

Mat4fVector
default: {}

mat4f type user data values for motion step 0

mat4f_values_1

Mat4fVector
default: {}

mat4f type user data values for motion step 1

rate

Int enum
  0 = “auto” (default)
  1 = “constant”
  2 = “part”
  3 = “uniform”
  4 = “vertex”
  5 = “varying”
  6 = “face varying”

The rate of the data. Auto mode will guess the rate by comparing the number of values to component(i.e. part, face. vertex) counts.

string_key

String
default:

key name for string type user data

string_values

StringVector
default: {}

string type user data values

vec2f_key

String
default:

key name for vec2f type user data

vec2f_values_0

Vec2fVector
default: {}

vec2f type user data values for motion step 0

vec2f_values_1

Vec2fVector
default: {}

vec2f type user data values for motion step 1

vec3f_key

String
default:

key name for vec3f type user data

vec3f_values_0

Vec3fVector
default: {}

vec3f type user data values for motion step 0

vec3f_values_1

Vec3fVector
default: {}

vec3f type user data values for motion step 1