`useMaterial`

The useMaterial hook allows you to create and manage a PlayCanvas StandardMaterial instance. Create a material with the hook and apply it to a <Render/> component.

Usage

You can create a material with the hook and apply it to a <Render/> component and update material properties dynamically.

Demo
Code

material-example.jsx
// ↑ imports hidden
export const MaterialExample = () => {
    const materialProps = useControls(vars);
    const material = useMaterial({ 
      useMetalness: true,
      glossInvert: true,
      ...materialProps 
    });


    return (
      <Entity>
          <Render type="box" material={material} />
      </Entity>
    );
};

Parameters

The hooks accepts an object with the following properties that closely match those of the StandardMaterial class.

Parameters

Name	Type	Default
`userAttributes?`	`Map<any, any>`	`-`
`onUpdateShader?`	`UpdateShaderCallback \| undefined` A custom function that will be called after all shader generator properties are collected and before shader code is generated. This function will receive an object with shader generator settings (based on current material and scene properties), that you can change and then return. Returned value will be used instead. This is mostly useful when rendering the same set of objects, but with different shader variations based on the same material. For example, you may wish to render a depth or normal pass using textures assigned to the material, a reflection pass with simpler shaders and so on. These properties are split into two sections, generic standard material options and lit options. Properties of the standard material options are StandardMaterialOptions and the options for the lit options are LitShaderOptions.	`-`
`shaderOptBuilder?`	`StandardMaterialOptionsBuilder`	`-`
`alphaFade?`	`boolean`	`-`
`ambient?`	`string` The ambient color of the material. This color value is 3-component (RGB), where each component is between 0 and 1.	`-`
`anisotropy?`	`number` Intensity Defines amount of anisotropy. Requires StandardMaterial#enableGGXSpecular is set to true. - When anisotropyIntensity == 0, specular is isotropic. - Specular anisotropy increases as anisotropyIntensity value increases to maximum of 1.	`-`
`anisotropyIntensity?`	`number` Defines amount of anisotropy. Requires StandardMaterial#enableGGXSpecular is set to true. - When anisotropyIntensity == 0, specular is isotropic. - Specular anisotropy increases as anisotropyIntensity value increases to maximum of 1.	`-`
`anisotropyRotation?`	`number` Defines the rotation (in degrees) of anisotropy.	`-`
`anisotropyMap?`	`Texture \| null` e main (primary) diffuse map of the material (default is null).	`-`
`anisotropyMapOffset?`	`[number, number]` Controls the 2D offset of the anisotropy map. Each component is between 0 and 1.	`-`
`anisotropyMapRotation?`	`number` Controls the 2D rotation (in degrees) of the anisotropy map.	`-`
`anisotropyMapTiling?`	`[number, number]` Controls the 2D tiling of the anisotropy map.	`-`
`anisotropyMapUv?`	`number` Anisotropy map UV channel.	`-`
`aoIntensity?`	`number` Ambient occlusion intensity. Defaults to 1.	`-`
`aoMap?`	`Texture \| null` seMap The main (primary) diffuse map of the material (default is null).	`-`
`aoMapChannel?`	`string` Color channel of the main (primary) AO map to use. Can be "r", "g", "b" or "a".	`-`
`aoMapOffset?`	`[number, number]` Controls the 2D offset of the main (primary) AO map. Each component is between 0 and 1.	`-`
`aoMapRotation?`	`number` Controls the 2D rotation (in degrees) of the main (primary) AO map.	`-`
`aoMapTiling?`	`[number, number]` Controls the 2D tiling of the main (primary) AO map.	`-`
`aoMapUv?`	`number` Main (primary) AO map UV channel	`-`
`aoDetailMap?`	`Texture \| null` The main (primary) diffuse map of the material (default is null).	`-`
`aoDetailMapChannel?`	`string` Color channels of the detail (secondary) AO map to use. Can be "r", "g", "b" or "a" (default is "g").	`-`
`aoDetailMapOffset?`	`[number, number]` Controls the 2D offset of the detail (secondary) AO map. Each component is between 0 and 1.	`-`
`aoDetailMapRotation?`	`number` Controls the 2D rotation (in degrees) of the detail (secondary) AO map.	`-`
`aoDetailMapTiling?`	`[number, number]` Controls the 2D tiling of the detail (secondary) AO map.	`-`
`aoDetailMapUv?`	`number` Detail (secondary) AO map UV channel.	`-`
`aoDetailMode?`	`string` Determines how the main (primary) and detail (secondary) AO maps are blended together. Can be: - DETAILMODE_MUL: Multiply together the primary and secondary colors. - DETAILMODE_ADD: Add together the primary and secondary colors. - DETAILMODE_SCREEN: Softer version of DETAILMODE_ADD. - DETAILMODE_OVERLAY: Multiplies or screens the colors, depending on the primary color. - DETAILMODE_MIN: Select whichever of the primary and secondary colors is darker, component-wise. - DETAILMODE_MAX: Select whichever of the primary and secondary colors is lighter, component-wise. Defaults to DETAILMODE_MUL.	`-`
`aoVertexColor?`	`boolean` Use mesh vertex colors for AO. If aoMap is set, it'll be multiplied by vertex colors.	`-`
`aoVertexColorChannel?`	`string` Vertex color channels to use for AO. Can be "r", "g", "b" or "a".	`-`
`bumpiness?`	`number` The bumpiness of the material. This value scales the assigned main (primary) normal map. It should be normally between 0 (no bump mapping) and 1 (full bump mapping), but can be set to e.g. 2 to give even more pronounced bump effect.	`-`
`clearCoat?`	`number` Defines intensity of clearcoat layer from 0 to 1. Clearcoat layer is disabled when clearCoat == 0. Default value is 0 (disabled).	`-`
`clearCoatBumpiness?`	`number` The bumpiness of the clearcoat layer. This value scales the assigned main clearcoat normal map. It should be normally between 0 (no bump mapping) and 1 (full bump mapping), but can be set to e.g. 2 to give even more pronounced bump effect.	`-`
`clearCoatGlossInvert?`	`boolean` Invert the clearcoat gloss component (default is false). Enabling this flag results in material treating the clear coat gloss members as roughness.	`-`
`clearCoatGlossMap?`	`Texture \| null` in (primary) diffuse map of the material (default is null).	`-`
`clearCoatGlossMapChannel?`	`string` Color channel of the clearcoat gloss map to use. Can be "r", "g", "b" or "a".	`-`
`clearCoatGlossMapOffset?`	`[number, number]` Controls the 2D offset of the clearcoat gloss map. Each component is between 0 and 1.	`-`
`clearCoatGlossMapRotation?`	`number` Controls the 2D rotation (in degrees) of the clear coat gloss map.	`-`
`clearCoatGlossMapTiling?`	`[number, number]` Controls the 2D tiling of the clearcoat gloss map.	`-`
`clearCoatGlossMapUv?`	`number` Clearcoat gloss map UV channel.	`-`
`clearCoatGlossVertexColor?`	`boolean` Use mesh vertex colors for clearcoat glossiness. If clearCoatGlossMap is set, it'll be multiplied by vertex colors.	`-`
`clearCoatGlossVertexColorChannel?`	`string` Vertex color channel to use for clearcoat glossiness. Can be "r", "g", "b" or "a".	`-`
`clearCoatGloss?`	`number` Defines the clearcoat glossiness of the clearcoat layer from 0 (rough) to 1 (mirror).	`-`
`clearCoatMap?`	`Texture \| null` he main (primary) diffuse map of the material (default is null).	`-`
`clearCoatMapChannel?`	`string` Color channel of the clearcoat intensity map to use. Can be "r", "g", "b" or "a".	`-`
`clearCoatMapOffset?`	`[number, number]` Controls the 2D offset of the clearcoat intensity map. Each component is between 0 and 1.	`-`
`clearCoatMapRotation?`	`number` Controls the 2D rotation (in degrees) of the clearcoat intensity map.	`-`
`clearCoatMapTiling?`	`[number, number]` Controls the 2D tiling of the clearcoat intensity map.	`-`
`clearCoatMapUv?`	`number` Clearcoat intensity map UV channel.	`-`
`clearCoatNormalMap?`	`Texture \| null` n (primary) diffuse map of the material (default is null).	`-`
`clearCoatNormalMapOffset?`	`[number, number]` Controls the 2D offset of the main clearcoat normal map. Each component is between 0 and 1.	`-`
`clearCoatNormalMapRotation?`	`number` Controls the 2D rotation (in degrees) of the main clearcoat map.	`-`
`clearCoatNormalMapTiling?`	`[number, number]` Controls the 2D tiling of the main clearcoat normal map.	`-`
`clearCoatNormalMapUv?`	`number` Clearcoat normal map UV channel.	`-`
`clearCoatVertexColor?`	`boolean` Use mesh vertex colors for clearcoat intensity. If clearCoatMap is set, it'll be multiplied by vertex colors.	`-`
`clearCoatVertexColorChannel?`	`string` Vertex color channel to use for clearcoat intensity. Can be "r", "g", "b" or "a".	`-`
`cubeMap?`	`Texture \| null` Map The main (primary) diffuse map of the material (default is null).	`-`
`cubeMapProjection?`	`number` The type of projection applied to the cubeMap property: - CUBEPROJ_NONE: The cube map is treated as if it is infinitely far away. - CUBEPROJ_BOX: Box-projection based on a world space axis-aligned bounding box. Defaults to CUBEPROJ_NONE.	`-`
`cubeMapProjectionBox?`	`BoundingBox` The world space axis-aligned bounding box defining the box-projection used for the cubeMap property. Only used when cubeMapProjection is set to CUBEPROJ_BOX.	`-`
`diffuse?`	`string` The diffuse color of the material. This color value is 3-component (RGB), where each component is between 0 and 1. Defines basic surface color (aka albedo).	`-`
`diffuseDetailMap?`	`Texture \| null` ain (primary) diffuse map of the material (default is null).	`-`
`diffuseDetailMapChannel?`	`string` Color channels of the detail (secondary) diffuse map to use. Can be "r", "g", "b", "a", "rgb" or any swizzled combination.	`-`
`diffuseDetailMapOffset?`	`[number, number]` Controls the 2D offset of the detail (secondary) diffuse map. Each component is between 0 and 1.	`-`
`diffuseDetailMapRotation?`	`number` Controls the 2D rotation (in degrees) of the main (secondary) diffuse map.	`-`
`diffuseDetailMapTiling?`	`[number, number]` Controls the 2D tiling of the detail (secondary) diffuse map.	`-`
`diffuseDetailMapUv?`	`number` Detail (secondary) diffuse map UV channel.	`-`
`diffuseDetailMode?`	`string` Determines how the main (primary) and detail (secondary) diffuse maps are blended together. Can be: - DETAILMODE_MUL: Multiply together the primary and secondary colors. - DETAILMODE_ADD: Add together the primary and secondary colors. - DETAILMODE_SCREEN: Softer version of DETAILMODE_ADD. - DETAILMODE_OVERLAY: Multiplies or screens the colors, depending on the primary color. - DETAILMODE_MIN: Select whichever of the primary and secondary colors is darker, component-wise. - DETAILMODE_MAX: Select whichever of the primary and secondary colors is lighter, component-wise. Defaults to DETAILMODE_MUL.	`-`
`diffuseMap?`	`Texture \| null` The main (primary) diffuse map of the material (default is null).	`-`
`diffuseMapChannel?`	`string` Color channels of the main (primary) diffuse map to use. Can be "r", "g", "b", "a", "rgb" or any swizzled combination.	`-`
`diffuseMapOffset?`	`[number, number]` Controls the 2D offset of the main (primary) diffuse map. Each component is between 0 and 1.	`-`
`diffuseMapRotation?`	`number` Controls the 2D rotation (in degrees) of the main (primary) diffuse map.	`-`
`diffuseMapTiling?`	`[number, number]` Controls the 2D tiling of the main (primary) diffuse map.	`-`
`diffuseMapUv?`	`number` Main (primary) diffuse map UV channel.	`-`
`diffuseVertexColor?`	`boolean` Multiply diffuse by the mesh vertex colors.	`-`
`diffuseVertexColorChannel?`	`string` Vertex color channels to use for diffuse. Can be "r", "g", "b", "a", "rgb" or any swizzled combination.	`-`
`emissive?`	`string` The emissive color of the material. This color value is 3-component (RGB), where each component is between 0 and 1.	`-`
`emissiveIntensity?`	`number` Emissive color multiplier.	`-`
`emissiveMap?`	`Texture \| null` The main (primary) diffuse map of the material (default is null).	`-`
`emissiveMapChannel?`	`string` Color channels of the emissive map to use. Can be "r", "g", "b", "a", "rgb" or any swizzled combination.	`-`
`emissiveMapOffset?`	`[number, number]` Controls the 2D offset of the emissive map. Each component is between 0 and 1.	`-`
`emissiveMapRotation?`	`number` Controls the 2D rotation (in degrees) of the emissive map.	`-`
`emissiveMapTiling?`	`[number, number]` Controls the 2D tiling of the emissive map.	`-`
`emissiveMapUv?`	`number` Emissive map UV channel.	`-`
`emissiveVertexColor?`	`boolean` Use mesh vertex colors for emission. If emissiveMap or emissive are set, they'll be multiplied by vertex colors.	`-`
`emissiveVertexColorChannel?`	`string` Vertex color channels to use for emission. Can be "r", "g", "b", "a", "rgb" or any swizzled combination.	`-`
`enableGGXSpecular?`	`boolean` Enables GGX specular. Also enables StandardMaterial#anisotropyIntensity parameter to set material anisotropy.	`-`
`envAtlas?`	`Texture \| null` ap The main (primary) diffuse map of the material (default is null).	`-`
`fresnelModel?`	`number` Defines the formula used for Fresnel effect. As a side-effect, enabling any Fresnel model changes the way diffuse and reflection components are combined. When Fresnel is off, legacy non energy-conserving combining is used. When it is on, combining behavior is energy-conserving. - FRESNEL_NONE: No Fresnel. - FRESNEL_SCHLICK: Schlick's approximation of Fresnel (recommended). Parameterized by specular color.	`-`
`gloss?`	`number` Defines the glossiness of the material from 0 (rough) to 1 (shiny).	`-`
`glossInvert?`	`boolean` Invert the gloss component (default is false). Enabling this flag results in material treating the gloss members as roughness.	`-`
`glossMap?`	`Texture \| null` ap The main (primary) diffuse map of the material (default is null).	`-`
`glossMapChannel?`	`string` Color channel of the gloss map to use. Can be "r", "g", "b" or "a".	`-`
`glossMapOffset?`	`[number, number]` Controls the 2D offset of the gloss map. Each component is between 0 and 1.	`-`
`glossMapRotation?`	`number` Controls the 2D rotation (in degrees) of the gloss map.	`-`
`glossMapTiling?`	`[number, number]` Controls the 2D tiling of the gloss map.	`-`
`glossMapUv?`	`number` Gloss map UV channel.	`-`
`glossVertexColor?`	`boolean` Use mesh vertex colors for glossiness. If glossMap is set, it'll be multiplied by vertex colors.	`-`
`glossVertexColorChannel?`	`string` Vertex color channel to use for glossiness. Can be "r", "g", "b" or "a".	`-`
`heightMap?`	`Texture \| null` p The main (primary) diffuse map of the material (default is null).	`-`
`heightMapChannel?`	`string` Color channel of the height map to use. Can be "r", "g", "b" or "a".	`-`
`heightMapFactor?`	`number` Height map multiplier. Affects the strength of the parallax effect.	`-`
`heightMapOffset?`	`[number, number]` Controls the 2D offset of the height map. Each component is between 0 and 1.	`-`
`heightMapRotation?`	`number` Controls the 2D rotation (in degrees) of the height map.	`-`
`heightMapTiling?`	`[number, number]` Controls the 2D tiling of the height map.	`-`
`heightMapUv?`	`number` Height map UV channel.	`-`
`lightMap?`	`Texture \| null` ap The main (primary) diffuse map of the material (default is null).	`-`
`lightMapChannel?`	`string` Color channels of the lightmap to use. Can be "r", "g", "b", "a", "rgb" or any swizzled combination.	`-`
`lightMapOffset?`	`[number, number]` Controls the 2D offset of the lightmap. Each component is between 0 and 1.	`-`
`lightMapRotation?`	`number` Controls the 2D rotation (in degrees) of the lightmap.	`-`
`lightMapTiling?`	`[number, number]` Controls the 2D tiling of the lightmap.	`-`
`lightMapUv?`	`number` Lightmap UV channel	`-`
`lightVertexColor?`	`boolean` Use baked vertex lighting. If lightMap is set, it'll be multiplied by vertex colors.	`-`
`lightVertexColorChannel?`	`string` Vertex color channels to use for baked lighting. Can be "r", "g", "b", "a", "rgb" or any swizzled combination.	`-`
`metalness?`	`number` Defines how much the surface is metallic. From 0 (dielectric) to 1 (metal).	`-`
`metalnessMap?`	`Texture \| null` he main (primary) diffuse map of the material (default is null).	`-`
`metalnessMapChannel?`	`string` Color channel of the metalness map to use. Can be "r", "g", "b" or "a".	`-`
`metalnessMapOffset?`	`[number, number]` Controls the 2D offset of the metalness map. Each component is between 0 and 1.	`-`
`metalnessMapRotation?`	`number` Controls the 2D rotation (in degrees) of the metalness map.	`-`
`metalnessMapTiling?`	`[number, number]` Controls the 2D tiling of the metalness map.	`-`
`metalnessMapUv?`	`number` Metalness map UV channel.	`-`
`metalnessVertexColor?`	`boolean` Use mesh vertex colors for metalness. If metalnessMap is set, it'll be multiplied by vertex colors.	`-`
`metalnessVertexColorChannel?`	`string` Vertex color channel to use for metalness. Can be "r", "g", "b" or "a".	`-`
`normalDetailMap?`	`Texture \| null` main (primary) diffuse map of the material (default is null).	`-`
`normalDetailMapBumpiness?`	`number` The bumpiness of the material. This value scales the assigned detail (secondary) normal map. It should be normally between 0 (no bump mapping) and 1 (full bump mapping), but can be set to e.g. 2 to give even more pronounced bump effect.	`-`
`normalDetailMapOffset?`	`[number, number]` Controls the 2D offset of the detail (secondary) normal map. Each component is between 0 and 1.	`-`
`normalDetailMapRotation?`	`number` Controls the 2D rotation (in degrees) of the detail (secondary) normal map.	`-`
`normalDetailMapTiling?`	`[number, number]` Controls the 2D tiling of the detail (secondary) normal map.	`-`
`normalDetailMapUv?`	`number` Detail (secondary) normal map UV channel.	`-`
`normalMap?`	`Texture \| null` p The main (primary) diffuse map of the material (default is null).	`-`
`normalMapOffset?`	`[number, number]` Controls the 2D offset of the main (primary) normal map. Each component is between 0 and 1.	`-`
`normalMapRotation?`	`number` Controls the 2D rotation (in degrees) of the main (primary) normal map.	`-`
`normalMapTiling?`	`[number, number]` Controls the 2D tiling of the main (primary) normal map.	`-`
`normalMapUv?`	`number` Main (primary) normal map UV channel.	`-`
`occludeDirect?`	`number`	`-`
`occludeSpecular?`	`number` Uses ambient occlusion to darken specular/reflection. It's a hack, because real specular occlusion is view-dependent. However, it can be better than nothing. - SPECOCC_NONE: No specular occlusion - SPECOCC_AO: Use AO directly to occlude specular. - SPECOCC_GLOSSDEPENDENT: Modify AO based on material glossiness/view angle to occlude specular.	`-`
`occludeSpecularIntensity?`	`number` Controls visibility of specular occlusion.	`-`
`opacity?`	`number` The opacity of the material. This value can be between 0 and 1, where 0 is fully transparent and 1 is fully opaque. If you want the material to be semi-transparent you also need to set the Material#blendType to BLEND_NORMAL, BLEND_ADDITIVE or any other mode. Also note that for most semi-transparent objects you want Material#depthWrite to be false, otherwise they can fully occlude objects behind them.	`-`
`opacityDither?`	`string` Used to specify whether opacity is dithered, which allows transparency without alpha blending. Can be: - DITHER_NONE: Opacity dithering is disabled. - DITHER_BAYER8: Opacity is dithered using a Bayer 8 matrix. - DITHER_BLUENOISE: Opacity is dithered using a blue noise. - DITHER_IGNNOISE: Opacity is dithered using an interleaved gradient noise. Defaults to DITHER_NONE.	`-`
`opacityShadowDither?`	`string`	`-`
`opacityFadesSpecular?`	`boolean` Used to specify whether specular and reflections are faded out using StandardMaterial#opacity . Default is true. When set to false use Material#alphaFade to fade out materials.	`-`
`opacityMap?`	`Texture \| null` The main (primary) diffuse map of the material (default is null).	`-`
`opacityMapChannel?`	`string` Color channel of the opacity map to use. Can be "r", "g", "b" or "a".	`-`
`opacityMapOffset?`	`[number, number]` Controls the 2D offset of the opacity map. Each component is between 0 and 1.	`-`
`opacityMapRotation?`	`number` Controls the 2D rotation (in degrees) of the opacity map.	`-`
`opacityMapTiling?`	`[number, number]` Controls the 2D tiling of the opacity map.	`-`
`opacityMapUv?`	`number` Opacity map UV channel.	`-`
`opacityVertexColor?`	`boolean` Use mesh vertex colors for opacity. If opacityMap is set, it'll be multiplied by vertex colors.	`-`
`opacityVertexColorChannel?`	`string` Vertex color channels to use for opacity. Can be "r", "g", "b" or "a".	`-`
`pixelSnap?`	`boolean` Align vertices to pixel coordinates when rendering. Useful for pixel perfect 2D graphics.	`-`
`reflectivity?`	`number` Environment map intensity.	`-`
`refraction?`	`number` Defines the visibility of refraction. Material can refract the same cube map as used for reflections.	`-`
`refractionIndex?`	`number` Defines the index of refraction, i.e. The amount of distortion. The value is calculated as (outerIor / surfaceIor), where inputs are measured indices of refraction, the one around the object and the one of its own surface. In most situations outer medium is air, so outerIor will be approximately 1. Then you only need to do (1.0 / surfaceIor).	`-`
`dispersion?`	`number` The strength of the angular separation of colors (chromatic aberration) transmitting through a volume. Defaults to 0, which is equivalent to no dispersion.	`-`
`shadowCatcher?`	`boolean` When enabled, the material will output accumulated directional shadow value in linear space as the color.	`-`
`specular?`	`string` The specular color of the material. This color value is 3-component (RGB), where each component is between 0 and 1. Defines surface reflection/specular color. Affects specular intensity and tint.	`-`
`specularMap?`	`Texture \| null` The main (primary) diffuse map of the material (default is null).	`-`
`specularMapChannel?`	`string` Color channels of the specular map to use. Can be "r", "g", "b", "a", "rgb" or any swizzled combination.	`-`
`specularMapOffset?`	`[number, number]` Controls the 2D offset of the specular map. Each component is between 0 and 1.	`-`
`specularMapRotation?`	`number` Controls the 2D rotation (in degrees) of the specular map.	`-`
`specularMapTiling?`	`[number, number]` Controls the 2D tiling of the specular map.	`-`
`specularMapUv?`	`number` Specular map UV channel.	`-`
`specularTint?`	`boolean` Multiply specular map and/or specular vertex color by the constant specular value.	`-`
`specularVertexColor?`	`boolean` Use mesh vertex colors for specular. If specularMap or are specularTint are set, they'll be multiplied by vertex colors.	`-`
`specularVertexColorChannel?`	`string` Vertex color channels to use for specular. Can be "r", "g", "b", "a", "rgb" or any swizzled combination.	`-`
`specularityFactor?`	`number` The factor of specular intensity, used to weight the fresnel and specularity. Default is 1.0.	`-`
`specularityFactorMap?`	`Texture \| null` (primary) diffuse map of the material (default is null).	`-`
`specularityFactorMapChannel?`	`string` The channel used by the specularity factor texture to sample from (default is 'a').	`-`
`specularityFactorMapOffset?`	`[number, number]` Controls the 2D offset of the specularity factor map. Each component is between 0 and 1.	`-`
`specularityFactorMapRotation?`	`number` Controls the 2D rotation (in degrees) of the specularity factor map.	`-`
`specularityFactorMapTiling?`	`[number, number]` Controls the 2D tiling of the specularity factor map.	`-`
`specularityFactorMapUv?`	`number` Specularity factor map UV channel.	`-`
`useSheen?`	`boolean` Toggle sheen specular effect on/off.	`-`
`sheen?`	`string` The specular color of the sheen (fabric) microfiber structure. This color value is 3-component (RGB), where each component is between 0 and 1.	`-`
`sheenMap?`	`Texture \| null` ap The main (primary) diffuse map of the material (default is null).	`-`
`sheenMapChannel?`	`string` Color channels of the sheen map to use. Can be "r", "g", "b", "a", "rgb" or any swizzled combination.	`-`
`sheenMapOffset?`	`[number, number]` Controls the 2D offset of the sheen map. Each component is between 0 and 1.	`-`
`sheenMapRotation?`	`number` Controls the 2D rotation (in degrees) of the sheen map.	`-`
`sheenMapTiling?`	`[number, number]` Controls the 2D tiling of the sheen map.	`-`
`sheenMapUv?`	`number` Sheen map UV channel.	`-`
`sheenVertexColor?`	`boolean` Use mesh vertex colors for sheen. If sheen map or sheen tint are set, they'll be multiplied by vertex colors.	`-`
`sheenVertexColorChannel?`	`string`	`-`
`sphereMap?`	`Texture \| null` p The main (primary) diffuse map of the material (default is null).	`-`
`twoSidedLighting?`	`boolean` Calculate proper normals (and therefore lighting) on backfaces.	`-`
`useFog?`	`boolean` Apply fogging (as configured in scene settings)	`-`
`useTonemap?`	`boolean` Apply tonemapping (as configured in Scene#rendering or CameraComponent.rendering ). Defaults to true.	`-`
`useLighting?`	`boolean` Apply lighting	`-`
`useMetalness?`	`boolean` Use metalness properties instead of specular. When enabled, diffuse colors also affect specular instead of the dedicated specular map. This can be used as alternative to specular color to save space. With metalness == 0, the pixel is assumed to be dielectric, and diffuse color is used as normal. With metalness == 1, the pixel is fully metallic, and diffuse color is used as specular color instead.	`-`
`useMetalnessSpecularColor?`	`boolean` When metalness is enabled, use the specular map to apply color tint to specular reflections. at direct angles.	`-`
`useSkybox?`	`boolean` Apply scene skybox as prefiltered environment map	`-`
`userId?`	`string` A unique id the user can assign to the material. The engine internally does not use this for anything, and the user can assign a value to this id for any purpose they like. Defaults to an empty string.	`-`
`id?`	`number`	`-`
`parameters?`	`{}`	`-`
`alphaTest?`	`number` The alpha test reference value to control which fragments are written to the currently active render target based on alpha value. All fragments with an alpha value of less than the alphaTest reference value will be discarded. alphaTest defaults to 0 (all fragments pass).	`-`
`alphaToCoverage?`	`boolean` Enables or disables alpha to coverage (WebGL2 only). When enabled, and if hardware anti-aliasing is on, limited order-independent transparency can be achieved. Quality depends on the number of MSAA samples of the current render target. It can nicely soften edges of otherwise sharp alpha cutouts, but isn't recommended for large area semi-transparent surfaces. Note, that you don't need to enable blending to make alpha to coverage work. It will work without it, just like alphaTest.	`-`
`cull?`	`number` Controls how triangles are culled based on their face direction with respect to the viewpoint. Can be: - CULLFACE_NONE: Do not cull triangles based on face direction. - CULLFACE_BACK: Cull the back faces of triangles (do not render triangles facing away from the view point). - CULLFACE_FRONT: Cull the front faces of triangles (do not render triangles facing towards the view point). Defaults to CULLFACE_BACK.	`-`
`stencilFront?`	`StencilParameters \| null` Stencil parameters for front faces (default is null).	`-`
`stencilBack?`	`StencilParameters \| null` Stencil parameters for back faces (default is null).	`-`
`shaderChunksVersion?`	`string` Sets the version of the shader chunks. This should be a string containing the current engine major and minor version (e.g., '2.8' for engine v2.8.1) and ensures compatibility with the current engine version. When providing custom shader chunks, set this to the latest supported version. If a future engine release no longer supports the specified version, a warning will be issued. In that case, update your shader chunks to match the new format and set this to the latest version accordingly. Returns the version of the shader chunks.	`-`
`chunks?`	`{}`	`-`
`depthBias?`	`number` Sets the offset for the output depth buffer value. Useful for decals to prevent z-fighting. Typically a small negative value (-0.1) is used to render the mesh slightly closer to the camera. Gets the offset for the output depth buffer value.	`-`
`slopeDepthBias?`	`number` Sets the offset for the output depth buffer value based on the slope of the triangle relative to the camera. Gets the offset for the output depth buffer value based on the slope of the triangle relative to the camera.	`-`
`dirty?`	`boolean`	`-`
`redWrite?`	`boolean` Sets whether the red channel is written to the color buffer. If true, the red component of fragments generated by the shader of this material is written to the color buffer of the currently active render target. If false, the red component will not be written. Defaults to true. Gets whether the red channel is written to the color buffer.	`-`
`greenWrite?`	`boolean` Sets whether the green channel is written to the color buffer. If true, the red component of fragments generated by the shader of this material is written to the color buffer of the currently active render target. If false, the green component will not be written. Defaults to true. Gets whether the green channel is written to the color buffer.	`-`
`blueWrite?`	`boolean` Sets whether the blue channel is written to the color buffer. If true, the red component of fragments generated by the shader of this material is written to the color buffer of the currently active render target. If false, the blue component will not be written. Defaults to true. Gets whether the blue channel is written to the color buffer.	`-`
`alphaWrite?`	`boolean` Sets whether the alpha channel is written to the color buffer. If true, the red component of fragments generated by the shader of this material is written to the color buffer of the currently active render target. If false, the alpha component will not be written. Defaults to true. Gets whether the alpha channel is written to the color buffer.	`-`
`blendState?`	`BlendState` Sets the blend state for this material. Controls how fragment shader outputs are blended when being written to the currently active render target. This overwrites blending type set using Material#blendType , and offers more control over blending. Gets the blend state for this material.	`-`
`blendType?`	`number` Sets the blend mode for this material. Controls how fragment shader outputs are blended when being written to the currently active render target. Can be: - BLEND_SUBTRACTIVE: Subtract the color of the source fragment from the destination fragment and write the result to the frame buffer. - BLEND_ADDITIVE: Add the color of the source fragment to the destination fragment and write the result to the frame buffer. - BLEND_NORMAL: Enable simple translucency for materials such as glass. This is equivalent to enabling a source blend mode of BLENDMODE_SRC_ALPHA and a destination blend mode of BLENDMODE_ONE_MINUS_SRC_ALPHA. - BLEND_NONE: Disable blending. - BLEND_PREMULTIPLIED: Similar to BLEND_NORMAL expect the source fragment is assumed to have already been multiplied by the source alpha value. - BLEND_MULTIPLICATIVE: Multiply the color of the source fragment by the color of the destination fragment and write the result to the frame buffer. - BLEND_ADDITIVEALPHA: Same as BLEND_ADDITIVE except the source RGB is multiplied by the source alpha. - BLEND_MULTIPLICATIVE2X: Multiplies colors and doubles the result. - BLEND_SCREEN: Softer version of additive. - BLEND_MIN: Minimum color. - BLEND_MAX: Maximum color. Defaults to BLEND_NONE. Gets the blend mode for this material.	`-`
`depthState?`	`DepthState` Sets the depth state. Note that this can also be done by using Material#depthTest , Material#depthFunc and Material#depthWrite . Gets the depth state.	`-`
`depthTest?`	`boolean` Sets whether depth testing is enabled. If true, fragments generated by the shader of this material are only written to the current render target if they pass the depth test. If false, fragments generated by the shader of this material are written to the current render target regardless of what is in the depth buffer. Defaults to true. Gets whether depth testing is enabled.	`-`
`depthFunc?`	`number` Sets the depth test function. Controls how the depth of new fragments is compared against the current depth contained in the depth buffer. Can be: - FUNC_NEVER: don't draw - FUNC_LESS: draw if new depth < depth buffer - FUNC_EQUAL: draw if new depth == depth buffer - FUNC_LESSEQUAL: draw if new depth <= depth buffer - FUNC_GREATER: draw if new depth > depth buffer - FUNC_NOTEQUAL: draw if new depth != depth buffer - FUNC_GREATEREQUAL: draw if new depth >= depth buffer - FUNC_ALWAYS: always draw Defaults to FUNC_LESSEQUAL. Gets the depth test function.	`-`
`depthWrite?`	`boolean` Sets whether depth writing is enabled. If true, fragments generated by the shader of this material write a depth value to the depth buffer of the currently active render target. If false, no depth value is written. Defaults to true. Gets whether depth writing is enabled.	`-`

Returns

The hooks will return a StandardMaterial instance which can be applied to a Render component.

Name	Type	Default
`material`	`StandardMaterial` The PlayCanvas StandardMaterial instance	`-`

Further examples

Advanced Properties

The StandardMaterial accepts many different properties which can be found here.

import { useMaterial } from '@playcanvas/react/hooks'

function AdvancedMaterial() {
  const material = useMaterial({
    diffuse: 'purple',
    opacity: 0.9,
    metalness: 0.3,
    roughness: 0.4,
    emissive: 'yellow',
    emissiveIntensity: 0.2,
    specular: 'white',
    shininess: 50,
    reflectivity: 0.8,
    clearCoat: 0.5,
    clearCoatRoughness: 0.1
  })
  
  return <Render type="box" material={material} />
}

Material with Textures

You can use textures with the material by loading them with the useTexture hook.

import { useMaterial } from '@playcanvas/react/hooks'
import { useTexture } from '@playcanvas/react/hooks'

function TexturedMaterialExample() {
  const { asset: diffuseMap } = useTexture('diffuse.jpg')
  const { asset: normalMap } = useTexture('normal.jpg')
  const { asset: roughnessMap } = useTexture('roughness.jpg')
  
  const material = useMaterial({
    diffuseMap: diffuseMap?.resource,
    normalMap: normalMap?.resource,
    roughnessMap: roughnessMap?.resource,
    diffuse: 'white',
    metalness: 0.5,
    roughness: 0.5
  })
  
  return <Render type="box" material={material} />
}

You can easily share materials between multiple render components:

import { useMaterial } from '@playcanvas/react/hooks'

function SharedMaterial() {
  const material = useMaterial({
    diffuse: 'orange',
    metalness: 0.7,
    roughness: 0.3
  })
  
  return (
    <div>
      <Render type="box" material={material} />
      <Render type="sphere" material={material} />
      <Render type="cylinder" material={material} />
    </div>
  )
}

useTexture - Load texture assets
Render Component - Use materials with render components
StandardMaterial API - PlayCanvas material documentation

Usage​

Parameters​

Returns​

Further examples​

Advanced Properties​

Material with Textures​

Material Sharing​

Related​