Class: GUIMaterial ​

material used in rendering GUI

Hierarchy ​

• Material

  ↳ GUIMaterial

Constructors ​

• constructor

Properties ​

• name
• instanceID
• enable

Accessors ​

• envMap
• shadowMap
• baseMap
• normalMap
• emissiveMap
• irradianceMap
• irradianceDepthMap
• depthCompare
• defaultPass
• doubleSide
• castShadow
• blendMode
• transparent
• cullMode

Methods ​

• setLimitVertex
• setGUISolution
• setScissorRect
• setScissorEnable
• setScissorCorner
• setScreenSize
• setTextures
• hasPass
• getPass
• getAllPass
• addPass
• removePass
• clone
• destroy

Constructors ​

constructor ​

• new GUIMaterial(space)

Parameters ​

Overrides ​

Material.constructor

Defined in ​

src/components/gui/core/GUIMaterial.ts:23

Properties ​

name ​

• name: string

name of this material

Inherited from ​

Material.name

Defined in ​

src/materials/Material.ts:11

instanceID ​

• instanceID: string

Material Unique Identifier

Inherited from ​

Material.instanceID

Defined in ​

src/materials/Material.ts:17

enable ​

• enable: boolean = true

Inherited from ​

Material.enable

Defined in ​

src/materials/Material.ts:19

Accessors ​

envMap ​

• set envMap(texture): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:129

shadowMap ​

• set shadowMap(texture): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:130

baseMap ​

• set baseMap(texture): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:131

normalMap ​

• set normalMap(value): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:132

emissiveMap ​

• set emissiveMap(value): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:133

irradianceMap ​

• set irradianceMap(value): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:134

irradianceDepthMap ​

• set irradianceDepthMap(value): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:135

depthCompare ​

• get depthCompare(): GPUCompareFunction

Returns ​

GPUCompareFunction

Inherited from ​

Material.depthCompare

Defined in ​

src/materials/Material.ts:31

• set depthCompare(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.depthCompare

Defined in ​

src/materials/Material.ts:35

defaultPass ​

• get defaultPass(): RenderShader

Returns ​

RenderShader

Inherited from ​

Material.defaultPass

Defined in ​

src/materials/Material.ts:40

• set defaultPass(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.defaultPass

Defined in ​

src/materials/Material.ts:44

doubleSide ​

• get doubleSide(): boolean

Returns ​

boolean

Inherited from ​

Material.doubleSide

Defined in ​

src/materials/Material.ts:49

• set doubleSide(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.doubleSide

Defined in ​

src/materials/Material.ts:53

castShadow ​

• get castShadow(): boolean

Returns ​

boolean

Inherited from ​

Material.castShadow

Defined in ​

src/materials/Material.ts:57

• set castShadow(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.castShadow

Defined in ​

src/materials/Material.ts:62

blendMode ​

• get blendMode(): BlendMode

Returns ​

BlendMode

Inherited from ​

Material.blendMode

Defined in ​

src/materials/Material.ts:67

• set blendMode(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.blendMode

Defined in ​

src/materials/Material.ts:72

transparent ​

• get transparent(): boolean

Returns ​

boolean

Inherited from ​

Material.transparent

Defined in ​

src/materials/Material.ts:78

• set transparent(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.transparent

Defined in ​

src/materials/Material.ts:83

cullMode ​

• get cullMode(): GPUCullMode

Returns ​

GPUCullMode

Inherited from ​

Material.cullMode

Defined in ​

src/materials/Material.ts:91

• set cullMode(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.cullMode

Defined in ​

src/materials/Material.ts:96

Methods ​

setLimitVertex ​

▸ setLimitVertex(vertexCount): void

Write effective vertex count (vertex index < vertexCount)

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:58

setGUISolution ​

▸ setGUISolution(value, pixelRatio): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:62

setScissorRect ​

▸ setScissorRect(left, bottom, right, top): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:67

setScissorEnable ​

▸ setScissorEnable(value): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:73

setScissorCorner ​

▸ setScissorCorner(radius, fadeOut): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:85

setScreenSize ​

▸ setScreenSize(width, height): GUIMaterial

Write screenSize size to the shader

Parameters ​

Returns ​

GUIMaterial

Defined in ​

src/components/gui/core/GUIMaterial.ts:93

setTextures ​

▸ setTextures(list): void

Update texture used in GUI

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMaterial.ts:102

hasPass ​

▸ hasPass(passType): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

Material.hasPass

Defined in ​

src/materials/Material.ts:105

getPass ​

▸ getPass(passType): RenderShader[]

get render pass by renderType

Parameters ​

Returns ​

RenderShader[]

Inherited from ​

Material.getPass

Defined in ​

src/materials/Material.ts:114

getAllPass ​

▸ getAllPass(): RenderShader[]

get all color render pass

Returns ​

RenderShader[]

Inherited from ​

Material.getAllPass

Defined in ​

src/materials/Material.ts:122

addPass ​

▸ addPass(passType, pass, index?): RenderShader[]

Parameters ​

Returns ​

RenderShader[]

Inherited from ​

Material.addPass

Defined in ​

src/materials/Material.ts:126

removePass ​

▸ removePass(passType, index): void

Parameters ​

Returns ​

void

Inherited from ​

Material.removePass

Defined in ​

src/materials/Material.ts:145

clone ​

▸ clone(): any

clone one material

Returns ​

any

Material

Inherited from ​

Material.clone

Defined in ​

src/materials/Material.ts:158

destroy ​

▸ destroy(force): void

Parameters ​

Returns ​

void

Inherited from ​

Material.destroy

Defined in ​

src/materials/Material.ts:162