Class MaterialElement

The MaterialElement interface provides properties and methods for manipulating <pc-material> elements. The MaterialElement interface also inherits the properties and methods of the HTMLElement interface.

A pc-material must be a direct child of pc-app — elements placed elsewhere log a warning and never create a material. Elements inserted while the application is already running are created on insertion.

The element is metal/rough by default: unlike a bare StandardMaterial it enables the metalness workflow, which is what the metalness-* attributes assume and what glTF means by PBR. It also defaults metalness to 0 rather than the engine's 1, because those two defaults have to be chosen together - the engine's 1 is unreachable under its own useMetalness of false, and with the workflow on it would make every material fully metallic, so <pc-material diffuse="crimson"> would render as dark tinted reflections of an environment that may not exist rather than as a crimson surface. metalness="1" remains one attribute away.

The roughness and roughness-map attributes are aliases for gloss and gloss-map that additionally invert the gloss channel; do not mix the two families on one element.

The two aliases are documented here rather than on an accessor, because they resolve to the gloss properties and would otherwise inherit gloss's description - which reads inverted.

Attribute

roughness - The roughness of the material, from 0 (shiny) to 1 (rough). An alias for gloss that also inverts it, so do not combine it with the gloss attributes.

Attribute

roughness-map - The id of the pc-asset to use as the roughness map. An alias for gloss-map that also inverts the gloss channel, so do not combine it with the gloss attributes.

Hierarchy

HTMLElement
- MaterialElement

Index

Accessors

alphaTest alphaToCoverage aoIntensity aoMap aoMapChannel aoMapOffset aoMapRotation aoMapTiling aoMapUv blendType bumpiness cull depthBias depthTest depthWrite diffuse diffuseMap diffuseMapChannel diffuseMapOffset diffuseMapRotation diffuseMapTiling diffuseMapUv emissive emissiveIntensity emissiveMap emissiveMapChannel emissiveMapOffset emissiveMapRotation emissiveMapTiling emissiveMapUv enableGGXSpecular fresnelModel gloss glossInvert glossMap glossMapChannel glossMapOffset glossMapRotation glossMapTiling glossMapUv heightMap heightMapChannel heightMapFactor heightMapOffset heightMapRotation heightMapTiling heightMapUv metalness metalnessMap metalnessMapChannel metalnessMapOffset metalnessMapRotation metalnessMapTiling metalnessMapUv normalMap normalMapOffset normalMapRotation normalMapTiling normalMapUv occludeDirect occludeSpecular opacity opacityDither opacityFadesSpecular opacityMap opacityMapChannel opacityMapOffset opacityMapRotation opacityMapTiling opacityMapUv roughness roughnessMap slopeDepthBias specular specularityFactor twoSidedLighting useFog useLighting useMetalness useMetalnessSpecularColor useSkybox useTonemap

Methods

setMap

Accessors

alphaTest

get alphaTest(): number
Gets the alpha test reference value.

Returns number
The alpha test reference value.
- Defined in src/material.ts:545
set alphaTest(value: number): void
Sets the alpha test reference value. Fragments with an opacity below this value are discarded.
Parameters
- value: number
  The alpha test reference value.
Returns void
- Defined in src/material.ts:533

alphaToCoverage

get alphaToCoverage(): boolean
Gets whether to use alpha to coverage.

Returns boolean
The alpha to coverage flag.
- Defined in src/material.ts:565
set alphaToCoverage(value: boolean): void
Sets whether to use alpha to coverage, which resolves transparency using multisampling.
Parameters
- value: boolean
  The alpha to coverage flag.
Returns void
- Defined in src/material.ts:553

aoIntensity

get aoIntensity(): number
Gets the strength of the ambient occlusion map.

Returns number
The ambient occlusion intensity.
- Defined in src/material.ts:585
set aoIntensity(value: number): void
Sets the strength of the ambient occlusion map, from 0 to 1.
Parameters
- value: number
  The ambient occlusion intensity.
Returns void
- Defined in src/material.ts:573

aoMap

get aoMap(): string
Gets the id of the pc-asset used as the ambient occlusion map.

Returns string
The asset id.
- Defined in src/material.ts:602
set aoMap(value: string): void
Sets the id of the pc-asset to use as the ambient occlusion map.
Parameters
- value: string
  The asset id.
Returns void
- Defined in src/material.ts:593

aoMapChannel

