Material¶

The Material class defines how a 3D surface is rendered, extending the Item base class. It provides options for culling, shading workflows, texture wrapping and filtering, anisotropy, normal mapping, and blending. Materials are applied to objects in a scene to control their appearance, from solid opaque surfaces to transparent or stylized effects.

Inherits from¶

Item

Usage¶

To use this class, add the following require at the top of your script:

local Material = require 'engine/items/material'

Reference¶

class Material¶

module:

static create(attributes)¶

Create a new material instance.

This function initializes a new Material object with specified attributes. The attributes can include colors, textures, shader links, floats, enums, and other material properties. All attributes are optional and override engine defaults.

Parameters:: attributes (table) – Optional table of material attributes to override defaults.
Returns:: Promise of the newly created material instance.
Return type:: Material

Usage:

local customMaterial = Material:create({
    DiffuseColor = { r=200, g=100, b=50, a=255 },
    RoughnessIntensity = 0.8,
   MaterialType = Material.MaterialType.Toon
})

getWorkflow()¶

Retrieves the workflow value for the material.

Returns:: The current workflow value of the material. Expected to be a value from Material.Workflow.
Return type:: str

setWorkflow(workflow)¶

Sets the workflow for the material.

Parameters:: workflow (str) – The desired workflow value. Expected to be a value from Material.Workflow.

getAttenuationColor()¶

Retrieves the attenuation color for the material.

Returns:: A table representing the RGB color values, or any suitable color representation of the attenuation color.
Return type:: Color

setAttenuationColor(color)¶

Sets the attenuation color for the material.

Parameters:: color (Color) – A table representing the RGB color values, or any suitable color representation.

getAttenuationDistance()¶

Retrieves the attenuation distance for the material.

Returns:: A number representing the attenuation distance.
Return type:: number

setAttenuationDistance(distance)¶

Sets the attenuation distance for the material.

Parameters:: distance (number) – A number representing the attenuation distance.

getDiffuseColor()¶

Retrieves the diffuse color for the material.

Returns:: The diffuse color
Return type:: Color

setDiffuseColor(color)¶

Sets the diffuse color for the material.

Parameters:: color (Color) – The diffuse color to set

getAlbedoMap()¶

Get the albedo texture or video or nil if none is linked

Returns:: or Video or nil
Return type:: Texture

setAlbedoMap(linkItem)¶

Set the albedo texture or video

Parameters:: linkItem (texture) – or video to use

getAlbedoWrapS()¶

Gets the wrap mode along the s-axis (usually horizontal) for the albedo map.

Return type:: WrapMode

setAlbedoWrapS(WrapMode)¶

Sets the wrap mode along the s-axis (usually horizontal) for the albedo map.

Parameters:: WrapMode (str) – The wrap mode..

getAlbedoWrapT()¶

Sets the wrap mode along the t-axis (usually vertical) for the albedo map.

Return type:: WrapMode

setAlbedoWrapT(WrapMode)¶

Sets the wrap mode along the t-axis (usually vertical) for the albedo map.

Parameters:: WrapMode (str) – The wrap mode..

getAlbedoMagFilter()¶

Gets the magnification filter for the albedo map.

Returns:: The magnification filter.
Return type:: MagFilter

setAlbedoMagFilter(filter)¶

Sets the magnification filter for the albedo map.

Parameters:: filter (MagFilter) – The magnification filter.

getAlbedoMinFilter()¶

Gets the minification filter for the albedo map.

Returns:: The minification filter..
Return type:: MinFilter

setAlbedoMinFilter(filter)¶

Sets the minification filter for the albedo map.

Parameters:: filter (MinFilter) – The minification filter..

getAlbedoAnisotropy()¶

Gets the anisotropy level for the albedo map.

Returns:: The anisotropy level..
Return type:: Anisotropy

setAlbedoAnisotropy(Anisotropy)¶

Sets the anisotropy level for the albedo map.

Parameters:: Anisotropy (Anisotropy) – The anisotropy level..

getAlphaTest()¶

Get the alpha test value of the material.

Returns:: The alpha test value.
Return type:: number

setAlphaTest(amount)¶

Set the alpha test value of the material.

Parameters:: amount (number) – The alpha test value.

getTransparent()¶

Check if the material is transparent.

Returns:: True if transparent, false otherwise.
Return type:: boolean

setTransparent(enabled)¶

Set the transparency of the material.

Parameters:: enabled (boolean) – True if transparent, false otherwise.

getOpacity()¶

Get the opacity of the material.

Returns:: The opacity value.
Return type:: number

setOpacity(amount)¶

Set the opacity of the material.

Parameters:: amount (number) – The opacity value.

getAlphaMap()¶

Get the alpha map of the material.

Returns:: The alpha map texture.
Return type:: Texture

setAlphaMap(texture)¶

Set the alpha map of the material.

Parameters:: texture (Texture) – The alpha map texture.

getAlphaWrapS()¶

Get the alpha wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setAlphaWrapS(mode)¶

Set the alpha wrap S mode of the material.

Parameters:: mode (WrapMode) – The wrap mode.

getAlphaWrapT()¶

Get the alpha wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setAlphaWrapT(mode)¶

Set the alpha wrap T mode of the material.

Parameters:: mode (WrapMode) – The wrap mode.

