Nano WebGPU API - v0.11.0
    Preparing search index...

    Interface ShaderMaterialOptions

    Configuration options utilized when creating a new custom ShaderMaterial.

    interface ShaderMaterialOptions {
        albedoColor?: ColorLike;
        albedoTexture?: string | Texture;
        aoIntensity?: number;
        aoTexture?: string | Texture;
        cullMode?: CullMode;
        depthCompare?: GPUCompareFunction;
        depthWriteEnabled?: boolean;
        doubleSided?: boolean;
        emissiveColor?: ColorLike;
        emissiveStrength?: number;
        emissiveTexture?: string | Texture;
        metallic?: number;
        metallicTexture?: string | Texture;
        nextPass?: Material;
        normalScale?: number;
        normalTexture?: string | Texture;
        opacity?: number;
        ormTexture?: string | Texture;
        parameters?: ShaderParameters;
        roughness?: number;
        roughnessTexture?: string | Texture;
        shaderCode: string;
        texture?: string | Texture;
        transparent?: boolean;
        uniforms?: ShaderParameters;
    }

    Hierarchy (View Summary)

    Index

    Properties

    albedoColor? albedoTexture? aoIntensity? aoTexture? cullMode? depthCompare? depthWriteEnabled? doubleSided? emissiveColor? emissiveStrength? emissiveTexture? metallic? metallicTexture? nextPass? normalScale? normalTexture? opacity? ormTexture? parameters? roughness? roughnessTexture? shaderCode texture? transparent? uniforms?

    Properties

    albedoColor?: ColorLike

    Solid base color value or hex string representation. Defaults to white.

    albedoTexture?: string | Texture

    Map containing surface color data, or file path.

    aoIntensity?: number

    Intensity multiplier of ambient occlusion shadows. Defaults to 1.0.

    aoTexture?: string | Texture

    Map containing ambient occlusion details, or file path.

    cullMode?: CullMode

    Custom back-face/front-face/none culling mode selection.

    depthCompare?: GPUCompareFunction

    Depth check comparison function. Defaults to "less".

    depthWriteEnabled?: boolean

    Toggle depth buffer writes. Defaults to true.

    doubleSided?: boolean

    When true, disables face culling so back and front polygons are rendered.

    emissiveColor?: ColorLike

    Solid emissive color value or hex string representation. Defaults to black.

    emissiveStrength?: number

    Emissive intensity multiplier (supports values > 1 for HDR emission). Defaults to 1.0.

    emissiveTexture?: string | Texture

    Map containing emissive light data, or file path.

    metallic?: number

    Surface metallic conduction microfacet value. Defaults to 0.0.

    metallicTexture?: string | Texture

    Map detailing metallic coefficients, or file path.

    nextPass?: Material

    Secondary material pass rendered immediately after this material.

    normalScale?: number

    Scaling factor applied to normal tangent values. Defaults to 1.0.

    normalTexture?: string | Texture

    Tangent-space normal map detailing high-frequency surface folds, or file path.

    opacity?: number

    Surface opacity level (alpha). Automatically handles transparent rendering and depth buffer updates.

    ormTexture?: string | Texture

    Map containing packed Ambient Occlusion, Roughness, and Metallic (ORM) values, or file path.

    parameters?: ShaderParameters

    Configurable parameters passed to the shader via @group(3) @binding(0). Packed sequentially as 32-bit floats. Layout must align perfectly with target WGSL structures.

    roughness?: number

    Surface roughness microfacet scattering coefficient. Defaults to 0.5.

    roughnessTexture?: string | Texture

    Map detailing roughness values, or file path.

    shaderCode: string

    WGSL custom shader code containing vs_main and fs_main entries.

    texture?: string | Texture

    Shorthand alias for albedoTexture.

    transparent?: boolean

    If true, the material supports alpha transparency during rendering blending passes.

    uniforms?: ShaderParameters

    Legacy alias for parameters.

    Settings

    Member Visibility

    On This Page

    Properties