get aoMapChannel(): ScalarChannel
Gets the color channel of the ambient occlusion map to sample.

Returns ScalarChannel
The channel.
- Defined in src/material.ts:622
set aoMapChannel(value: ScalarChannel): void
Sets the color channel of the ambient occlusion map to sample.
Parameters
- value: ScalarChannel
  The channel.
Returns void
- Defined in src/material.ts:610

aoMapOffset

get aoMapOffset(): Vec2
Gets the 2D offset of the ambient occlusion map.

Returns Vec2
The offset.
- Defined in src/material.ts:642
set aoMapOffset(value: Vec2): void
Sets the 2D offset of the ambient occlusion map.
Parameters
- value: Vec2
  The offset.
Returns void
- Defined in src/material.ts:630

aoMapRotation

get aoMapRotation(): number
Gets the 2D rotation of the ambient occlusion map.

Returns number
The rotation.
- Defined in src/material.ts:662
set aoMapRotation(value: number): void
Sets the 2D rotation of the ambient occlusion map, in degrees.
Parameters
- value: number
  The rotation.
Returns void
- Defined in src/material.ts:650

aoMapTiling

get aoMapTiling(): Vec2
Gets the 2D tiling of the ambient occlusion map.

Returns Vec2
The tiling.
- Defined in src/material.ts:682
set aoMapTiling(value: Vec2): void
Sets the 2D tiling of the ambient occlusion map.
Parameters
- value: Vec2
  The tiling.
Returns void
- Defined in src/material.ts:670

aoMapUv

get aoMapUv(): number
Gets the UV channel the ambient occlusion map samples.

Returns number
The UV channel.
- Defined in src/material.ts:702
set aoMapUv(value: number): void
Sets the UV channel the ambient occlusion map samples.
Parameters
- value: number
  The UV channel.
Returns void
- Defined in src/material.ts:690

blendType

get blendType(): BlendType
Gets how the material is blended with the scene behind it.

Returns BlendType
The blend type.
- Defined in src/material.ts:722
set blendType(value: BlendType): void
Sets how the material is blended with the scene behind it.
Parameters
- value: BlendType
  The blend type.
Returns void
- Defined in src/material.ts:710

bumpiness

get bumpiness(): number
Gets the strength of the normal map.

Returns number
The bumpiness.
- Defined in src/material.ts:742
set bumpiness(value: number): void
Sets the strength of the normal map, where 0 is flat and 1 is the map's full effect.
Parameters
- value: number
  The bumpiness.
Returns void
- Defined in src/material.ts:730

cull

get cull(): CullMode
Gets which faces of a mesh are culled.

Returns CullMode
The cull mode.
- Defined in src/material.ts:762
set cull(value: CullMode): void
Sets which faces of a mesh are culled.
Parameters
- value: CullMode
  The cull mode.
Returns void
- Defined in src/material.ts:750

depthBias

get depthBias(): number
Gets the offset applied to the depth of a fragment.

Returns number
The depth bias.
- Defined in src/material.ts:782
set depthBias(value: number): void
Sets the offset applied to the depth of a fragment, used to resolve z-fighting.
Parameters
- value: number
  The depth bias.
Returns void
- Defined in src/material.ts:770

depthTest

get depthTest(): boolean
Gets whether fragments are tested against the depth buffer.

Returns boolean
The depth test flag.
- Defined in src/material.ts:802
set depthTest(value: boolean): void
Sets whether fragments are tested against the depth buffer.
Parameters
- value: boolean
  The depth test flag.
Returns void
- Defined in src/material.ts:790

depthWrite

get depthWrite(): boolean
Gets whether fragments write to the depth buffer.

Returns boolean
The depth write flag.
- Defined in src/material.ts:822
set depthWrite(value: boolean): void
Sets whether fragments write to the depth buffer.
Parameters
- value: boolean
  The depth write flag.
Returns void
- Defined in src/material.ts:810

diffuse

get diffuse(): Color
Gets the diffuse color of the material.

Returns Color
The diffuse color.
- Defined in src/material.ts:843
set diffuse(value: Color): void
Sets the diffuse color of the material. With the metalness workflow this doubles as the specular color where the surface is metallic.
Parameters
- value: Color
  The diffuse color.
Returns void
- Defined in src/material.ts:831

diffuseMap

get diffuseMap(): string
Gets the id of the pc-asset used as the diffuse map.

