we
    Preparing search index...

    Class PBRMaterial

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _doubleSided _dynamic _id _isDestroy _manager _mipmap _name _readyForGPU _state _transparentMode bindGroup bindGroupLayout bindGroupNumber commands defaultSampler defaultSamplerBindingType defaultTexture2D defaultTexture3D device inputValues insideUniformBundle kind lastUpdaeTime mapList needUpdateuserDefine needUpdateuserDefineAtEnd resourcesGPU scene shtOfMaterialType textures type uniformArrayBufferViews uniformGPUBufferSize uniformPointer uniformPointerCommon uniformPointerCommonSize uniformPointerCommonView UUID

    Accessors

    DoubleSided Dynamic ID LifeState Name

    Methods

    _destroy _writeUniformCommon bindGroupLayoutOfForward bindGroupLayoutOfMSAA bindGroupLayoutOfTT bindGroupOfForward bindGroupOfMSAA bindGroupOfTT checkInsideUniformBundle checkNeedCreateBindGroup checkSampler checkTransparent composeShaderBundle createBindGroup createTexture createUniformCommonPointer createUniformPointer destroy getBindGroup getBindGroupLayout getBlend getBlendMode getEntriesOfBindGroup getEntriesOfBindGroupLayout getFS_TT getGroupAndBindingString getOpacity_DeferColor getOpacity_Forward getOpacity_MSAA getPointerByteSize getReady getTransparent getTransparentMode getUserCode getUserCodeFunction init isDestroy readyForGPU setAlphaOfTT setRootENV setTO update updateSelf writeUniformBuffer writeUniformCommon

    Constructors

    Properties

    _doubleSided

    _doubleSided: boolean = false

    _dynamic

    _dynamic: boolean = false

    是否动态材质 :video材质的External就需要动态材质

    _id

    _id: number

    节点ID node ID

    _isDestroy

    _isDestroy: boolean = false

    _manager

    _manager: undefined | ECSManager<RootGPU>

    _mipmap

    _mipmap: I_mipmap = ...

    mipmap设置

    _name

    _name: string

    节点名称 node name

    _readyForGPU

    _readyForGPU: boolean

    节点是否以及GPU准备好 node is ready of GPU

    _state

    _state: E_lifeState = E_lifeState.unstart

    _transparentMode

    _transparentMode: {
        alphaOfTransparent: boolean;
        alphaParams: I_AlphaTransparentOfMaterial;
        mode: T_transparentMode;
    } = ...

    blending混合的状态interface

    1、如果是undefined，说明不混合 2、如果是object，说明混合

    Type Declaration

    • alphaOfTransparent: boolean

      透明材质是否有alpha透明的部分 ，是否有BLEND。 两种情况： 1、使用统一的透明度（opacity） 2、使用来自texture的透明度（alpha）

    • alphaParams: I_AlphaTransparentOfMaterial
    • mode: T_transparentMode
    bindGroup: {
        opacityDefer:
            | undefined
            | GPUBindGroup
            | { [uuid: string]: GPUBindGroup };
        opacityForward: undefined | GPUBindGroup | { [uuid: string]: GPUBindGroup };
        opacityMSAA: undefined | GPUBindGroup | { [uuid: string]: GPUBindGroup };
        opacityMSAAInfo:
            | undefined
            | GPUBindGroup
            | { [uuid: string]: GPUBindGroup };
        TT: undefined | GPUBindGroup | { [uuid: string]: GPUBindGroup };
    } = ...

    VS bind group 1、 key :string 采样E_materialTypeForBindGroup的值 2、不使用[key in E_materialTypeForBindGroup] 的原因： A、不是所有类型会有用到，防止不必要的创建 B、目前TTP、TTPF暂停中；20260419

    bindGroupLayout: { [key: string]: GPUBindGroupLayout } = {}

    VS bind group layout

    bindGroupNumber: number = 2

    材质的默认绑定组，默认是2

    commands: commmandType[] = []

    材质的更新命令队列 1、有materialManager调用，每帧更新一次。 2、非必须，比如video材质的External就需要

    defaultSampler: GPUSampler

    默认的sampler

    defaultSamplerBindingType: GPUSamplerBindingType = "filtering"

    材质的sampler是否存在，不存在就创建一个。

    defaultTexture2D: Texture

    默认的2D纹理

    defaultTexture3D: CubeTexture

    默认的3D纹理

    device: GPUDevice
    inputValues: IV_PBRMaterial
    insideUniformBundle: I_MaterialUniformTextureBundle[] = ...

    CPU端保存uniform对应数据的Bundle载体。 1、kind同WGSL结构体中kind（也直接对应 arraybuffer） 2、value：对应WGSL结构体中value（也直接对应 arraybuffer） 3、extra：对应WGSL结构体中data1,data2（也直接对应 arraybuffer） 4、textureName：对应@group(2) @binding(x) 中的textureName,使用enum对应 5、sampler：隐性（使用默认或自定义）。对应WGSL结构体中sampler（也直接对应 arraybuffer） 6、samplerBindingType：隐性，同sampler 7、texture: ,

    kind: E_MaterialType
    lastUpdaeTime: number = 0
    mapList: { key: any; map?: string; type: string }[] = []
    needUpdateuserDefine: boolean = false

    是否用户自定义更新函数

    needUpdateuserDefineAtEnd: boolean = false

    是否用户自定义更新函数，在update()函数最后调用

    resourcesGPU: ResourceManagerOfGPU
    scene: Scene
    shtOfMaterialType: {
        opacityDefer: undefined | string;
        opacityForward: undefined | string;
        opacityMSAA: undefined | string;
        opacityMSAAInfo: undefined | string;
        TT: undefined | string;
    }

    材质的SHT模板，key:材质类型，value:SHT模板。

    textures: { [name: string]: Texture }

    纹理 ！！！这里定义的是any，后续各种材质所需要的纹理根据情况，进行declare

    type: string

    节点类型 node type

    uniformArrayBufferViews: {
        albedo: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
        alpha: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
        ao: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
        color: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
        depthmap: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
        emissive: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
        emissiveIntensity: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
        envmap: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
        metallic: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
        normal: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
        roughness: {
            data1: Uint32Array;
            data2: Float32Array;
            kind: Int32Array;
            textureChannel: Int32Array;
            value: Float32Array;
        };
    }

    材质的uniform数据，ArrayBuffer 视图,完整对应WGSL结构体：struct PBRUniformInput 1、每个属性使用相同的结构体布局 2、kind决定数据类型 kind: i32, //uniform 种类,-1=notUse,0=texture,1=value,2=vs 3、textureChannel: 纹理通道， texture_channel: i32,//E_TextureChannel 纹理通道:-1=user define,0=R,1=G,2=B,3=A,4=RG,5=RB,6=RA,7=GB,8=BA,9=RGB,10=RGBA 4、data1: 用于存储额外数据，如：alphaTest,emissiveIntensity data1: f32, //额外数据1 5、data2:f32, 用于存储额外数据，目前未使用 6、value: 用于存储值，如：albedo,metallic,roughness,ao,emissive value: vec4f,//uniform value,按需匹配textureChannel适用

    Type Declaration

    • albedo: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }

      对应于 gltf 2.0 中的baseColorFactor和baseColorTexture

    • alpha: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }
    • ao: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }

      对应glTF 2.0 中的 occlusionTexture https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#reference-material-occlusiontextureinfo 遮挡值从红色通道（R 通道）进行线性采样 strength 强度:data1,f32 texCoord 纹理坐标:data2,i32,0=uv0,1=uv1

    • color: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }
    • depthmap: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }
    • emissive: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }

      对应glTF 2.0 中的 emissiveTexture https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#reference-textureinfo texCoord 纹理坐标:data2,i32,0=uv0,1=uv1

    • emissiveIntensity: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }

      todo：20260508 对应glTF 2.0 中的 emissiveFactor，只有数值，没有纹理 https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#_material_emissivefactor 默认值为 [0,0,0]

    • envmap: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }
    • metallic: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }

      对应于 gltf 2.0 中的metallicFactor和 metallicRoughnessTexture （金属粗糙度纹理，gltf2.0 中是同一个纹理） 金属粗糙度纹理。金属度值从 B 通道采样

    • normal: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }

      对应glTF 2.0 中的 normalTexture https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#reference-material-normaltextureinfo texCoord 纹理坐标:data2,i32,0=uv0,1=uv1 scale 缩放:data1,f32，默认1.0 scaledNormal = normalize( * 2.0 - 1.0) * vec3(, , 1.0);

    • roughness: {
          data1: Uint32Array;
          data2: Float32Array;
          kind: Int32Array;
          textureChannel: Int32Array;
          value: Float32Array;
      }

      对应于 gltf 2.0 中的roughnessFactor和 metallicRoughnessTexture 粗糙度值从 G 通道采样

    uniformGPUBufferSize: number = 352

    材质的uniform数据，ArrayBuffer 大小

    uniformPointer: I_pointerStruct

    材质的uniform Buffer 的指针，用于快速访问
    1、PBR、phone需要使用

    uniformPointerCommon: I_pointerStruct

    common的uniform Buffer 的指针，用于快速访问

    uniformPointerCommonSize: number = 256
    uniformPointerCommonView: {
        accept_light: Int32Array;
        accept_shadow: Int32Array;
        barycentric_coordinates: {
            opacity: Float32Array;
            thickness: Float32Array;
            triangle: Int32Array;
            wireframe: Int32Array;
        };
        clip: {
            activate: Int32Array;
            inverse_side: Int32Array;
            inverse_x: Int32Array;
            inverse_y: Int32Array;
            inverse_z: Int32Array;
            plane_x: Float32Array;
            plane_y: Float32Array;
            plane_z: Float32Array;
            plane1: Float32Array;
            sdf: {
                invert_model_matrix: Float32Array;
                kind: Uint32Array;
                parameter: Float32Array;
                round: Int32Array;
                round_radius: Float32Array;
            };
        };
        color: Float32Array;
        depth_bias: { depth_bias: Float32Array; slope_scale: Float32Array };
        shadow_bias: Float32Array;
        transparent: {
            alpha_transparent: {
                alpha_cut_off: Float32Array;
                blend_mode: Uint32Array;
                opacity: Float32Array;
            };
            transparent_mode: Int32Array;
        };
        uv: {
            activate: Int32Array;
            offset: Float32Array;
            rotate: Float32Array;
            scale: Float32Array;
            uv_index: Int32Array;
        };
    }
    UUID: string

    节点UUID node UUID

    Accessors

    Methods

    _destroy

    _writeUniformCommon

    • 检查insideUniformBundle是否符合要求 1、如果是纹理，必须有texture 2、如果是值，必须有value

      todo： 1、envMap A、envMap需要在system中实现； B、使用IBL，system和shader目前都未实现；

      Returns void

    • 获取混合模式： writeUniformCommon()中调用

      Returns number

      number 混合模式 0、预乘标准混合 todo：20260517 1、 为A-Buffer设计，目前默认0=预乘标准混合。 2、其他混合模式，目前未设计与实现

    • 材质是否已经准备好， 判断两个值， 1、this._readyForGPU：延迟GPU device相关的资源建立需要延迟。 需要其顶级使用者被加入到stage中后，才能开始。 2、this._state：材质自身的初始化是否完成。

      Returns E_lifeState

      true：可以使用，false：需要等待。

    • 初始化材质 一、两种初始化模式 1、程序化控制模式： A、初始化时可以不传递scene对象，只关注材质参数。 B、scene传递和与其相关的参数在entity的init中，通过调用_material.init() 来初始化。 2、加载场景模式（编辑器，加载）： A、初始化时需要传递scene对象。 B、然后使用 await xxx.init(scene) 来初始化,有异步的操作。 二、通过判断this._state，来判断是否已经初始化完成。 三、异步操作说明 1、派生类的redadyForGPU()会有异步操作； 2、texture的加载，url等

      Parameters

      • scene: Scene

        场景对象

      Returns Promise<any>

    • 正常更新，从上到下

      Parameters

      • clock: Clock

        Clock 时钟

      • updateSelftFN: boolean = true

        是否调用自身的updateSelf(),默认=true 此参数可以方便子类重载时，决定调用的updateSelf()的时间顺序或是否调用updateSelft()

      • updateAtEndFN: boolean = true

      Returns boolean

    • 将this.insideUniformBundle数据写入uniform buffer 1、遍历insideUniformBundle，写入uniform buffer（ArrayBuffer） 2、创建uniformGPUBuffer，并写入

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods