Skip to content

render_settings

Providing models and values for Maya Render Settings.

AdditionalOptionsModel

Bases: BaseSettingsModel

Additional Option

Source code in server/settings/render_settings.py 
282
283
284
285
286
287
class AdditionalOptionsModel(BaseSettingsModel):
    """Additional Option"""
    _layout = "compact"

    attribute: str = SettingsField("", title="Attribute name")
    value: str = SettingsField("", title="Value")

arnold_aov_list_enum()

Return enumerator for Arnold AOVs.

Key is value, Value in this case is Label. This

was taken from v3 settings.

Source code in server/settings/render_settings.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def arnold_aov_list_enum():
    """Return enumerator for Arnold AOVs.

    Note: Key is value, Value in this case is Label. This
        was taken from v3 settings.
    """
    return [
        {"value": "empty", "label": "< empty >"},
        {"value": "ID", "label": "ID"},
        {"value": "N", "label": "N"},
        {"value": "P", "label": "P"},
        {"value": "Pref", "label": "Pref"},
        {"value": "RGBA", "label": "RGBA"},
        {"value": "Z", "label": "Z"},
        {"value": "albedo", "label": "albedo"},
        {"value": "background", "label": "background"},
        {"value": "coat", "label": "coat"},
        {"value": "coat_albedo", "label": "coat_albedo"},
        {"value": "coat_direct", "label": "coat_direct"},
        {"value": "coat_indirect", "label": "coat_indirect"},
        {"value": "cputime", "label": "cputime"},
        {"value": "crypto_asset", "label": "crypto_asset"},
        {"value": "crypto_material", "label": "cypto_material"},
        {"value": "crypto_object", "label": "crypto_object"},
        {"value": "diffuse", "label": "diffuse"},
        {"value": "diffuse_albedo", "label": "diffuse_albedo"},
        {"value": "diffuse_direct", "label": "diffuse_direct"},
        {"value": "diffuse_indirect", "label": "diffuse_indirect"},
        {"value": "direct", "label": "direct"},
        {"value": "emission", "label": "emission"},
        {"value": "highlight", "label": "highlight"},
        {"value": "indirect", "label": "indirect"},
        {"value": "motionvector", "label": "motionvector"},
        {"value": "opacity", "label": "opacity"},
        {"value": "raycount", "label": "raycount"},
        {"value": "rim_light", "label": "rim_light"},
        {"value": "shadow", "label": "shadow"},
        {"value": "shadow_diff", "label": "shadow_diff"},
        {"value": "shadow_mask", "label": "shadow_mask"},
        {"value": "shadow_matte", "label": "shadow_matte"},
        {"value": "sheen", "label": "sheen"},
        {"value": "sheen_albedo", "label": "sheen_albedo"},
        {"value": "sheen_direct", "label": "sheen_direct"},
        {"value": "sheen_indirect", "label": "sheen_indirect"},
        {"value": "specular", "label": "specular"},
        {"value": "specular_albedo", "label": "specular_albedo"},
        {"value": "specular_direct", "label": "specular_direct"},
        {"value": "specular_indirect", "label": "specular_indirect"},
        {"value": "sss", "label": "sss"},
        {"value": "sss_albedo", "label": "sss_albedo"},
        {"value": "sss_direct", "label": "sss_direct"},
        {"value": "sss_indirect", "label": "sss_indirect"},
        {"value": "transmission", "label": "transmission"},
        {"value": "transmission_albedo", "label": "transmission_albedo"},
        {"value": "transmission_direct", "label": "transmission_direct"},
        {"value": "transmission_indirect", "label": "transmission_indirect"},
        {"value": "volume", "label": "volume"},
        {"value": "volume_Z", "label": "volume_Z"},
        {"value": "volume_albedo", "label": "volume_albedo"},
        {"value": "volume_direct", "label": "volume_direct"},
        {"value": "volume_indirect", "label": "volume_indirect"},
        {"value": "volume_opacity", "label": "volume_opacity"},
    ]

arnold_image_format_enum()

Return enumerator for Arnold output formats.

Source code in server/settings/render_settings.py 
13
14
15
16
17
18
19
20
21
22
23
def arnold_image_format_enum():
    """Return enumerator for Arnold output formats."""
    return [
        {"label": "jpeg", "value": "jpeg"},
        {"label": "png", "value": "png"},
        {"label": "deepexr", "value": "deep exr"},
        {"label": "tif", "value": "tif"},
        {"label": "exr", "value": "exr"},
        {"label": "maya", "value": "maya"},
        {"label": "mtoa_shaders", "value": "mtoa_shaders"}
    ]

redshift_aov_list_enum()

Return enumerator for Redshift AOVs.

*Tested in Redshift 3.6.03