Returns string
The asset id.
- Defined in src/material.ts:860
set diffuseMap(value: string): void
Sets the id of the pc-asset to use as the diffuse map.
Parameters
- value: string
  The asset id.
Returns void
- Defined in src/material.ts:851

diffuseMapChannel

get diffuseMapChannel(): ColorChannel
Gets the color channels of the diffuse map to sample.

Returns ColorChannel
The channels.
- Defined in src/material.ts:880
set diffuseMapChannel(value: ColorChannel): void
Sets the color channels of the diffuse map to sample.
Parameters
- value: ColorChannel
  The channels.
Returns void
- Defined in src/material.ts:868

diffuseMapOffset

get diffuseMapOffset(): Vec2
Gets the 2D offset of the diffuse map.

Returns Vec2
The offset.
- Defined in src/material.ts:900
set diffuseMapOffset(value: Vec2): void
Sets the 2D offset of the diffuse map.
Parameters
- value: Vec2
  The offset.
Returns void
- Defined in src/material.ts:888

diffuseMapRotation

get diffuseMapRotation(): number
Gets the 2D rotation of the diffuse map.

Returns number
The rotation.
- Defined in src/material.ts:920
set diffuseMapRotation(value: number): void
Sets the 2D rotation of the diffuse map, in degrees.
Parameters
- value: number
  The rotation.
Returns void
- Defined in src/material.ts:908

diffuseMapTiling

get diffuseMapTiling(): Vec2
Gets the 2D tiling of the diffuse map.

Returns Vec2
The tiling.
- Defined in src/material.ts:940
set diffuseMapTiling(value: Vec2): void
Sets the 2D tiling of the diffuse map.
Parameters
- value: Vec2
  The tiling.
Returns void
- Defined in src/material.ts:928

diffuseMapUv

get diffuseMapUv(): number
Gets the UV channel the diffuse map samples.

Returns number
The UV channel.
- Defined in src/material.ts:960
set diffuseMapUv(value: number): void
Sets the UV channel the diffuse map samples.
Parameters
- value: number
  The UV channel.
Returns void
- Defined in src/material.ts:948

emissive

get emissive(): Color
Gets the emissive color of the material.

Returns Color
The emissive color.
- Defined in src/material.ts:980
set emissive(value: Color): void
Sets the emissive color of the material, which is added to the lit result.
Parameters
- value: Color
  The emissive color.
Returns void
- Defined in src/material.ts:968

emissiveIntensity

get emissiveIntensity(): number
Gets the multiplier applied to the emissive color and map.

Returns number
The emissive intensity.
- Defined in src/material.ts:1000
set emissiveIntensity(value: number): void
Sets the multiplier applied to the emissive color and map.
Parameters
- value: number
  The emissive intensity.
Returns void
- Defined in src/material.ts:988

emissiveMap

get emissiveMap(): string
Gets the id of the pc-asset used as the emissive map.

Returns string
The asset id.
- Defined in src/material.ts:1017
set emissiveMap(value: string): void
Sets the id of the pc-asset to use as the emissive map.
Parameters
- value: string
  The asset id.
Returns void
- Defined in src/material.ts:1008

emissiveMapChannel

get emissiveMapChannel(): ColorChannel
Gets the color channels of the emissive map to sample.

Returns ColorChannel
The channels.
- Defined in src/material.ts:1037
set emissiveMapChannel(value: ColorChannel): void
Sets the color channels of the emissive map to sample.
Parameters
- value: ColorChannel
  The channels.
Returns void
- Defined in src/material.ts:1025

emissiveMapOffset

get emissiveMapOffset(): Vec2
Gets the 2D offset of the emissive map.

Returns Vec2
The offset.
- Defined in src/material.ts:1057
set emissiveMapOffset(value: Vec2): void
Sets the 2D offset of the emissive map.
Parameters
- value: Vec2
  The offset.
Returns void
- Defined in src/material.ts:1045

emissiveMapRotation

get emissiveMapRotation(): number
Gets the 2D rotation of the emissive map.

Returns number
The rotation.
- Defined in src/material.ts:1077
set emissiveMapRotation(value: number): void
Sets the 2D rotation of the emissive map, in degrees.
Parameters
- value: number
  The rotation.
Returns void
- Defined in src/material.ts:1065

emissiveMapTiling

get emissiveMapTiling(): Vec2
Gets the 2D tiling of the emissive map.