getAlphaMagFilter()¶

Get the alpha magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setAlphaMagFilter(filter)¶

Set the alpha magnification filter of the material.

Parameters:: filter (MagFilter) – The magnification filter mode.

getAlphaMinFilter()¶

Get the alpha minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setAlphaMinFilter(filter)¶

Set the alpha minification filter of the material.

Parameters:: filter (MinFilter) – The minification filter mode.

getAlphaAnisotropy()¶

Get the alpha anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setAlphaAnisotropy(Anisotropy)¶

Set the alpha anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getEmissiveColor()¶

Get the emissive color of the material.

Returns:: The emissive color.
Return type:: Color

setEmissiveColor(color)¶

Set the emissive color of the material.

Parameters:: color (Color) – The emissive color. Default is black.

getEmissiveMap()¶

Get the emissive texture or nil if none is linked.

Returns:: Linked texture or nil.
Return type:: Texture

setEmissiveMap(texture)¶

Set the emissive texture.

Parameters:: texture (Texture) – Texture to use or nil.

getEmissiveWrapS()¶

Get the emissive wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setEmissiveWrapS(WrapMode)¶

Set the emissive wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getEmissiveWrapT()¶

Get the emissive wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setEmissiveWrapT(WrapMode)¶

Set the emissive wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getEmissiveMagFilter()¶

Get the emissive magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setEmissiveMagFilter(MagFilter)¶

Set the emissive magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getEmissiveMinFilter()¶

Get the emissive minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setEmissiveMinFilter(MinFilter)¶

Set the emissive minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getEmissiveAnisotropy()¶

Get the emissive anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setEmissiveAnisotropy(Anisotropy)¶

Set the emissive anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getSheenAmount()¶

Get the sheen amount of the material.

Returns:: The sheen value.
Return type:: number

setSheenAmount(amount)¶

Set the sheen amount of the material.

Parameters:: amount (number) – The sheen value.

getSheenRoughness()¶

Get the sheen roughness value of the material.

Returns:: The sheen roughness value.
Return type:: number

setSheenRoughness(amount)¶

Set the sheen roughness value of the material.

Parameters:: amount (number) – The sheen roughness value.

getSheenRoughnessMap()¶

Get the sheen roughness map of the material.

Returns:: The sheen roughness texture.
Return type:: Texture

setSheenRoughnessMap(texture)¶

Set the sheen roughness map of the material.

Parameters:: texture (Texture) – Texture to use or nil.

getSheenRoughnessWrapS()¶

Get the sheen roughness wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setSheenRoughnessWrapS(WrapMode)¶

Set the sheen roughness wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getSheenRoughnessWrapT()¶

Get the sheen roughness wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setSheenRoughnessWrapT(WrapMode)¶

Set the sheen roughness wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getSheenRoughnessMagFilter()¶

Get the sheen roughness magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setSheenRoughnessMagFilter(MagFilter)¶

Set the sheen roughness magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getSheenRoughnessMinFilter()¶

Get the sheen roughness minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setSheenRoughnessMinFilter(MinFilter)¶

Set the sheen roughness minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getSheenRoughnessAnisotropy()¶

Get the sheen roughness anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setSheenRoughnessAnisotropy(Anisotropy)¶

Set the sheen roughness anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getSheenColor()¶

Get the sheen color of the material.

Returns:: The sheen color.
Return type:: Color

setSheenColor(color)¶

Set the sheen color of the material.

Parameters:: color (Color) – The sheen color.

getSheenColorMap()¶

Get the sheen color map of the material.

Returns:: The sheen color texture.
Return type:: Texture

setSheenColorMap(texture)¶

Set the sheen color map of the material.

Parameters:: texture (Texture) – Texture to use or nil.

getSheenColorWrapS()¶

Get the sheen color wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setSheenColorWrapS(WrapMode)¶

Set the sheen color wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getSheenColorWrapT()¶

Get the sheen color wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setSheenColorWrapT(WrapMode)¶

Set the sheen color wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getSheenColorMagFilter()¶

Get the sheen color magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setSheenColorMagFilter(MagFilter)¶

Set the sheen color magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getSheenColorMinFilter()¶

Get the sheen color minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setSheenColorMinFilter(MinFilter)¶

Set the sheen color minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getSheenColorAnisotropy()¶

Get the sheen color anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setSheenColorAnisotropy(Anisotropy)¶

Set the sheen color anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getNormalMap()¶

Get the normal map texture of the material.

Returns:: The normal map texture.
Return type:: Texture

setNormalMap(texture)¶

Set the normal map texture of the material.

Parameters:: texture (Texture) – The texture to use or nil.

getNormalScale()¶

Get the normal scale value of the material.

Returns:: The normal scale value.
Return type:: number

setNormalScale(scale)¶

Set the normal scale value of the material.

Parameters:: scale (number) – The normal scale value.

getNormalType()¶

Get the normal type of the material.

Returns:: The normal type.
Return type:: NormalType

setNormalType(type)¶

Set the normal type of the material.

Parameters:: type (NormalType) – The normal type.

getNormalWrapS()¶

Get the normal wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setNormalWrapS(WrapMode)¶

Set the normal wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getNormalWrapT()¶

Get the normal wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setNormalWrapT(WrapMode)¶

