RedGPU API v4.0.0-Alpha

---

RedGPU API / RedGPU / Material / PBRMaterial

Class: PBRMaterial

Defined in: src/material/pbrMaterial/PBRMaterial.ts:171

PBR (Physically Based Rendering) material class.

Inherits from ABitmapBaseMaterial to create a material for PBR rendering.

Extends

• ABitmapBaseMaterial

Constructors

Constructor

new PBRMaterial(redGPUContext): PBRMaterial

Defined in: src/material/pbrMaterial/PBRMaterial.ts:695

PBRMaterial constructor

Parameters

Parameter	Type	Description
redGPUContext	RedGPUContext	RedGPUContext instance

Returns

PBRMaterial

Inherited from

ABitmapBaseMaterial.constructor

Properties

__packingList

__packingList: any[]

Defined in: src/material/core/ABitmapBaseMaterial.ts:22

List of callbacks called when updating the pipeline

Inherited from

ABitmapBaseMaterial.__packingList

---

alphaBlend

alphaBlend: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:191

Alpha blending mode

---

baseColorFactor

baseColorFactor: number[]

Defined in: src/material/pbrMaterial/PBRMaterial.ts:212

Base color factor

---

baseColorTexture

baseColorTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:202

Base color texture

---

baseColorTexture_texCoord_index

baseColorTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:217

Base color texture UV index

---

baseColorTextureSampler

baseColorTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:207

Base color texture sampler

---

cutOff

cutOff: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:186

Alpha cutoff value

---

dirtyPipeline

dirtyPipeline: boolean = false

Defined in: src/material/core/ABaseMaterial.ts:62

Pipeline dirty status flag

Inherited from

ABitmapBaseMaterial.dirtyPipeline

---

doubleSided

doubleSided: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:661

Whether it is double-sided

---

emissiveFactor

emissiveFactor: number[]

Defined in: src/material/pbrMaterial/PBRMaterial.ts:601

Emissive factor

---

emissiveStrength

emissiveStrength: number[]

Defined in: src/material/pbrMaterial/PBRMaterial.ts:606

Emissive strength

---

emissiveTexture

emissiveTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:586

Emissive texture

---

emissiveTexture_texCoord_index

emissiveTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:596

Emissive texture UV index

---

emissiveTextureSampler

emissiveTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:591

Emissive texture sampler

---

gpuRenderInfo

gpuRenderInfo: FragmentGPURenderInfo

Defined in: src/material/core/ABaseMaterial.ts:57

Fragment GPU render info object

Inherited from

ABitmapBaseMaterial.gpuRenderInfo

---

KHR_anisotropyRotation

KHR_anisotropyRotation: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:299

Anisotropy rotation

---

KHR_anisotropyStrength

KHR_anisotropyStrength: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:294

Anisotropy strength

---

KHR_anisotropyTexture

KHR_anisotropyTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:304

Anisotropy texture

---

KHR_anisotropyTexture_texCoord_index

KHR_anisotropyTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:314

Anisotropy texture UV index

---

KHR_anisotropyTextureSampler

KHR_anisotropyTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:309

Anisotropy texture sampler

---

KHR_attenuationColor

KHR_attenuationColor: number[]

Defined in: src/material/pbrMaterial/PBRMaterial.ts:408

Attenuation color

---

KHR_attenuationDistance

KHR_attenuationDistance: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:403

Attenuation distance

---

KHR_clearcoatFactor

KHR_clearcoatFactor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:233

Clearcoat factor

---

KHR_clearcoatNormalScale

KHR_clearcoatNormalScale: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:228

Clearcoat normal scale

---

KHR_clearcoatNormalTexture

KHR_clearcoatNormalTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:248

Clearcoat normal texture

---

KHR_clearcoatNormalTexture_texCoord_index

KHR_clearcoatNormalTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:278

Clearcoat normal texture UV index

---

KHR_clearcoatNormalTextureSampler

KHR_clearcoatNormalTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:263

Clearcoat normal texture sampler

---

KHR_clearcoatRoughnessFactor