Returns Vec2
The tiling.
- Defined in src/material.ts:1097
set emissiveMapTiling(value: Vec2): void
Sets the 2D tiling of the emissive map.
Parameters
- value: Vec2
  The tiling.
Returns void
- Defined in src/material.ts:1085

emissiveMapUv

get emissiveMapUv(): number
Gets the UV channel the emissive map samples.

Returns number
The UV channel.
- Defined in src/material.ts:1117
set emissiveMapUv(value: number): void
Sets the UV channel the emissive map samples.
Parameters
- value: number
  The UV channel.
Returns void
- Defined in src/material.ts:1105

enableGGXSpecular

get enableGGXSpecular(): boolean
Gets whether to use the GGX specular model.

Returns boolean
The GGX specular flag.
- Defined in src/material.ts:1137
set enableGGXSpecular(value: boolean): void
Sets whether to use the GGX specular model, which supports anisotropy.
Parameters
- value: boolean
  The GGX specular flag.
Returns void
- Defined in src/material.ts:1125

fresnelModel

get fresnelModel(): FresnelModel
Gets the Fresnel model used for specular reflections at grazing angles.

Returns FresnelModel
The Fresnel model.
- Defined in src/material.ts:1157
set fresnelModel(value: FresnelModel): void
Sets the Fresnel model used for specular reflections at grazing angles.
Parameters
- value: FresnelModel
  The Fresnel model.
Returns void
- Defined in src/material.ts:1145

gloss

get gloss(): number
Gets the glossiness of the material.

Returns number
The gloss.
- Defined in src/material.ts:1177
set gloss(value: number): void
Sets the glossiness of the material, from 0 (rough) to 1 (shiny). See also roughness.
Parameters
- value: number
  The gloss.
Returns void
- Defined in src/material.ts:1165

glossInvert

get glossInvert(): boolean
Gets whether the gloss value and map are inverted.

Returns boolean
The gloss invert flag.
- Defined in src/material.ts:1198
set glossInvert(value: boolean): void
Sets whether the gloss value and map are inverted, which makes the material treat them as roughness. Setting roughness or roughness-map enables this automatically.
Parameters
- value: boolean
  The gloss invert flag.
Returns void
- Defined in src/material.ts:1186

glossMap

get glossMap(): string
Gets the id of the pc-asset used as the gloss map.

Returns string
The asset id.
- Defined in src/material.ts:1215
set glossMap(value: string): void
Sets the id of the pc-asset to use as the gloss map. See also roughnessMap.
Parameters
- value: string
  The asset id.
Returns void
- Defined in src/material.ts:1206

glossMapChannel

get glossMapChannel(): ScalarChannel
Gets the color channel of the gloss map to sample.

Returns ScalarChannel
The channel.
- Defined in src/material.ts:1235
set glossMapChannel(value: ScalarChannel): void
Sets the color channel of the gloss map to sample.
Parameters
- value: ScalarChannel
  The channel.
Returns void
- Defined in src/material.ts:1223

glossMapOffset

get glossMapOffset(): Vec2
Gets the 2D offset of the gloss map.

Returns Vec2
The offset.
- Defined in src/material.ts:1255
set glossMapOffset(value: Vec2): void
Sets the 2D offset of the gloss map.
Parameters
- value: Vec2
  The offset.
Returns void
- Defined in src/material.ts:1243

glossMapRotation

get glossMapRotation(): number
Gets the 2D rotation of the gloss map.

Returns number
The rotation.
- Defined in src/material.ts:1275
set glossMapRotation(value: number): void
Sets the 2D rotation of the gloss map, in degrees.
Parameters
- value: number
  The rotation.
Returns void
- Defined in src/material.ts:1263

glossMapTiling

get glossMapTiling(): Vec2
Gets the 2D tiling of the gloss map.

Returns Vec2
The tiling.
- Defined in src/material.ts:1295
set glossMapTiling(value: Vec2): void
Sets the 2D tiling of the gloss map.
Parameters
- value: Vec2
  The tiling.
Returns void
- Defined in src/material.ts:1283

glossMapUv

get glossMapUv(): number
Gets the UV channel the gloss map samples.

Returns number
The UV channel.
- Defined in src/material.ts:1315
set glossMapUv(value: number): void
Sets the UV channel the gloss map samples.
Parameters
- value: number
  The UV channel.
Returns void
- Defined in src/material.ts:1303