Set the normal wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getNormalMagFilter()¶

Get the normal magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setNormalMagFilter(MagFilter)¶

Set the normal magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getNormalMinFilter()¶

Get the normal minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setNormalMinFilter(MinFilter)¶

Set the normal minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getNormalAnisotropy()¶

Get the normal anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setNormalAnisotropy(Anisotropy)¶

Set the normal anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getRoughnessIntensity()¶

Get the roughness intensity value of the material.

Returns:: The roughness intensity value.
Return type:: number

setRoughnessIntensity(amount)¶

Set the roughness intensity value of the material.

Parameters:: amount (number) – The roughness intensity value.

getRoughnessMap()¶

Get the roughness map texture of the material.

Returns:: The roughness map texture.
Return type:: Texture

setRoughnessMap(texture)¶

Set the roughness map texture of the material.

Parameters:: texture (Texture) – The texture to use or nil.

getRoughnessWrapS()¶

Get the roughness wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setRoughnessWrapS(WrapMode)¶

Set the roughness wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getRoughnessWrapT()¶

Get the roughness wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setRoughnessWrapT(WrapMode)¶

Set the roughness wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getRoughnessMagFilter()¶

Get the roughness magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setRoughnessMagFilter(MagFilter)¶

Set the roughness magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getRoughnessMinFilter()¶

Get the roughness minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setRoughnessMinFilter(MinFilter)¶

Set the roughness minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getRoughnessAnisotropy()¶

Get the roughness anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setRoughnessAnisotropy(Anisotropy)¶

Set the roughness anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getMetalnessIntensity()¶

Get the metalness intensity value of the material.

Returns:: The metalness intensity value.
Return type:: number

setMetalnessIntensity(amount)¶

Set the metalness intensity value of the material.

Parameters:: amount (number) – The metalness intensity value.

getMetalnessMap()¶

Get the metalness map texture of the material.

Returns:: The metalness map texture.
Return type:: Texture

setMetalnessMap(texture)¶

Set the metalness map texture of the material.

Parameters:: texture (Texture) – The texture to use or nil.

getMetalnessWrapS()¶

Get the metalness wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setMetalnessWrapS(WrapMode)¶

Set the metalness wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getMetalnessWrapT()¶

Get the metalness wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setMetalnessWrapT(WrapMode)¶

Set the metalness wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getMetalnessMagFilter()¶

Get the metalness magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setMetalnessMagFilter(MagFilter)¶

Set the metalness magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getMetalnessMinFilter()¶

Get the metalness minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setMetalnessMinFilter(MinFilter)¶

Set the metalness minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getMetalnessAnisotropy()¶

Get the metalness anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setMetalnessAnisotropy(Anisotropy)¶

Set the metalness anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getSpecularIntensity()¶

Get the specular intensity value of the material.

Returns:: The specular intensity value.
Return type:: number

setSpecularIntensity(amount)¶

Set the specular intensity value of the material.

Parameters:: amount (number) – The specular intensity value.

getSpecularIntensityMap()¶

Get the specular intensity map texture of the material.

Returns:: The specular intensity map texture.
Return type:: Texture

setSpecularIntensityMap(texture)¶

Set the specular intensity map texture of the material.

Parameters:: texture (Texture) – The texture to use or nil.

getSpecularIntensityWrapS()¶

Get the specular intensity wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setSpecularIntensityWrapS(WrapMode)¶

Set the specular intensity wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getSpecularIntensityWrapT()¶

Get the specular intensity wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setSpecularIntensityWrapT(WrapMode)¶

Set the specular intensity wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getSpecularIntensityMagFilter()¶

Get the specular intensity magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setSpecularIntensityMagFilter(MagFilter)¶

Set the specular intensity magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getSpecularIntensityMinFilter()¶

Get the specular intensity minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setSpecularIntensityMinFilter(MinFilter)¶

Set the specular intensity minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getSpecularIntensityAnisotropy()¶

Get the specular intensity anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setSpecularIntensityAnisotropy(Anisotropy)¶

Set the specular intensity anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getSpecularColor()¶

Get the specular color of the material.

Returns:: The specular color value.
Return type:: str

setSpecularColor(color)¶

Set the specular color of the material.

Parameters:: color (str) – The specular color value.

getSpecularColorMap()¶

Get the specular color map texture of the material.

Returns:: The specular color map texture.
Return type:: Texture

setSpecularColorMap(texture)¶

Set the specular color map texture of the material.

Parameters:: texture (Texture) – The texture to use or nil.

getSpecularColorWrapS()¶

Get the specular color wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setSpecularColorWrapS(WrapMode)¶

Set the specular color wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getSpecularColorWrapT()¶

Get the specular color wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setSpecularColorWrapT(WrapMode)¶

Set the specular color wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getSpecularColorMagFilter()¶

Get the specular color magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setSpecularColorMagFilter(MagFilter)¶

Set the specular color magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getSpecularColorMinFilter()¶

Get the specular color minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setSpecularColorMinFilter(MinFilter)¶

Set the specular color minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getSpecularColorAnisotropy()¶

Get the specular color anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setSpecularColorAnisotropy(Anisotropy)¶

Set the specular color anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getAmbientOcclusionMap()¶