KHR_clearcoatRoughnessFactor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:238

Clearcoat roughness factor

---

KHR_clearcoatRoughnessTexture

KHR_clearcoatRoughnessTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:253

Clearcoat roughness texture

---

KHR_clearcoatRoughnessTexture_texCoord_index

KHR_clearcoatRoughnessTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:283

Clearcoat roughness texture UV index

---

KHR_clearcoatRoughnessTextureSampler

KHR_clearcoatRoughnessTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:268

Clearcoat roughness texture sampler

---

KHR_clearcoatTexture

KHR_clearcoatTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:243

Clearcoat texture

---

KHR_clearcoatTexture_texCoord_index

KHR_clearcoatTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:273

Clearcoat texture UV index

---

KHR_clearcoatTextureSampler

KHR_clearcoatTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:258

Clearcoat texture sampler

---

KHR_diffuseTransmissionColorFactor

KHR_diffuseTransmissionColorFactor: [number, number, number]

Defined in: src/material/pbrMaterial/PBRMaterial.ts:357

Diffuse transmission color factor

---

KHR_diffuseTransmissionColorTexture

KHR_diffuseTransmissionColorTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:377

Diffuse transmission color texture

---

KHR_diffuseTransmissionColorTexture_texCoord_index

KHR_diffuseTransmissionColorTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:387

Diffuse transmission color texture UV index

---

KHR_diffuseTransmissionColorTextureSampler

KHR_diffuseTransmissionColorTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:382

Diffuse transmission color texture sampler

---

KHR_diffuseTransmissionFactor

KHR_diffuseTransmissionFactor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:352

Diffuse transmission factor

---

KHR_diffuseTransmissionTexture

KHR_diffuseTransmissionTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:362

Diffuse transmission texture

---

KHR_diffuseTransmissionTexture_texCoord_index

KHR_diffuseTransmissionTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:372

Diffuse transmission texture UV index

---

KHR_diffuseTransmissionTextureSampler

KHR_diffuseTransmissionTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:367

Diffuse transmission texture sampler

---

KHR_dispersion

KHR_dispersion: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:668

Whether to use KHR_dispersion extension

---

KHR_iridescenceFactor

KHR_iridescenceFactor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:507

Iridescence factor

---

KHR_iridescenceIor

KHR_iridescenceIor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:512

Iridescence IOR

---

KHR_iridescenceTexture

KHR_iridescenceTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:527

Iridescence texture

---

KHR_iridescenceTextureSampler

KHR_iridescenceTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:532

Iridescence texture sampler

---

KHR_iridescenceThicknessMaximum

KHR_iridescenceThicknessMaximum: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:522

Iridescence thickness maximum

---

KHR_iridescenceThicknessMinimum

KHR_iridescenceThicknessMinimum: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:517

Iridescence thickness minimum

---

KHR_iridescenceThicknessTexture

KHR_iridescenceThicknessTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:537

Iridescence thickness texture

---

KHR_iridescenceThicknessTextureSampler

KHR_iridescenceThicknessTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:542

Iridescence thickness texture sampler

---

KHR_materials_ior

KHR_materials_ior: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:554

KHR_materials_ior extension IOR value

---

KHR_sheenColorFactor

KHR_sheenColorFactor: [number, number, number]

Defined in: src/material/pbrMaterial/PBRMaterial.ts:434

Sheen color factor

---

KHR_sheenColorTexture

KHR_sheenColorTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:444

Sheen color texture

---

KHR_sheenColorTextureSampler

KHR_sheenColorTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:449

Sheen color texture sampler

---

KHR_sheenRoughnessFactor

KHR_sheenRoughnessFactor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:439

Sheen roughness factor

---

KHR_sheenRoughnessTexture

KHR_sheenRoughnessTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:454

Sheen roughness texture

---

KHR_sheenRoughnessTextureSampler

KHR_sheenRoughnessTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:459

Sheen roughness texture sampler

---

KHR_specularColorFactor

KHR_specularColorFactor: [number, number, number]

Defined in: src/material/pbrMaterial/PBRMaterial.ts:475