Source code in server/settings/render_settings.py 
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
def redshift_aov_list_enum():
    """Return enumerator for Redshift AOVs.

    *Tested in Redshift 3.6.03
    """
    return [
        {"value": "Ambient Occlusion", "label": "Ambient Occlusion"},
        {"value": "Background", "label": "Background"},
        {"value": "Beauty", "label": "Beauty"},
        {"value": "Bump Normals", "label": "Bump Normals"},
        {"value": "Caustics", "label": "Caustics"},
        {"value": "Caustics Raw", "label": "Caustics Raw"},
        {"value": "Cryptomatte", "label": "Cryptomatte"},
        {"value": "Custom", "label": "Custom"},
        {"value": "Depth", "label": "Depth"},
        {"value": "Diffuse Filter", "label": "Diffuse Filter"},
        {"value": "Diffuse Lighting", "label": "Diffuse Lighting"},
        {"value": "Diffuse Lighting Raw", "label": "Diffuse Lighting Raw"},
        {"value": "Emission", "label": "Emission"},
        {"value": "Global Illumination", "label": "Global Illumination"},
        {"value": "Global Illumination Raw",
         "label": "Global Illumination Raw"},
        {"value": "Matte", "label": "Matte"},
        {"value": "Motion Vectors", "label": "Motion Vectors"},
        {"value": "Normals", "label": "Normals"},
        {"value": "ObjectID", "label": "ObjectID"},
        {"value": "Object-Space Bump Normals",
         "label": "Object-Space Bump Normals"},
        {"value": "Object-Space Positions",
         "label": "Object-Space Positions"},
        {"value": "Puzzle Matte", "label": "Puzzle Matte"},
        {"value": "Reflections", "label": "Reflections"},
        {"value": "Reflections Filter", "label": "Reflections Filter"},
        {"value": "Reflections Raw", "label": "Reflections Raw"},
        {"value": "Refractions", "label": "Refractions"},
        {"value": "Refractions Filter", "label": "Refractions Filter"},
        {"value": "Refractions Raw", "label": "Refractions Raw"},
        {"value": "Shadows", "label": "Shadows"},
        {"value": "Specular Lighting", "label": "Specular Lighting"},
        {"value": "Sub Surface Scatter", "label": "Sub Surface Scatter"},
        {"value": "Sub Surface Scatter Raw",
         "label": "Sub Surface Scatter Raw"},
        {"value": "Total Diffuse Lighting Raw",
         "label": "Total Diffuse Lighting Raw"},
        {"value": "Total Translucency Lighting Raw",
         "label": "Total Translucency Lighting Raw"},
        {"value": "Translucency Filter", "label": "Translucency Filter"},
        {"value": "Translucency Lighting Raw",
         "label": "Translucency Lighting Raw"},
        {"value": "Volume Fog Emission", "label": "Volume Fog Emission"},
        {"value": "Volume Fog Tint", "label": "Volume Fog Tint"},
        {"value": "Volume Lighting", "label": "Volume Lighting"},
        {"value": "World Position", "label": "World Position"},
    ]

redshift_image_output_enum()

Return output format for Redshift enumerator.

Source code in server/settings/render_settings.py 
214
215
216
217
218
219
220
221
222
223
def redshift_image_output_enum():
    """Return output format for Redshift enumerator."""
    return [
        {"value": "iff", "label": "Maya IFF"},
        {"value": "exr", "label": "OpenEXR"},
        {"value": "tif", "label": "TIFF"},
        {"value": "png", "label": "PNG"},
        {"value": "tga", "label": "Targa"},
        {"value": "jpg", "label": "JPEG"}
    ]

redshift_primary_gi_engine_enum()

Get Redshift engine type enumerator.

Source code in server/settings/render_settings.py 
196
197
198
199
200
201
202
def redshift_primary_gi_engine_enum():
    """Get Redshift engine type enumerator."""
    return [
        {"value": "0", "label": "None"},
        {"value": "3", "label": "Irradiance Cache"},
        {"value": "4", "label": "Brute Force"}
    ]

redshift_secondary_gi_engine_enum()

Get Redshift engine type enumerator.

Source code in server/settings/render_settings.py 
205
206
207
208
209
210
211
def redshift_secondary_gi_engine_enum():
    """Get Redshift engine type enumerator."""
    return [
        {"value": "0", "label": "None"},
        {"value": "2", "label": "Irradiance Point Cloud"},
        {"value": "4", "label": "Brute Force"}
    ]

vray_aov_list_enum()

Return enumerator for Vray AOVs.

Key is value, Value in this case is Label. This

was taken from v3 settings.

Source code in server/settings/render_settings.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def vray_aov_list_enum():
    """Return enumerator for Vray AOVs.

    Note: Key is value, Value in this case is Label. This
        was taken from v3 settings.
    """

    return [
        {"value": "empty", "label": "< empty >"},
        {"value": "atmosphereChannel", "label": "atmosphere"},
        {"value": "backgroundChannel", "label": "background"},
        {"value": "bumpNormalsChannel", "label": "bumpnormals"},
        {"value": "causticsChannel", "label": "caustics"},
        {"value": "coatFilterChannel", "label": "coat_filter"},
        {"value": "coatGlossinessChannel", "label": "coatGloss"},
        {"value": "coatReflectionChannel", "label": "coat_reflection"},
        {"value": "vrayCoatChannel", "label": "coat_specular"},
        {"value": "CoverageChannel", "label": "coverage"},
        {"value": "cryptomatteChannel", "label": "cryptomatte"},
        {"value": "customColor", "label": "custom_color"},
        {"value": "drBucketChannel", "label": "DR"},
        {"value": "denoiserChannel", "label": "denoiser"},
        {"value": "diffuseChannel", "label": "diffuse"},
        {"value": "ExtraTexElement", "label": "extraTex"},
        {"value": "giChannel", "label": "GI"},
        {"value": "LightMixElement", "label": "None"},
        {"value": "lightingChannel", "label": "lighting"},
        {"value": "LightingAnalysisChannel", "label": "LightingAnalysis"},
        {"value": "materialIDChannel", "label": "materialID"},
        {"value": "MaterialSelectElement", "label": "materialSelect"},
        {"value": "matteShadowChannel", "label": "matteShadow"},
        {"value": "MultiMatteElement", "label": "multimatte"},
        {"value": "multimatteIDChannel", "label": "multimatteID"},
        {"value": "normalsChannel", "label": "normals"},
        {"value": "nodeIDChannel", "label": "objectId"},
        {"value": "objectSelectChannel", "label": "objectSelect"},
        {"value": "rawCoatFilterChannel", "label": "raw_coat_filter"},
        {"value": "rawCoatReflectionChannel", "label": "raw_coat_reflection"},
        {"value": "rawDiffuseFilterChannel", "label": "rawDiffuseFilter"},
        {"value": "rawGiChannel", "label": "rawGI"},
        {"value": "rawLightChannel", "label": "rawLight"},
        {"value": "rawReflectionChannel", "label": "rawReflection"},
        {
            "value": "rawReflectionFilterChannel",
            "label": "rawReflectionFilter"
        },
        {"value": "rawRefractionChannel", "label": "rawRefraction"},
        {
            "value": "rawRefractionFilterChannel",
            "label": "rawRefractionFilter"
        },
        {"value": "rawShadowChannel", "label": "rawShadow"},
        {"value": "rawSheenFilterChannel", "label": "raw_sheen_filter"},
        {
            "value": "rawSheenReflectionChannel",
            "label": "raw_sheen_reflection"
        },
        {"value": "rawTotalLightChannel", "label": "rawTotalLight"},
        {"value": "reflectIORChannel", "label": "reflIOR"},
        {"value": "reflectChannel", "label": "reflect"},
        {"value": "reflectionFilterChannel", "label": "reflectionFilter"},
        {"value": "reflectGlossinessChannel", "label": "reflGloss"},
        {"value": "refractChannel", "label": "refract"},
        {"value": "refractionFilterChannel", "label": "refractionFilter"},
        {"value": "refractGlossinessChannel", "label": "refrGloss"},
        {"value": "renderIDChannel", "label": "renderId"},
        {"value": "FastSSS2Channel", "label": "SSS"},
        {"value": "sampleRateChannel", "label": "sampleRate"},
        {"value": "samplerInfo", "label": "samplerInfo"},
        {"value": "selfIllumChannel", "label": "selfIllum"},
        {"value": "shadowChannel", "label": "shadow"},
        {"value": "sheenFilterChannel", "label": "sheen_filter"},
        {"value": "sheenGlossinessChannel", "label": "sheenGloss"},
        {"value": "sheenReflectionChannel", "label": "sheen_reflection"},
        {"value": "vraySheenChannel", "label": "sheen_specular"},
        {"value": "specularChannel", "label": "specular"},
        {"value": "Toon", "label": "Toon"},
        {"value": "toonLightingChannel", "label": "toonLighting"},
        {"value": "toonSpecularChannel", "label": "toonSpecular"},
        {"value": "totalLightChannel", "label": "totalLight"},
        {"value": "unclampedColorChannel", "label": "unclampedColor"},
        {"value": "VRScansPaintMaskChannel", "label": "VRScansPaintMask"},
        {"value": "VRScansZoneMaskChannel", "label": "VRScansZoneMask"},
        {"value": "velocityChannel", "label": "velocity"},
        {"value": "zdepthChannel", "label": "zDepth"},
        {"value": "LightSelectElement", "label": "lightselect"},
    ]

vray_image_output_enum()

Return output format for Vray enumerator.

Source code in server/settings/render_settings.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def vray_image_output_enum():
    """Return output format for Vray enumerator."""
    return [
        {"label": "png", "value": "png"},
        {"label": "jpg", "value": "jpg"},
        {"label": "vrimg", "value": "vrimg"},
        {"label": "hdr", "value": "hdr"},
        {"label": "exr", "value": "exr"},
        {"label": "exr (multichannel)", "value": "exr (multichannel)"},
        {"label": "exr (deep)", "value": "exr (deep)"},
        {"label": "tga", "value": "tga"},
        {"label": "bmp", "value": "bmp"},
        {"label": "sgi", "value": "sgi"}
    ]