heightMap

get heightMap(): string
Gets the id of the pc-asset used as the height map.

Returns string
The asset id.
- Defined in src/material.ts:1332
set heightMap(value: string): void
Sets the id of the pc-asset to use as the height map, which drives parallax mapping.
Parameters
- value: string
  The asset id.
Returns void
- Defined in src/material.ts:1323

heightMapChannel

get heightMapChannel(): ScalarChannel
Gets the color channel of the height map to sample.

Returns ScalarChannel
The channel.
- Defined in src/material.ts:1352
set heightMapChannel(value: ScalarChannel): void
Sets the color channel of the height map to sample.
Parameters
- value: ScalarChannel
  The channel.
Returns void
- Defined in src/material.ts:1340

heightMapFactor

get heightMapFactor(): number
Gets the strength of the parallax effect driven by the height map.

Returns number
The height map factor.
- Defined in src/material.ts:1372
set heightMapFactor(value: number): void
Sets the strength of the parallax effect driven by the height map.
Parameters
- value: number
  The height map factor.
Returns void
- Defined in src/material.ts:1360

heightMapOffset

get heightMapOffset(): Vec2
Gets the 2D offset of the height map.

Returns Vec2
The offset.
- Defined in src/material.ts:1392
set heightMapOffset(value: Vec2): void
Sets the 2D offset of the height map.
Parameters
- value: Vec2
  The offset.
Returns void
- Defined in src/material.ts:1380

heightMapRotation

get heightMapRotation(): number
Gets the 2D rotation of the height map.

Returns number
The rotation.
- Defined in src/material.ts:1412
set heightMapRotation(value: number): void
Sets the 2D rotation of the height map, in degrees.
Parameters
- value: number
  The rotation.
Returns void
- Defined in src/material.ts:1400

heightMapTiling

get heightMapTiling(): Vec2
Gets the 2D tiling of the height map.

Returns Vec2
The tiling.
- Defined in src/material.ts:1432
set heightMapTiling(value: Vec2): void
Sets the 2D tiling of the height map.
Parameters
- value: Vec2
  The tiling.
Returns void
- Defined in src/material.ts:1420

heightMapUv

get heightMapUv(): number
Gets the UV channel the height map samples.

Returns number
The UV channel.
- Defined in src/material.ts:1452
set heightMapUv(value: number): void
Sets the UV channel the height map samples.
Parameters
- value: number
  The UV channel.
Returns void
- Defined in src/material.ts:1440

metalness

get metalness(): number
Gets how metallic the surface is.

Returns number
The metalness.
- Defined in src/material.ts:1472
set metalness(value: number): void
Sets how metallic the surface is, from 0 (dielectric) to 1 (metal).
Parameters
- value: number
  The metalness.
Returns void
- Defined in src/material.ts:1460

metalnessMap

get metalnessMap(): string
Gets the id of the pc-asset used as the metalness map.

Returns string
The asset id.
- Defined in src/material.ts:1489
set metalnessMap(value: string): void
Sets the id of the pc-asset to use as the metalness map.
Parameters
- value: string
  The asset id.
Returns void
- Defined in src/material.ts:1480

metalnessMapChannel

get metalnessMapChannel(): ScalarChannel
Gets the color channel of the metalness map to sample.

Returns ScalarChannel
The channel.
- Defined in src/material.ts:1509
set metalnessMapChannel(value: ScalarChannel): void
Sets the color channel of the metalness map to sample.
Parameters
- value: ScalarChannel
  The channel.
Returns void
- Defined in src/material.ts:1497

metalnessMapOffset

get metalnessMapOffset(): Vec2
Gets the 2D offset of the metalness map.

Returns Vec2
The offset.
- Defined in src/material.ts:1529
set metalnessMapOffset(value: Vec2): void
Sets the 2D offset of the metalness map.
Parameters
- value: Vec2
  The offset.
Returns void
- Defined in src/material.ts:1517

metalnessMapRotation

get metalnessMapRotation(): number
Gets the 2D rotation of the metalness map.

Returns number
The rotation.
- Defined in src/material.ts:1549
set metalnessMapRotation(value: number): void
Sets the 2D rotation of the metalness map, in degrees.
Parameters
- value: number
  The rotation.
Returns void
- Defined in src/material.ts:1537

metalnessMapTiling

get metalnessMapTiling(): Vec2
Gets the 2D tiling of the metalness map.