Specular color factor

---

KHR_specularColorTexture

KHR_specularColorTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:490

Specular color texture

---

KHR_specularColorTextureSampler

KHR_specularColorTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:495

Specular color texture sampler

---

KHR_specularFactor

KHR_specularFactor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:470

Specular factor

---

KHR_specularTexture

KHR_specularTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:480

Specular texture

---

KHR_specularTextureSampler

KHR_specularTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:485

Specular texture sampler

---

KHR_thicknessFactor

KHR_thicknessFactor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:398

Thickness factor

---

KHR_thicknessTexture

KHR_thicknessTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:413

Thickness texture

---

KHR_thicknessTexture_texCoord_index

KHR_thicknessTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:423

Thickness texture UV index

---

KHR_thicknessTextureSampler

KHR_thicknessTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:418

Thickness texture sampler

---

KHR_transmissionFactor

KHR_transmissionFactor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:326

Transmission factor

---

KHR_transmissionTexture

KHR_transmissionTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:331

Transmission texture

---

KHR_transmissionTexture_texCoord_index

KHR_transmissionTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:341

Transmission texture UV index

---

KHR_transmissionTextureSampler

KHR_transmissionTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:336

Transmission texture sampler

---

metallicFactor

metallicFactor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:648

Metallic factor

---

metallicRoughnessTexture

metallicRoughnessTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:633

Metallic-Roughness texture

---

metallicRoughnessTexture_texCoord_index

metallicRoughnessTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:643

Metallic-Roughness texture UV index

---

metallicRoughnessTextureSampler

metallicRoughnessTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:638

Metallic-Roughness texture sampler

---

normalScale

normalScale: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:560

Normal scale

---

normalTexture

normalTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:570

Normal texture

---

normalTexture_texCoord_index

normalTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:580

Normal texture UV index

---

normalTextureSampler

normalTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:575

Normal texture sampler

---

occlusionStrength

occlusionStrength: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:627

Occlusion strength

---

occlusionTexture

occlusionTexture: BitmapTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:612

Occlusion texture

---

occlusionTexture_texCoord_index

occlusionTexture_texCoord_index: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:622

Occlusion texture UV index

---

occlusionTextureSampler

occlusionTextureSampler: Sampler

Defined in: src/material/pbrMaterial/PBRMaterial.ts:617

Occlusion texture sampler

---

opacity

opacity: number

Defined in: src/material/core/ABaseMaterial.ts:23

Material opacity (0~1)

Inherited from

ABitmapBaseMaterial.opacity

---

roughnessFactor

roughnessFactor: number

Defined in: src/material/pbrMaterial/PBRMaterial.ts:653

Roughness factor

---

tint

tint: ColorRGBA

Defined in: src/material/core/ABaseMaterial.ts:28

Material tint color (RGBA)

Inherited from

ABitmapBaseMaterial.tint

---

transparent

transparent: boolean = false

Defined in: src/material/core/ABaseMaterial.ts:67

Whether the material is transparent

Inherited from

ABitmapBaseMaterial.transparent

---

use2PathRender

use2PathRender: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:196

Whether to use 2-pass rendering

Inherited from

ABitmapBaseMaterial.use2PathRender

---

useCutOff

useCutOff: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:181

Whether to use alpha cutoff

---

useKHR_materials_anisotropy

useKHR_materials_anisotropy: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:289

Whether to use KHR_materials_anisotropy extension

---

useKHR_materials_clearcoat

useKHR_materials_clearcoat: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:223

Whether to use KHR_materials_clearcoat extension

---

useKHR_materials_diffuse_transmission

useKHR_materials_diffuse_transmission: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:347

Whether to use KHR_materials_diffuse_transmission extension

---

useKHR_materials_iridescence

useKHR_materials_iridescence: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:502

Whether to use KHR_materials_iridescence extension

---

useKHR_materials_sheen

useKHR_materials_sheen: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:429

Whether to use KHR_materials_sheen extension

---

useKHR_materials_specular

useKHR_materials_specular: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:465

Whether to use KHR_materials_specular extension

---