Get the ambient occlusion map texture of the material.

Returns:: The ambient occlusion map texture.
Return type:: Texture

setAmbientOcclusionMap(texture)¶

Set the ambient occlusion map texture of the material.

Parameters:: texture (Texture) – The texture to use or nil.

getAmbientOcclusionIntensity()¶

Get the ambient occlusion intensity of the material.

Returns:: The ambient occlusion intensity value.
Return type:: str

setAmbientOcclusionIntensity(amount)¶

Set the ambient occlusion intensity of the material.

Parameters:: amount (str) – The ambient occlusion intensity value.

getAmbientOcclusionWrapS()¶

Get the ambient occlusion wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setAmbientOcclusionWrapS(WrapMode)¶

Set the ambient occlusion wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getAmbientOcclusionWrapT()¶

Get the ambient occlusion wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setAmbientOcclusionWrapT(WrapMode)¶

Set the ambient occlusion wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getAmbientOcclusionMagFilter()¶

Get the ambient occlusion magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setAmbientOcclusionMagFilter(MagFilter)¶

Set the ambient occlusion magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getAmbientOcclusionMinFilter()¶

Get the ambient occlusion minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setAmbientOcclusionMinFilter(MinFilter)¶

Set the ambient occlusion minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getAmbientOcclusionAnisotropy()¶

Get the ambient occlusion anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setAmbientOcclusionAnisotropy(Anisotropy)¶

Set the ambient occlusion anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getClearcoatLevel()¶

Get the clearcoat level of the material.

Returns:: The clearcoat level value.
Return type:: str

setClearcoatLevel(amount)¶

Set the clearcoat level of the material.

Parameters:: amount (str) – The clearcoat level value.

getClearcoatMap()¶

Get the clearcoat map texture of the material.

Returns:: The clearcoat map texture.
Return type:: Texture

setClearcoatMap(texture)¶

Set the clearcoat map texture of the material.

Parameters:: texture (Texture) – The texture to use or nil.

getClearcoatWrapS()¶

Get the clearcoat wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setClearcoatWrapS(WrapMode)¶

Set the clearcoat wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getClearcoatWrapT()¶

Get the clearcoat wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setClearcoatWrapT(WrapMode)¶

Set the clearcoat wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getClearcoatMagFilter()¶

Get the clearcoat magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setClearcoatMagFilter(MagFilter)¶

Set the clearcoat magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getClearcoatMinFilter()¶

Get the clearcoat minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setClearcoatMinFilter(MinFilter)¶

Set the clearcoat minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getClearcoatAnisotropy()¶

Get the clearcoat anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setClearcoatAnisotropy(Anisotropy)¶

Set the clearcoat anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getClearcoatNormalMap()¶

Get the clearcoat normal map texture of the material.

Returns:: The clearcoat normal map texture.
Return type:: Texture

setClearcoatNormalMap(texture)¶

Set the clearcoat normal map texture of the material.

Parameters:: texture (Texture) – The texture to use or nil.

getClearcoatNormalScale()¶

Get the clearcoat normal scale of the material.

Returns:: The clearcoat normal scale value.
Return type:: number

setClearcoatNormalScale(scale)¶

Set the clearcoat normal scale of the material.

Parameters:: scale (number) – The clearcoat normal scale value.

getClearcoatNormalWrapS()¶

Get the clearcoat normal wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setClearcoatNormalWrapS(WrapMode)¶

Set the clearcoat normal wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getClearcoatNormalWrapT()¶

Get the clearcoat normal wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setClearcoatNormalWrapT(WrapMode)¶

Set the clearcoat normal wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getClearcoatNormalMagFilter()¶

Get the clearcoat normal magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setClearcoatNormalMagFilter(MagFilter)¶

Set the clearcoat normal magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getClearcoatNormalMinFilter()¶

Get the clearcoat normal minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setClearcoatNormalMinFilter(MinFilter)¶

Set the clearcoat normal minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getClearcoatNormalAnisotropy()¶

Get the clearcoat normal anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setClearcoatNormalAnisotropy(Anisotropy)¶

Set the clearcoat normal anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getClearcoatRoughnessMap()¶

Get the clearcoat roughness map texture of the material.

Returns:: The clearcoat roughness map texture.
Return type:: Texture

setClearcoatRoughnessMap(texture)¶

Set the clearcoat roughness map texture of the material.

Parameters:: texture (Texture) – The texture to use or nil.

getClearcoatRoughnessIntensity()¶

Get the clearcoat roughness intensity of the material.

Returns:: The clearcoat roughness intensity value.
Return type:: number

setClearcoatRoughnessIntensity(amount)¶

Set the clearcoat roughness intensity of the material.

Parameters:: amount (number) – The clearcoat roughness intensity value.

getClearcoatRoughnessWrapS()¶

Get the clearcoat roughness wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setClearcoatRoughnessWrapS(WrapMode)¶

Set the clearcoat roughness wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getClearcoatRoughnessWrapT()¶

Get the clearcoat roughness wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setClearcoatRoughnessWrapT(WrapMode)¶

Set the clearcoat roughness wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getClearcoatRoughnessMagFilter()¶

Get the clearcoat roughness magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setClearcoatRoughnessMagFilter(MagFilter)¶