Returns Vec2
The tiling.
- Defined in src/material.ts:1569
set metalnessMapTiling(value: Vec2): void
Sets the 2D tiling of the metalness map.
Parameters
- value: Vec2
  The tiling.
Returns void
- Defined in src/material.ts:1557

metalnessMapUv

get metalnessMapUv(): number
Gets the UV channel the metalness map samples.

Returns number
The UV channel.
- Defined in src/material.ts:1589
set metalnessMapUv(value: number): void
Sets the UV channel the metalness map samples.
Parameters
- value: number
  The UV channel.
Returns void
- Defined in src/material.ts:1577

normalMap

get normalMap(): string
Gets the id of the pc-asset used as the normal map.

Returns string
The asset id.
- Defined in src/material.ts:1606
set normalMap(value: string): void
Sets the id of the pc-asset to use as the normal map.
Parameters
- value: string
  The asset id.
Returns void
- Defined in src/material.ts:1597

normalMapOffset

get normalMapOffset(): Vec2
Gets the 2D offset of the normal map.

Returns Vec2
The offset.
- Defined in src/material.ts:1626
set normalMapOffset(value: Vec2): void
Sets the 2D offset of the normal map.
Parameters
- value: Vec2
  The offset.
Returns void
- Defined in src/material.ts:1614

normalMapRotation

get normalMapRotation(): number
Gets the 2D rotation of the normal map.

Returns number
The rotation.
- Defined in src/material.ts:1646
set normalMapRotation(value: number): void
Sets the 2D rotation of the normal map, in degrees.
Parameters
- value: number
  The rotation.
Returns void
- Defined in src/material.ts:1634

normalMapTiling

get normalMapTiling(): Vec2
Gets the 2D tiling of the normal map.

Returns Vec2
The tiling.
- Defined in src/material.ts:1666
set normalMapTiling(value: Vec2): void
Sets the 2D tiling of the normal map.
Parameters
- value: Vec2
  The tiling.
Returns void
- Defined in src/material.ts:1654

normalMapUv

get normalMapUv(): number
Gets the UV channel the normal map samples.

Returns number
The UV channel.
- Defined in src/material.ts:1686
set normalMapUv(value: number): void
Sets the UV channel the normal map samples.
Parameters
- value: number
  The UV channel.
Returns void
- Defined in src/material.ts:1674

occludeDirect

get occludeDirect(): boolean
Gets whether ambient occlusion also attenuates direct lighting.

Returns boolean
The occlude direct flag.
- Defined in src/material.ts:1707
set occludeDirect(value: boolean): void
Sets whether ambient occlusion also attenuates direct lighting.
Parameters
- value: boolean
  The occlude direct flag.
Returns void
- Defined in src/material.ts:1694

occludeSpecular

get occludeSpecular(): OccludeSpecular
Gets how specular reflections are occluded.

Returns OccludeSpecular
The specular occlusion mode.
- Defined in src/material.ts:1727
set occludeSpecular(value: OccludeSpecular): void
Sets how specular reflections are occluded.
Parameters
- value: OccludeSpecular
  The specular occlusion mode.
Returns void
- Defined in src/material.ts:1715

opacity

get opacity(): number
Gets the opacity of the material, which requires a blend-type other than none to have any visible effect.

Returns number
The opacity.
- Defined in src/material.ts:1749
set opacity(value: number): void
Sets the opacity of the material, from 0 (transparent) to 1 (opaque), which requires a blend-type other than none to have any visible effect.
Parameters
- value: number
  The opacity.
Returns void
- Defined in src/material.ts:1736

opacityDither

get opacityDither(): OpacityDither
Gets the dithering used to render opacity.

Returns OpacityDither
The dither mode.
- Defined in src/material.ts:1769
set opacityDither(value: OpacityDither): void
Sets the dithering used to render opacity, which approximates transparency without blending.
Parameters
- value: OpacityDither
  The dither mode.
Returns void
- Defined in src/material.ts:1757

opacityFadesSpecular

get opacityFadesSpecular(): boolean
Gets whether specular highlights fade out as the material becomes transparent.

Returns boolean
The opacity fades specular flag.
- Defined in src/material.ts:1789
set opacityFadesSpecular(value: boolean): void
Sets whether specular highlights fade out as the material becomes transparent.
Parameters
- value: boolean
  The opacity fades specular flag.