useKHR_materials_transmission

useKHR_materials_transmission: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:321

Whether to use KHR_materials_transmission extension

---

useKHR_materials_unlit

useKHR_materials_unlit: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:548

Whether to use KHR_materials_unlit extension

---

useKHR_materials_volume

useKHR_materials_volume: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:393

Whether to use KHR_materials_volume extension

---

useNormalTexture

useNormalTexture: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:565

Whether to use normal texture

---

useTint

useTint: boolean

Defined in: src/material/core/ABaseMaterial.ts:33

Whether to use tint color

Inherited from

ABitmapBaseMaterial.useTint

---

useVertexColor

useVertexColor: boolean

Defined in: src/material/pbrMaterial/PBRMaterial.ts:176

Whether to use vertex color

Accessors

blendAlphaState

Get Signature

get blendAlphaState(): BlendState

Defined in: src/material/core/ABaseMaterial.ts:289

Returns the material's alpha blend state object

Returns

BlendState

Inherited from

ABitmapBaseMaterial.blendAlphaState

---

blendColorState

Get Signature

get blendColorState(): BlendState

Defined in: src/material/core/ABaseMaterial.ts:281

Returns the material's color blend state object

Returns

BlendState

Inherited from

ABitmapBaseMaterial.blendColorState

---

cacheKey

Get Signature

get cacheKey(): string

Defined in: src/resources/core/ResourceBase.ts:57

Returns the cache key.

Returns

string

Set Signature

set cacheKey(value): void

Defined in: src/resources/core/ResourceBase.ts:65

Sets the cache key.

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

ABitmapBaseMaterial.cacheKey

---

FRAGMENT_BIND_GROUP_DESCRIPTOR_NAME

Get Signature

get FRAGMENT_BIND_GROUP_DESCRIPTOR_NAME(): string

Defined in: src/material/core/ABaseMaterial.ts:257

Returns the fragment bind group descriptor name.

Returns

string

Inherited from

ABitmapBaseMaterial.FRAGMENT_BIND_GROUP_DESCRIPTOR_NAME

---

FRAGMENT_SHADER_MODULE_NAME

Get Signature

get FRAGMENT_SHADER_MODULE_NAME(): string

Defined in: src/material/core/ABaseMaterial.ts:249

Returns the fragment shader module name.

Returns

string

Inherited from

ABitmapBaseMaterial.FRAGMENT_SHADER_MODULE_NAME

---

gpuDevice

Get Signature

get gpuDevice(): GPUDevice

Defined in: src/resources/core/ResourceBase.ts:106

Returns the associated GPU device.

Returns

GPUDevice

Inherited from

ABitmapBaseMaterial.gpuDevice

---

MODULE_NAME

Get Signature

get MODULE_NAME(): string

Defined in: src/material/core/ABaseMaterial.ts:241

Returns the material module name.

Returns

string

Inherited from

ABitmapBaseMaterial.MODULE_NAME

---

name

Get Signature

get name(): string

Defined in: src/resources/core/ResourceBase.ts:81

Returns the name of the instance. If no name exists, it is generated using the class name and ID.

Returns

string

Set Signature

set name(value): void

Defined in: src/resources/core/ResourceBase.ts:90

Sets the name of the instance.

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

ABitmapBaseMaterial.name

---

packedKHR_clearcoatTexture_transmission

Get Signature

get packedKHR_clearcoatTexture_transmission(): PackedTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:723

Returns packed texture for Clearcoat and Transmission

Returns

PackedTexture

---

packedKHR_diffuse_transmission

Get Signature

get packedKHR_diffuse_transmission(): PackedTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:758

Returns packed texture for Diffuse Transmission

Returns

PackedTexture

---

packedKHR_iridescence

Get Signature

get packedKHR_iridescence(): PackedTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:731

Returns packed texture for Iridescence

Returns

PackedTexture

---

packedKHR_sheen

Get Signature

get packedKHR_sheen(): PackedTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:747

Returns packed texture for Sheen

Returns

PackedTexture

---

packedORMTexture

Get Signature

get packedORMTexture(): PackedTexture