Set the clearcoat roughness magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getClearcoatRoughnessMinFilter()¶

Get the clearcoat roughness minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setClearcoatRoughnessMinFilter(MinFilter)¶

Set the clearcoat roughness minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getClearcoatRoughnessAnisotropy()¶

Get the clearcoat roughness anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setClearcoatRoughnessAnisotropy(Anisotropy)¶

Set the clearcoat roughness anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getReflectivity()¶

Get the reflectivity of the material.

Returns:: The reflectivity value.
Return type:: number

setReflectivity(value)¶

Set the reflectivity of the material.

Parameters:: value (number) – The reflectivity value.

getIndexOfRefraction()¶

Get the index of refraction of the material.

Returns:: The index of refraction value.
Return type:: number

setIndexOfRefraction(value)¶

Set the index of refraction of the material.

Parameters:: value (number) – The index of refraction value.

getEnvironmentMap()¶

Get the environment map texture of the material.

Returns:: The environment map texture.
Return type:: Texture

setEnvironmentMap(texture)¶

Set the environment map texture of the material.

Parameters:: texture (Texture) – The texture to use or nil.

getEnvironmentIntensity()¶

Get the environment intensity of the material.

Returns:: The environment intensity value.
Return type:: number

setEnvironmentIntensity(amount)¶

Set the environment intensity of the material.

Parameters:: amount (number) – The environment intensity value.

getThickness()¶

Get the thickness value of the material.

Returns:: The thickness value.
Return type:: number

setThickness(amount)¶

Set the thickness value of the material.

Parameters:: amount (number) – The thickness value.

getThicknessMap()¶

Get the thickness map texture of the material.

Returns:: The thickness map texture.
Return type:: str

setThicknessMap(texture)¶

Set the thickness map texture of the material.

Parameters:: texture (str) – The texture to use as the thickness map.

getThicknessWrapS()¶

Get the wrap mode for the S axis of the thickness texture.

Returns:: The wrap mode for the S axis.
Return type:: str

setThicknessWrapS(mode)¶

Set the wrap mode for the S axis of the thickness texture.

Parameters:: mode (str) – The wrap mode for the S axis.

getThicknessWrapT()¶

Get the wrap mode for the T axis of the thickness texture.

Returns:: The wrap mode for the T axis.
Return type:: str

setThicknessWrapT(mode)¶

Set the wrap mode for the T axis of the thickness texture.

Parameters:: mode (str) – The wrap mode for the T axis.

getThicknessMagFilter()¶

Get the magnification filter for the thickness texture.

Returns:: The magnification filter.
Return type:: str

setThicknessMagFilter(filter)¶

Set the magnification filter for the thickness texture.

Parameters:: filter (str) – The magnification filter.

getThicknessMinFilter()¶

Get the minification filter for the thickness texture.

Returns:: The minification filter.
Return type:: str

setThicknessMinFilter(filter)¶

Set the minification filter for the thickness texture.

Parameters:: filter (str) – The minification filter.

getThicknessAnisotropy()¶

Get the anisotropy level for the thickness texture.

Returns:: The anisotropy level.
Return type:: str

setThicknessAnisotropy(Anisotropy)¶

Set the anisotropy level for the thickness texture.

Parameters:: Anisotropy (str) – The anisotropy level.

getDisplacementMap()¶

Get the displacement map texture of the material.

Returns:: The displacement map texture.
Return type:: str

setDisplacementMap(texture)¶

Set the displacement map texture of the material.

Parameters:: texture (str) – The texture to use as the displacement map.

getDisplacementScale()¶

Get the displacement scale of the material.

Returns:: The displacement scale.
Return type:: number

setDisplacementScale(amount)¶

Set the displacement scale of the material.

Parameters:: amount (number) – The displacement scale value.

getDisplacementBias()¶

Get the displacement bias of the material.

Returns:: The displacement bias.
Return type:: number

setDisplacementBias(amount)¶

Set the displacement bias of the material.

Parameters:: amount (number) – The displacement bias value.

getDisplacementWrapS()¶

Get the wrap mode for the S axis of the displacement texture.

Returns:: The wrap mode for the S axis.
Return type:: str

setDisplacementWrapS(mode)¶

Set the wrap mode for the S axis of the displacement texture.

Parameters:: mode (str) – The wrap mode for the S axis.

getDisplacementWrapT()¶

Get the wrap mode for the T axis of the displacement texture.

Returns:: The wrap mode for the T axis.
Return type:: str

setDisplacementWrapT(mode)¶

Set the wrap mode for the T axis of the displacement texture.

Parameters:: mode (str) – The wrap mode for the T axis.

getDisplacementMagFilter()¶

Get the magnification filter for the displacement texture.

Returns:: The magnification filter.
Return type:: str

setDisplacementMagFilter(filter)¶

Set the magnification filter for the displacement texture.

Parameters:: filter (str) – The magnification filter.

getDisplacementMinFilter()¶

Get the minification filter for the displacement texture.

Returns:: The minification filter.
Return type:: str

setDisplacementMinFilter(filter)¶

Set the minification filter for the displacement texture.

Parameters:: filter (str) – The minification filter.

getDisplacementAnisotropy()¶

Get the anisotropy level for the displacement texture.

Returns:: The anisotropy level.
Return type:: str