Returns void
- Defined in src/material.ts:1777

opacityMap

get opacityMap(): string
Gets the id of the pc-asset used as the opacity map.

Returns string
The asset id.
- Defined in src/material.ts:1806
set opacityMap(value: string): void
Sets the id of the pc-asset to use as the opacity map.
Parameters
- value: string
  The asset id.
Returns void
- Defined in src/material.ts:1797

opacityMapChannel

get opacityMapChannel(): ScalarChannel
Gets the color channel of the opacity map to sample.

Returns ScalarChannel
The channel.
- Defined in src/material.ts:1826
set opacityMapChannel(value: ScalarChannel): void
Sets the color channel of the opacity map to sample.
Parameters
- value: ScalarChannel
  The channel.
Returns void
- Defined in src/material.ts:1814

opacityMapOffset

get opacityMapOffset(): Vec2
Gets the 2D offset of the opacity map.

Returns Vec2
The offset.
- Defined in src/material.ts:1846
set opacityMapOffset(value: Vec2): void
Sets the 2D offset of the opacity map.
Parameters
- value: Vec2
  The offset.
Returns void
- Defined in src/material.ts:1834

opacityMapRotation

get opacityMapRotation(): number
Gets the 2D rotation of the opacity map.

Returns number
The rotation.
- Defined in src/material.ts:1866
set opacityMapRotation(value: number): void
Sets the 2D rotation of the opacity map, in degrees.
Parameters
- value: number
  The rotation.
Returns void
- Defined in src/material.ts:1854

opacityMapTiling

get opacityMapTiling(): Vec2
Gets the 2D tiling of the opacity map.

Returns Vec2
The tiling.
- Defined in src/material.ts:1886
set opacityMapTiling(value: Vec2): void
Sets the 2D tiling of the opacity map.
Parameters
- value: Vec2
  The tiling.
Returns void
- Defined in src/material.ts:1874

opacityMapUv

get opacityMapUv(): number
Gets the UV channel the opacity map samples.

Returns number
The UV channel.
- Defined in src/material.ts:1906
set opacityMapUv(value: number): void
Sets the UV channel the opacity map samples.
Parameters
- value: number
  The UV channel.
Returns void
- Defined in src/material.ts:1894

roughness

get roughness(): number
Gets the roughness of the material.

Returns number
The roughness.
- Defined in src/material.ts:1924
set roughness(value: number): void
Sets the roughness of the material, from 0 (shiny) to 1 (rough). This is an alias for gloss that also inverts the gloss channel, so do not combine it with the gloss attributes.
Parameters
- value: number
  The roughness.
Returns void
- Defined in src/material.ts:1915

roughnessMap

get roughnessMap(): string
Gets the id of the pc-asset used as the roughness map.

Returns string
The asset id.
- Defined in src/material.ts:1942
set roughnessMap(value: string): void
Sets the id of the pc-asset to use as the roughness map. This is an alias for glossMap that also inverts the gloss channel, so do not combine it with the gloss attributes.
Parameters
- value: string
  The asset id.
Returns void
- Defined in src/material.ts:1933

slopeDepthBias

get slopeDepthBias(): number
Gets the depth offset applied in proportion to a surface's slope.

Returns number
The slope depth bias.
- Defined in src/material.ts:1962
set slopeDepthBias(value: number): void
Sets the depth offset applied in proportion to a surface's slope, used to resolve z-fighting.
Parameters
- value: number
  The slope depth bias.
Returns void
- Defined in src/material.ts:1950

specular

get specular(): Color
Gets the specular color of the material, which applies only when the metalness workflow is disabled or use-metalness-specular-color is enabled.

Returns Color
The specular color.
- Defined in src/material.ts:1984
set specular(value: Color): void
Sets the specular color of the material, which applies only when the metalness workflow is disabled or use-metalness-specular-color is enabled.
Parameters
- value: Color
  The specular color.
Returns void
- Defined in src/material.ts:1971

specularityFactor

get specularityFactor(): number
Gets the strength of specular reflections at direct angles, which applies only when use-metalness-specular-color is enabled.

Returns number
The specularity factor.
- Defined in src/material.ts:2006
set specularityFactor(value: number): void
Sets the strength of specular reflections at direct angles, from 0 to 1, which applies only when use-metalness-specular-color is enabled.
Parameters
- value: number
  The specularity factor.
Returns void
- Defined in src/material.ts:1993