Defined in: src/material/pbrMaterial/PBRMaterial.ts:739

Returns packed texture for ORM (Occlusion, Roughness, Metallic)

Returns

PackedTexture

---

redGPUContext

Get Signature

get redGPUContext(): RedGPUContext

Defined in: src/resources/core/ResourceBase.ts:114

Returns the RedGPUContext instance.

Returns

RedGPUContext

Inherited from

ABitmapBaseMaterial.redGPUContext

---

resourceManagerKey

Get Signature

get resourceManagerKey(): string

Defined in: src/resources/core/ResourceBase.ts:73

Returns the resource manager key.

Returns

string

Inherited from

ABitmapBaseMaterial.resourceManagerKey

---

STORAGE_STRUCT

Get Signature

get STORAGE_STRUCT(): any

Defined in: src/material/core/ABaseMaterial.ts:265

Returns the shader storage structure information.

Returns

any

Inherited from

ABitmapBaseMaterial.STORAGE_STRUCT

---

tintBlendMode

Get Signature

get tintBlendMode(): string

Defined in: src/material/core/ABaseMaterial.ts:205

Returns the tint blend mode name.

Returns

string

Tint blend mode name

Set Signature

set tintBlendMode(value): void

Defined in: src/material/core/ABaseMaterial.ts:220

Sets the tint blend mode.

Parameters

Parameter	Type	Description
value	"SUBTRACT" | "NORMAL" | "MULTIPLY" | "LIGHTEN" | "SCREEN" | "LINEAR_DODGE" | "DARKEN" | "OVERLAY" | "COLOR_DODGE" | "COLOR_BURN" | "HARD_LIGHT" | "SOFT_LIGHT" | "DIFFERENCE" | "EXCLUSION" | "DIVIDE" | "VIVID_LIGHT" | "LINEAR_BURN" | "PIN_LIGHT" | "SATURATION" | "HUE" | "LUMINOSITY" | "COLOR" | "NEGATION" | TINT_BLEND_MODE	Tint blend mode value or key

Returns

void

Inherited from

ABitmapBaseMaterial.tintBlendMode

---

UNIFORM_STRUCT

Get Signature

get UNIFORM_STRUCT(): any

Defined in: src/material/core/ABaseMaterial.ts:273

Returns the shader uniforms structure information.

Returns

any

Inherited from

ABitmapBaseMaterial.UNIFORM_STRUCT

---

uuid

Get Signature

get uuid(): string

Defined in: src/resources/core/ResourceBase.ts:98

Returns the UUID.

Returns

string

Inherited from

ABitmapBaseMaterial.uuid

---

writeMaskState

Get Signature

get writeMaskState(): number

Defined in: src/material/core/ABaseMaterial.ts:297

Returns the material's writeMask state

Returns

number

Set Signature

set writeMaskState(value): void

Defined in: src/material/core/ABaseMaterial.ts:308

Sets the material's writeMask state

Parameters

Parameter	Type	Description
value	number	GPUFlagsConstant value

Returns

void

Inherited from

ABitmapBaseMaterial.writeMaskState

Methods

__addDirtyPipelineListener()

__addDirtyPipelineListener(listener): void

Defined in: src/resources/core/ResourceBase.ts:125

Adds a listener function to be called when the pipeline becomes dirty.

Parameters

Parameter	Type	Description
listener	() => void	Listener function

Returns

void

Inherited from

ABitmapBaseMaterial.__addDirtyPipelineListener

---

__fireListenerList()

__fireListenerList(resetList?): void

Defined in: src/resources/core/ResourceBase.ts:152

Fires the registered dirty listeners.

Parameters

Parameter	Type	Default value	Description
resetList	boolean	false	Whether to reset the listener list after firing (default: false)

Returns

void

Inherited from

ABitmapBaseMaterial.__fireListenerList

---

__removeDirtyPipelineListener()

__removeDirtyPipelineListener(listener): void

Defined in: src/resources/core/ResourceBase.ts:137

Removes a dirty pipeline listener.

Parameters