setDisplacementAnisotropy(Anisotropy)¶

Set the anisotropy level for the displacement texture.

Parameters:: Anisotropy (str) – The anisotropy level.

getTransmissionMap()¶

Get the transmission map texture of the material.

Returns:: The transmission map texture.
Return type:: str

setTransmissionMap(texture)¶

Set the transmission map texture of the material.

Parameters:: texture (str) – The texture to use as the transmission map.

getTransmission()¶

Get the transmission value of the material.

Returns:: The transmission value.
Return type:: number

setTransmission(amount)¶

Set the transmission value of the material.

Parameters:: amount (number) – The transmission value to set.

getTransmissionWrapS()¶

Get the wrap mode for the S axis of the transmission texture.

Returns:: The wrap mode for the S axis.
Return type:: str

setTransmissionWrapS(mode)¶

Set the wrap mode for the S axis of the transmission texture.

Parameters:: mode (str) – The wrap mode for the S axis.

getTransmissionWrapT()¶

Get the wrap mode for the T axis of the transmission texture.

Returns:: The wrap mode for the T axis.
Return type:: str

setTransmissionWrapT(mode)¶

Set the wrap mode for the T axis of the transmission texture.

Parameters:: mode (str) – The wrap mode for the T axis.

getTransmissionMagFilter()¶

Get the magnification filter for the transmission texture.

Returns:: The magnification filter.
Return type:: str

setTransmissionMagFilter(filter)¶

Set the magnification filter for the transmission texture.

Parameters:: filter (str) – The magnification filter.

getTransmissionMinFilter()¶

Get the minification filter for the transmission texture.

Returns:: The minification filter.
Return type:: str

setTransmissionMinFilter(filter)¶

Set the minification filter for the transmission texture.

Parameters:: filter (str) – The minification filter.

getTransmissionAnisotropy()¶

Get the anisotropy level for the transmission texture.

Returns:: The anisotropy level.
Return type:: str

setTransmissionAnisotropy(Anisotropy)¶

Set the anisotropy level for the transmission texture.

Parameters:: Anisotropy (str) – The anisotropy level.

getBlending()¶

Get the blending status of the material.

Returns:: True if blending is enabled, false otherwise.
Return type:: boolean

setBlending(enabled)¶

Enable or disable blending for the material.

Parameters:: enabled (boolean) – True to enable blending, false to disable.

getBlendSource()¶

Get the source factor for the blending equation.

Returns:: The source factor for the blending equation.
Return type:: BlendSource

setBlendSource(value)¶

Set the source factor for the blending equation.

Parameters:: value (BlendSource) – The source factor for the blending equation.

getBlendDest()¶

Get the destination factor for the blending equation.

Returns:: The destination factor for the blending equation.
Return type:: BlendDest

setBlendDest(value)¶

Set the destination factor for the blending equation.

Parameters:: value (BlendDest) – The destination factor for the blending equation.

getBlendEquation()¶

Get the equation to use for blending.

Returns:: The equation used for blending.
Return type:: str

setBlendEquation(value)¶

Set the equation to use for blending.

Parameters:: value (str) – The equation to use for blending.

getDepthTest()¶

Get the depth test status for the material.

Returns:: True if depth testing is enabled, false otherwise.
Return type:: boolean

setDepthTest(enabled)¶

Enable or disable depth testing for the material.

Parameters:: enabled (boolean) – True to enable depth testing, false to disable.

getDepthMode()¶

Get the depth mode for the material.

Returns:: The current depth mode of the material.
Return type:: str

setDepthMode(mode)¶

Set the depth mode for the material.

Parameters:: mode (str) – The desired depth mode for the material.

getCulling()¶

Get the culling mode for the material.

Returns:: The current culling mode of the material.
Return type:: str

setCulling(mode)¶

Set the culling mode for the material.

Parameters:: mode (str) – The desired culling mode for the material.

getPoints()¶

Check if the material is set to render as points.

Returns:: True if the material renders as points, false otherwise.
Return type:: boolean

setPoints(enabled)¶

Enable or disable rendering the material as points.

Parameters:: enabled (boolean) – True to render as points, false otherwise.

getPointSize()¶

Get the point size for the material when rendering as points.

Returns:: The point size used when rendering as points.
Return type:: number

setPointSize(size)¶

Set the point size for the material when rendering as points.

Parameters:: size (number) – The desired point size.

getPointSizeAttenuation()¶

Check if point size attenuation is enabled for the material.

Returns:: True if point size attenuation is enabled, false otherwise.
Return type:: boolean

setPointSizeAttenuation(enabled)¶

Enable or disable point size attenuation for the material.

Parameters:: enabled (boolean) – True to enable point size attenuation, false to disable.

getVertexColors()¶

Check if point vertex colors are enabled for the material.

Returns:: True if vertex colors are enabled, false otherwise.
Return type:: boolean

setVertexColors(enabled)¶

Enable or disable vertex colors for the material.

Parameters:: enabled (boolean) – True to enable vertex colors, false to disable.

getFlatShading()¶

Check if flat shading is enabled for the material.

Returns:: True if flat shading is enabled, false otherwise.
Return type:: boolean

setFlatShading(enabled)¶

Enable or disable flat shading for the material.

Parameters:: enabled (boolean) – True to enable flat shading, false to disable.