twoSidedLighting

get twoSidedLighting(): boolean
Gets whether back faces are lit as though their normals were flipped.

Returns boolean
The two sided lighting flag.
- Defined in src/material.ts:2026
set twoSidedLighting(value: boolean): void
Sets whether back faces are lit as though their normals were flipped.
Parameters
- value: boolean
  The two sided lighting flag.
Returns void
- Defined in src/material.ts:2014

useFog

get useFog(): boolean
Gets whether the material is affected by scene fog.

Returns boolean
The use fog flag.
- Defined in src/material.ts:2046
set useFog(value: boolean): void
Sets whether the material is affected by scene fog.
Parameters
- value: boolean
  The use fog flag.
Returns void
- Defined in src/material.ts:2034

useLighting

get useLighting(): boolean
Gets whether the material is affected by scene lights.

Returns boolean
The use lighting flag.
- Defined in src/material.ts:2067
set useLighting(value: boolean): void
Sets whether the material is affected by scene lights. When disabled the material renders unlit, using the diffuse color and map alone.
Parameters
- value: boolean
  The use lighting flag.
Returns void
- Defined in src/material.ts:2055

useMetalness

get useMetalness(): boolean
Gets whether to use the metalness workflow.

Returns boolean
The use metalness flag.
- Defined in src/material.ts:2089
set useMetalness(value: boolean): void
Sets whether to use the metalness workflow rather than the older specular workflow. Unlike a bare StandardMaterial this defaults to true, because the metalness-* attributes have no effect without it.
Parameters
- value: boolean
  The use metalness flag.
Returns void
- Defined in src/material.ts:2077

useMetalnessSpecularColor

get useMetalnessSpecularColor(): boolean
Gets whether the specular color tints reflections while the metalness workflow is in use.

Returns boolean
The use metalness specular color flag.
- Defined in src/material.ts:2109
set useMetalnessSpecularColor(value: boolean): void
Sets whether the specular color tints reflections while the metalness workflow is in use.
Parameters
- value: boolean
  The use metalness specular color flag.
Returns void
- Defined in src/material.ts:2097

useSkybox

get useSkybox(): boolean
Gets whether the material is lit by the scene's skybox.

Returns boolean
The use skybox flag.
- Defined in src/material.ts:2129
set useSkybox(value: boolean): void
Sets whether the material is lit by the scene's skybox.
Parameters
- value: boolean
  The use skybox flag.
Returns void
- Defined in src/material.ts:2117

useTonemap

get useTonemap(): boolean
Gets whether the camera's tone mapping is applied to the material.

Returns boolean
The use tonemap flag.
- Defined in src/material.ts:2149
set useTonemap(value: boolean): void
Sets whether the camera's tone mapping is applied to the material.
Parameters
- value: boolean
  The use tonemap flag.
Returns void
- Defined in src/material.ts:2137

Methods

setMap

setMap(id: string, slot: TextureSlot): void
Points a texture slot at the resource of a pc-asset, waiting for the asset to load when it has not already. An empty id clears the slot.
Parameters
- id: string
  The id of the pc-asset, or an empty string to clear the slot.
- slot: TextureSlot
  The material property to write.
Returns void
- Defined in src/material.ts:491

Class MaterialElement

Attribute

Attribute

Hierarchy

Index

Accessors

Methods

Accessors

alphaTest

Returns number

Parameters

Returns void

alphaToCoverage

Returns boolean

Parameters

Returns void

aoIntensity

Returns number

Parameters

Returns void

aoMap

Returns string

Parameters

Returns void

aoMapChannel

Returns ScalarChannel

Parameters

Returns void

aoMapOffset

Returns Vec2

Parameters

Returns void

aoMapRotation

Returns number

Parameters

Returns void

aoMapTiling

Returns Vec2

Parameters

Returns void

aoMapUv

Returns number

Parameters

Returns void

blendType

Returns BlendType

Parameters

Returns void

bumpiness

Returns number

Parameters

Returns void

cull

Returns CullMode

Parameters

Returns void

depthBias

Returns number

Parameters

Returns void

depthTest

Returns boolean

Parameters

Returns void

depthWrite

Returns boolean

Parameters

Returns void

diffuse

Returns Color

Parameters

Returns void

diffuseMap

Returns string

Parameters

Returns void

diffuseMapChannel

Returns ColorChannel

Parameters

Returns void