Parameter	Type	Description
listener	() => void	Listener function to be removed

Returns

void

Inherited from

ABitmapBaseMaterial.__removeDirtyPipelineListener

---

_updateBaseProperty()

protected _updateBaseProperty(): void

Defined in: src/material/core/ABaseMaterial.ts:463

Reflects basic material properties such as uniforms/color/tint to the uniform buffer.

Returns

void

Inherited from

ABitmapBaseMaterial._updateBaseProperty

---

_updateFragmentState()

protected _updateFragmentState(): void

Defined in: src/material/core/ABaseMaterial.ts:351

Updates fragment shader bind group/uniform/texture/sampler states.

Returns

void

Inherited from

ABitmapBaseMaterial._updateFragmentState

---

getFragmentRenderState()

getFragmentRenderState(entryPoint?): GPUFragmentState

Defined in: src/material/core/ABaseMaterial.ts:431

Returns the GPU fragment render state object.

Parameters

Parameter	Type	Default value	Description
entryPoint	string	'main'	Shader entry point (default: 'main')

Returns

GPUFragmentState

GPU fragment state

Inherited from

ABitmapBaseMaterial.getFragmentRenderState

---

getGPUResourceSampler()

getGPUResourceSampler(sampler): GPUSampler

Defined in: src/material/core/ABaseMaterial.ts:488

Returns the GPU sampler from the Sampler object.

Parameters

Parameter	Type	Description
sampler	Sampler	Sampler object

Returns

GPUSampler

GPUSampler instance

Inherited from

ABitmapBaseMaterial.getGPUResourceSampler

---

initGPURenderInfos()

initGPURenderInfos(): void

Defined in: src/material/core/ABaseMaterial.ts:316

Initializes GPU render pipeline info and uniform buffer.

Returns

void

Inherited from

ABitmapBaseMaterial.initGPURenderInfos

---

setupPackedKHR_clearcoatTexture_transmission()

setupPackedKHR_clearcoatTexture_transmission(): Promise<void>

Defined in: src/material/pbrMaterial/PBRMaterial.ts:800

Setup Clearcoat and Transmission texture packing

Returns

Promise<void>

---

setupPackedKHR_diffuse_transmission()

setupPackedKHR_diffuse_transmission(): Promise<void>

Defined in: src/material/pbrMaterial/PBRMaterial.ts:887

Setup Diffuse Transmission texture packing

Returns

Promise<void>

---

setupPackedKHR_iridescence()

setupPackedKHR_iridescence(): Promise<void>

Defined in: src/material/pbrMaterial/PBRMaterial.ts:951

Setup Iridescence texture packing

Returns

Promise<void>

---

setupPackedKHR_sheen()

setupPackedKHR_sheen(): Promise<void>

Defined in: src/material/pbrMaterial/PBRMaterial.ts:919

Setup Sheen texture packing

Returns

Promise<void>

---

setupPackORMTexture()

setupPackORMTexture(): Promise<void>

Defined in: src/material/pbrMaterial/PBRMaterial.ts:769

Setup ORM (Occlusion, Roughness, Metallic) texture packing

Returns

Promise<void>

---

updateSampler()

updateSampler(prevSampler, newSampler): void

Defined in: src/material/core/ABitmapBaseMaterial.ts:75

Manages sampler object changes and DirtyPipeline listeners.

Parameters

Parameter	Type	Description
prevSampler	Sampler	Previous sampler
newSampler	Sampler	New sampler

Returns

void

Inherited from

ABitmapBaseMaterial.updateSampler

---

updateTexture()

updateTexture(prevTexture, texture): void

Defined in: src/material/core/ABitmapBaseMaterial.ts:59

Manages texture object changes and DirtyPipeline listeners.

Parameters

Parameter	Type	Description
prevTexture	ANoiseTexture | BitmapTexture | CubeTexture | HDRTexture	Previous texture (BitmapTexture
texture	ANoiseTexture | BitmapTexture | CubeTexture | HDRTexture	New texture (BitmapTexture

Returns

void

Inherited from

ABitmapBaseMaterial.updateTexture