getWireframe()¶

Check if wireframe is enabled for the material.

Returns:: True if wireframe is enabled, false otherwise.
Return type:: boolean

setWireframe(enabled)¶

Enable or disable wireframe for the material.

Parameters:: enabled (boolean) – True to enable wireframe, false to disable.

getGradientMap()¶

Get the gradient map of the material.

Returns:: The gradient map texture.
Return type:: Texture

setGradientMap(texture)¶

Set the gradient map of the material.

Parameters:: texture (Texture) – The gradient map texture.

getGradientWrapS()¶

Get the gradient wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setGradientWrapS(WrapMode)¶

Set the gradient wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getGradientWrapT()¶

Get the gradient wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setGradientWrapT(WrapMode)¶

Set the gradient wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getGradientMagFilter()¶

Get the gradient magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setGradientMagFilter(MagFilter)¶

Set the gradient magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getGradientMinFilter()¶

Get the gradient minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setGradientMinFilter(MinFilter)¶

Set the gradient minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getGradientAnisotropy()¶

Get the gradient anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setGradientAnisotropy(Anisotropy)¶

Set the gradient anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getMatcapMap()¶

Get the matcap map of the material.

Returns:: The matcap map texture.
Return type:: Texture

setMatcapMap(texture)¶

Set the matcap map of the material.

Parameters:: texture (Texture) – The matcap map texture.

getMatcapWrapS()¶

Get the matcap wrap S mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setMatcapWrapS(WrapMode)¶

Set the matcap wrap S mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getMatcapWrapT()¶

Get the matcap wrap T mode of the material.

Returns:: The wrap mode.
Return type:: WrapMode

setMatcapWrapT(WrapMode)¶

Set the matcap wrap T mode of the material.

Parameters:: WrapMode (The) – wrap mode.

getMatcapMagFilter()¶

Get the matcap magnification filter of the material.

Returns:: The magnification filter mode.
Return type:: MagFilter

setMatcapMagFilter(MagFilter)¶

Set the matcap magnification filter of the material.

Parameters:: MagFilter (The) – magnification filter mode.

getMatcapMinFilter()¶

Get the matcap minification filter of the material.

Returns:: The minification filter mode.
Return type:: MinFilter

setMatcapMinFilter(MinFilter)¶

Set the matcap minification filter of the material.

Parameters:: MinFilter (The) – minification filter mode.

getMatcapAnisotropy()¶

Get the matcap anisotropy mode of the material.

Returns:: The anisotropy mode.
Return type:: Anisotropy

setMatcapAnisotropy(Anisotropy)¶

Set the matcap anisotropy mode of the material.

Parameters:: Anisotropy (str) – The anisotropy mode.

getShininess()¶

Get the shininess of a phong material.

Returns:: The shininess of the material.
Return type:: number

setShininess(shininess)¶

Set the shininess of a phong material.

Parameters:: shininess (number) – The desired shininess.

Core Enumerations¶

class MaterialType¶

Enumeration of available material types

Name	Description
Physical	Physically-Based Rendering material
Shader	Custom GLSL shader material
Point	Point/particle rendering material
Basic	Unlit material with basic properties
Normal	Normal visualization material
Toon	Cel/toon shading material
Matcap	Material capture shading material
Lambert	Basic diffuse shading material
Phong	Specular Phong shading material

Texture Enumerations¶

class TextureWrapping¶

Enumeration of texture wrapping modes

Name	Description
Repeat	Repeat texture beyond UV [0,1] range
ClampToEdge	Clamp texture coordinates to edge
MirroredRepeat	Repeat texture with mirroring

class MagFilter¶

Enumeration of texture magnification filter modes

Name	Description
Linear	Linear interpolation filtering
Nearest	Nearest neighbor filtering

class MinFilter¶

Enumeration of texture minification filter modes

Name	Description
Nearest	Nearest neighbor filtering
NearestMipmapNearest	Nearest neighbor with nearest mipmap
NearestMipmapLinear	Nearest neighbor with linear mipmap
Linear	Linear interpolation filtering
LinearMipmapNearest	Linear interpolation with nearest mipmap
LinearMipmapLinear	Linear interpolation with linear mipmap (trilinear)

class Anisotropy¶

Enumeration of anisotropic filtering levels

Name	Description
x1	1x anisotropy (disabled)
x2	2x anisotropic filtering
x4	4x anisotropic filtering
x8	8x anisotropic filtering
x16	16x anisotropic filtering

class WrapMode¶

Enumeration of available wrap modes.

Name	Description
Repeat	Texture coordinates repeat
ClampToEdge	Texture coordinates clamp to edge
MirroredRepeat	Texture coordinates mirror and then repeat

Rendering Enumerations¶

class BlendingMode¶

Enumeration of material blending modes

Name	Description
None	No blending (opaque)
Normal	Normal alpha blending
Additive	Additive blending
Subtractive	Subtractive blending
Multiply	Multiply blending
Custom	Custom blending equation

class BlendFactor¶

Enumeration of blend factor sources

