Class: GUIMaterial
material used in rendering GUI
Hierarchy
↳
GUIMaterial
Constructors
Properties
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
Name | Type |
---|---|
space | GUISpace |
Overrides
Defined in
src/components/gui/core/GUIMaterial.ts:23
Properties
name
• name: string
name of this material
Inherited from
Defined in
instanceID
• instanceID: string
Material Unique Identifier
Inherited from
Defined in
enable
• enable: boolean
= true
Inherited from
Defined in
Accessors
envMap
• set
envMap(texture
): void
Parameters
Name | Type |
---|---|
texture | Texture |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:129
shadowMap
• set
shadowMap(texture
): void
Parameters
Name | Type |
---|---|
texture | Texture |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:130
baseMap
• set
baseMap(texture
): void
Parameters
Name | Type |
---|---|
texture | Texture |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:131
normalMap
• set
normalMap(value
): void
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:132
emissiveMap
• set
emissiveMap(value
): void
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:133
irradianceMap
• set
irradianceMap(value
): void
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:134
irradianceDepthMap
• set
irradianceDepthMap(value
): void
Parameters
Name | Type |
---|---|
value | Texture |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:135
depthCompare
• get
depthCompare(): GPUCompareFunction
Returns
GPUCompareFunction
Inherited from
Material.depthCompare
Defined in
• set
depthCompare(value
): void
Parameters
Name | Type |
---|---|
value | GPUCompareFunction |
Returns
void
Inherited from
Material.depthCompare
Defined in
defaultPass
• get
defaultPass(): RenderShader
Returns
Inherited from
Material.defaultPass
Defined in
• set
defaultPass(value
): void
Parameters
Name | Type |
---|---|
value | RenderShader |
Returns
void
Inherited from
Material.defaultPass
Defined in
doubleSide
• get
doubleSide(): boolean
Returns
boolean
Inherited from
Material.doubleSide
Defined in
• set
doubleSide(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
Material.doubleSide
Defined in
castShadow
• get
castShadow(): boolean
Returns
boolean
Inherited from
Material.castShadow
Defined in
• set
castShadow(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
Material.castShadow
Defined in
blendMode
• get
blendMode(): BlendMode
Returns
Inherited from
Material.blendMode
Defined in
• set
blendMode(value
): void
Parameters
Name | Type |
---|---|
value | BlendMode |
Returns
void
Inherited from
Material.blendMode
Defined in
transparent
• get
transparent(): boolean
Returns
boolean
Inherited from
Material.transparent
Defined in
• set
transparent(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
Material.transparent
Defined in
cullMode
• get
cullMode(): GPUCullMode
Returns
GPUCullMode
Inherited from
Material.cullMode
Defined in
• set
cullMode(value
): void
Parameters
Name | Type |
---|---|
value | GPUCullMode |
Returns
void
Inherited from
Material.cullMode
Defined in
Methods
setLimitVertex
▸ setLimitVertex(vertexCount
): void
Write effective vertex count (vertex index < vertexCount)
Parameters
Name | Type |
---|---|
vertexCount | number |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:58
setGUISolution
▸ setGUISolution(value
, pixelRatio
): void
Parameters
Name | Type |
---|---|
value | Vector2 |
pixelRatio | number |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:62
setScissorRect
▸ setScissorRect(left
, bottom
, right
, top
): void
Parameters
Name | Type |
---|---|
left | number |
bottom | number |
right | number |
top | number |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:67
setScissorEnable
▸ setScissorEnable(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:73
setScissorCorner
▸ setScissorCorner(radius
, fadeOut
): void
Parameters
Name | Type |
---|---|
radius | number |
fadeOut | number |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:85
setScreenSize
▸ setScreenSize(width
, height
): GUIMaterial
Write screenSize size to the shader
Parameters
Name | Type |
---|---|
width | number |
height | number |
Returns
Defined in
src/components/gui/core/GUIMaterial.ts:93
setTextures
▸ setTextures(list
): void
Update texture used in GUI
Parameters
Name | Type |
---|---|
list | Texture [] |
Returns
void
Defined in
src/components/gui/core/GUIMaterial.ts:102
hasPass
▸ hasPass(passType
): boolean
Parameters
Name | Type |
---|---|
passType | RendererType |
Returns
boolean
Inherited from
Defined in
getPass
▸ getPass(passType
): RenderShader
[]
get render pass by renderType
Parameters
Name | Type |
---|---|
passType | RendererType |
Returns
Inherited from
Defined in
getAllPass
▸ getAllPass(): RenderShader
[]
get all color render pass
Returns
Inherited from
Defined in
addPass
▸ addPass(passType
, pass
, index?
): RenderShader
[]
Parameters
Name | Type | Default value |
---|---|---|
passType | RendererType | undefined |
pass | RenderShader | undefined |
index | number | -1 |
Returns
Inherited from
Defined in
removePass
▸ removePass(passType
, index
): void
Parameters
Name | Type |
---|---|
passType | RendererType |
index | number |
Returns
void
Inherited from
Defined in
clone
▸ clone(): any
clone one material
Returns
any
Material
Inherited from
Defined in
destroy
▸ destroy(force
): void
Parameters
Name | Type |
---|---|
force | boolean |
Returns
void