Name	Description
Zero	Zero factor
One	One factor
SourceColor	Source color factor
OneMinusSourceColor	One minus source color factor
SourceAlpha	Source alpha factor
OneMinusSourceAlpha	One minus source alpha factor
DestinationAlpha	Destination alpha factor
OneMinusDestinationAlpha	One minus destination alpha factor
DestinationColor	Destination color factor
OneMinusDestinationColor	One minus destination color factor
SourceAlphaSaturate	Source alpha saturate factor (src only)

class BlendSource¶

Enumeration of available blend sources.

Name	Description
Zero	zero source
One	one source
SourceColor	source color
OneMinusSourceColor	one minus source color
SourceAlpha	source alpha
OneMinusSourceAlpha	one minus source alpha
DestinationAlpha	destination alpha
OneMinusDestinationAlpha	one minus destination alpha
DestinationColor	destination color
OneMinusDestinationColor	one minus destination color
SourceAlphaSaturate	source alpha saturate

class BlendDest¶: Enumeration of available blend destinations.

class BlendEquation¶

Enumeration of blend equations

Name	Description
Add	Add source and destination
Subtract	Subtract destination from source
ReverseSubtract	Subtract source from destination
Min	Minimum of source and destination
Max	Maximum of source and destination

class CullingMode¶

Enumeration of polygon culling modes

Name	Description
Front	Cull front-facing polygons
Back	Cull back-facing polygons
Off	No polygon culling

class DepthMode¶

Enumeration of depth test comparison modes

Name	Description
Never	Never pass depth test
Always	Always pass depth test
Less	Pass if depth is less
LessEqual	Pass if depth is less or equal
GreaterEqual	Pass if depth is greater or equal
Greater	Pass if depth is greater
NotEqual	Pass if depth is not equal

Material Property Enumerations¶

class NormalType¶

Enumeration of normal map coordinate spaces

Name	Description
TangentSpace	Tangent-space normal map
ObjectSpace	Object-space normal map

class SurfaceEnvironmentCombination¶

Enumeration of environment map combination modes

Name	Description
Multiply	Multiply surface color with environment
Mix	Mix between surface and environment using reflectivity
Add	Add environment to surface color

class TextureAttributeType¶

Enumeration of texture attribute types

Name	Description
Albedo	Albedo/diffuse texture
Normal	Normal map texture
Roughness	Roughness map texture
Metalness	Metalness map texture
Emissive	Emissive texture
AmbientOcclusion	Ambient occlusion texture
Alpha	Alpha mask texture
SpecularMap	Specular map texture
SpecularIntensityMap	Specular intensity map
SpecularColorMap	Specular color map
SheenRoughnessMap	Sheen roughness map
SheenColorMap	Sheen color map
Clearcoat	Clearcoat texture
ClearcoatNormalMap	Clearcoat normal map
ClearcoatRoughnessMap	Clearcoat roughness map
TransmissionMap	Transmission map
Environment	Environment map (HDR)
ThicknessMap	Thickness map
Displacement	Displacement map
LightMap	Light map texture
Matcap	Matcap texture
Gradient	Gradient ramp texture

Attribute Enumerations¶

These tables group related attribute names for programmatic access:

class SheenAttributes¶

Enumeration of sheen material property names

Name	Description
Sheen	Sheen intensity attribute name
SheenRoughness	Sheen roughness attribute name
SheenColor	Sheen color attribute name

class ClearcoatAttributes¶

Enumeration of clearcoat material property names

Name	Description
ClearcoatLevel	Clearcoat intensity attribute name
ClearcoatRoughness	Clearcoat roughness attribute name
ClearcoatNormalScale	Clearcoat normal scale attribute name

class TransmissionAttributes¶

Enumeration of transmission material property names

Name	Description
Transmission	Transmission intensity attribute name
IndexOfRefraction	Index of refraction attribute name

class SpecularAttributes¶

Enumeration of specular material property names

Name	Description
SpecularIntensity	Specular intensity attribute name
SpecularColor	Specular color attribute name
Shininess	Shininess attribute name (Phong only)
Reflectivity	Reflectivity attribute name

class EmissionAttributes¶

Enumeration of emissive material property names

Name	Description
EmissiveColor	Emission color attribute name
EmissiveIntensity	Emission intensity attribute name

class DisplacementAttributes¶

Enumeration of displacement mapping property names

Name	Description
DisplacementScale	Displacement scale attribute name
DisplacementBias	Displacement bias attribute name

class AmbientOcclusionAttributes¶

Enumeration of ambient occlusion property names

Name	Description
AmbientOcclusionIntensity	Ambient occlusion intensity attribute name

class LightmapAttributes¶

Enumeration of lightmap property names

Name	Description
LightMapIntensity	Lightmap intensity attribute name

class PointAttributes¶

Enumeration of point material property names

Name	Description
PointSize	Point size attribute name
PointSizeAttenuation	Point size attenuation attribute name

class ToonAttributes¶

Enumeration of toon shading property names

Name	Description
Gradient	Gradient ramp attribute name

class MatcapAttributes¶

Enumeration of matcap shading property names

Name	Description
Matcap	Matcap texture attribute name

class ShaderAttributes¶

Enumeration of custom shader property names

Name	Description
VertexShader	Vertex shader attribute name
PixelShader	Pixel shader attribute name

class BasicAttributes¶

Enumeration of basic material property names

Name	Description
EmissionColor	Emission color attribute name (Basic material)
RefractionRatio	Refraction ratio attribute name