r3f-xr-widgets / EdgeUVMaterial
Class: EdgeUVMaterial
Defined in: src/components/EdgeUVMaterial.tsx:101
Shader material for HorizonWindow edge handles (top, bottom, left, right).
Renders a horizontal line with rounded caps in UV space for use as edge/border handles. Used by HorizonWindow to create interactive edge handles for moving and grabbing windows. Supports proximity-based fading and force-visible override for interaction feedback.
Extends
ShaderMaterial
Accessors
alphaTest
Get Signature
get alphaTest():
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:389
Gets the alpha value to be used when running an alpha test. Default is 0.
Default
0Returns
number
Set Signature
set alphaTest(
value):void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:395
Sets the alpha value to be used when running an alpha test. Default is 0.
Default
0Parameters
value
number
Returns
void
Inherited from
ShaderMaterial.alphaTest
needsUpdate
Set Signature
set needsUpdate(
value):void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:455
Specifies that the material needs to be updated, WebGL wise. Set it to true if you made changes that need to be reflected in WebGL. This property is automatically set to true when instancing a new material.
Default
falseParameters
value
boolean
Returns
void
Inherited from
ShaderMaterial.needsUpdate
Constructors
Constructor
new EdgeUVMaterial(
lineThicknessFraction,lineColor,opacity,useProximity,fadeRadius):EdgeUVMaterial
Defined in: src/components/EdgeUVMaterial.tsx:104
Parameters
lineThicknessFraction
number = 0.1
lineColor
Vector3 = ...
opacity
number = 1.0
useProximity
boolean = false
fadeRadius
number = 0.3
Returns
EdgeUVMaterial
Overrides
ShaderMaterial.constructor
Methods
addEventListener()
Call Signature
addEventListener<
T>(type,listener):void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:52
Adds a listener to an event type.
Type Parameters
T
T extends "dispose"
Parameters
type
T
The type of event to listen to.
listener
EventListener<object[T], T, EdgeUVMaterial>
The function that gets called when the event is fired.
Returns
void
Inherited from
ShaderMaterial.addEventListener
Call Signature
addEventListener<
T>(type,listener):void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:56
Adds a listener to an event type.
Type Parameters
T
T extends string
Parameters
type
T
The type of event to listen to.
listener
EventListener<{ }, T, EdgeUVMaterial>
The function that gets called when the event is fired.
Returns
void
Inherited from
ShaderMaterial.addEventListener
clone()
clone():
this
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:437
Return a new material with the same parameters as this material.
Returns
this
Inherited from
ShaderMaterial.clone
copy()
copy(
material):this
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:443
Copy the parameters from the passed material into this material.
Parameters
material
Material
Returns
this
Inherited from
ShaderMaterial.copy
customProgramCacheKey()
customProgramCacheKey():
string
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:420
In case onBeforeCompile is used, this callback can be used to identify values of settings used in onBeforeCompile, so three.js can reuse a cached shader or recompile the shader as needed.
Returns
string
Inherited from
ShaderMaterial.customProgramCacheKey
dispatchEvent()
dispatchEvent<
T>(event):void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:84
Fire an event type.
Type Parameters
T
T extends "dispose"
Parameters
event
BaseEvent<T> & object[T]
The event that gets fired.
Returns
void
Inherited from
ShaderMaterial.dispatchEvent
dispose()
dispose():
void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:448
This disposes the material. Textures of a material don't get disposed. These needs to be disposed by Texture.
Returns
void
Inherited from
ShaderMaterial.dispose
hasEventListener()
Call Signature
hasEventListener<
T>(type,listener):boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:63
Checks if listener is added to an event type.
Type Parameters
T
T extends "dispose"
Parameters
type
T
The type of event to listen to.
listener
EventListener<object[T], T, EdgeUVMaterial>
The function that gets called when the event is fired.
Returns
boolean
Inherited from
ShaderMaterial.hasEventListener
Call Signature
hasEventListener<
T>(type,listener):boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:67
Checks if listener is added to an event type.
Type Parameters
T
T extends string
Parameters
type
T
The type of event to listen to.
listener
EventListener<{ }, T, EdgeUVMaterial>
The function that gets called when the event is fired.
Returns
boolean
Inherited from
ShaderMaterial.hasEventListener
onBeforeCompile()
onBeforeCompile(
parameters,renderer):void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:415
An optional callback that is executed immediately before the shader program is compiled. This function is called with the associated WebGL program parameters and renderer. Useful for the modification of built-in materials.
Parameters
parameters
WebGLProgramParametersWithUniforms
WebGL program parameters
renderer
WebGLRenderer
WebGLRenderer context that is initializing the material
Returns
void
Inherited from
ShaderMaterial.onBeforeCompile
onBeforeRender()
onBeforeRender():
void
Defined in: src/components/EdgeUVMaterial.tsx:138
Returns
void
Overrides
ShaderMaterial.onBeforeRender
onBuild()
onBuild(
object,parameters,renderer):void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:397
Parameters
object
Object3D
parameters
WebGLProgramParametersWithUniforms
renderer
WebGLRenderer
Returns
void
Inherited from
ShaderMaterial.onBuild
removeEventListener()
Call Signature
removeEventListener<
T>(type,listener):void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:74
Removes a listener from an event type.
Type Parameters
T
T extends "dispose"
Parameters
type
T
The type of the listener that gets removed.
listener
EventListener<object[T], T, EdgeUVMaterial>
The listener function that gets removed.
Returns
void
Inherited from
ShaderMaterial.removeEventListener
Call Signature
removeEventListener<
T>(type,listener):void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/core/EventDispatcher.d.ts:78
Removes a listener from an event type.
Type Parameters
T
T extends string
Parameters
type
T
The type of the listener that gets removed.
listener
EventListener<{ }, T, EdgeUVMaterial>
The listener function that gets removed.
Returns
void
Inherited from
ShaderMaterial.removeEventListener
setForceVisible()
setForceVisible(
visible):void
Defined in: src/components/EdgeUVMaterial.tsx:149
Parameters
visible
boolean
Returns
void
setOpacity()
setOpacity(
opacity):void
Defined in: src/components/EdgeUVMaterial.tsx:144
Parameters
opacity
number
Returns
void
setValues()
setValues(
parameters):void
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:118
Sets the properties based on the values.
Parameters
parameters
ShaderMaterialParameters
Returns
void
Inherited from
ShaderMaterial.setValues
toJSON()
toJSON(
meta):any
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:119
Convert the material to three.js JSON format.
Parameters
meta
any
Object containing metadata such as textures or images for the material.
Returns
any
Inherited from
ShaderMaterial.toJSON
Properties
alphaHash
alphaHash:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:90
Enables alpha hashed transparency, an alternative to .transparent or .alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAARenderPass can reduce the resulting noise.
Inherited from
ShaderMaterial.alphaHash
alphaToCoverage
alphaToCoverage:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:98
Enables alpha to coverage. Can only be used with MSAA-enabled rendering contexts (meaning when the renderer was created with antialias parameter set to true). Enabling this will smooth aliasing on clip plane edges and alphaTest-clipped edges.
Default
falseInherited from
ShaderMaterial.alphaToCoverage
blendAlpha
blendAlpha:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:105
Represents the alpha value of the constant blend color. This property has only an effect when using custom blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.
Default
0Inherited from
ShaderMaterial.blendAlpha
blendColor
blendColor:
Color
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:112
Represent the RGB values of the constant blend color. This property has only an effect when using custom blending with ConstantColorFactor or OneMinusConstantColorFactor.
Default
0x000000Inherited from
ShaderMaterial.blendColor
blendDst
blendDst:
BlendingDstFactor
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:118
Blending destination. It's one of the blending mode constants defined in Three.js. Default is OneMinusSrcAlphaFactor.
Default
THREE.OneMinusSrcAlphaFactorInherited from
ShaderMaterial.blendDst
blendDstAlpha
blendDstAlpha:
number|null
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:124
The tranparency of the .blendDst. Default is null.
Default
nullInherited from
ShaderMaterial.blendDstAlpha
blendEquation
blendEquation:
BlendingEquation
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:130
Blending equation to use when applying blending. It's one of the constants defined in Three.js. Default is AddEquation.
Default
THREE.AddEquationInherited from
ShaderMaterial.blendEquation
blendEquationAlpha
blendEquationAlpha:
number|null
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:136
The tranparency of the .blendEquation. Default is null.
Default
nullInherited from
ShaderMaterial.blendEquationAlpha
blending
blending:
Blending
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:142
Which blending to use when displaying objects with this material. Default is NormalBlending.
Default
THREE.NormalBlendingInherited from
ShaderMaterial.blending
blendSrc
blendSrc:
200|201|202|203|204|205|206|207|208|209|210|211|212|213|214
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:148
Blending source. It's one of the blending mode constants defined in Three.js. Default is SrcAlphaFactor.
Default
THREE.SrcAlphaFactorInherited from
ShaderMaterial.blendSrc
blendSrcAlpha
blendSrcAlpha:
number|null
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:154
The tranparency of the .blendSrc. Default is null.
Default
nullInherited from
ShaderMaterial.blendSrcAlpha
clipIntersection
clipIntersection:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:160
Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union. Default is false.
Default
falseInherited from
ShaderMaterial.clipIntersection
clipping
clipping:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:85
Default
falseInherited from
ShaderMaterial.clipping
clippingPlanes
clippingPlanes:
Plane[] |null
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:169
User-defined clipping planes specified as THREE.Plane objects in world space. These planes apply to the objects this material is attached to. Points in space whose signed distance to the plane is negative are clipped (not rendered). See the WebGL / clipping /intersection example. Default is null.
Default
nullInherited from
ShaderMaterial.clippingPlanes
clipShadows
clipShadows:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:175
Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.
Default
falseInherited from
ShaderMaterial.clipShadows
color
color:
Color
Defined in: src/components/EdgeUVMaterial.tsx:102
colorWrite
colorWrite:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:181
Whether to render the material's color. This can be used in conjunction with a mesh's .renderOrder property to create invisible objects that occlude other objects. Default is true.
Default
trueInherited from
ShaderMaterial.colorWrite
defaultAttributeValues
defaultAttributeValues:
any
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:101
Default
{ 'color': [ 1, 1, 1 ], 'uv': [ 0, 0 ], 'uv1': [ 0, 0 ] }Inherited from
ShaderMaterial.defaultAttributeValues
defines
defines:
object
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:44
Index Signature
[key: string]: any
Default
{}Inherited from
ShaderMaterial.defines
depthFunc
depthFunc:
DepthModes
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:194
Which depth function to use. Default is LessEqualDepth. See the depth mode constants for all possible values.
Default
THREE.LessEqualDepthInherited from
ShaderMaterial.depthFunc
depthTest
depthTest:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:201
Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write will also be implicitly disabled.
Default
trueInherited from
ShaderMaterial.depthTest
depthWrite
depthWrite:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:208
Whether rendering this material has any effect on the depth buffer. Default is true. When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.
Default
trueInherited from
ShaderMaterial.depthWrite
dithering
dithering:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:318
Whether to apply dithering to the color to remove the appearance of banding. Default is false.
Default
falseInherited from
ShaderMaterial.dithering
extensions
extensions:
object
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:93
clipCullDistance
clipCullDistance:
boolean
multiDraw
multiDraw:
boolean
Default
{
* clipCullDistance: false,
* multiDraw: false
* }Inherited from
ShaderMaterial.extensions
fog
fog:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:75
Default
falseInherited from
ShaderMaterial.fog
forceSinglePass
forceSinglePass:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:312
Default
falseInherited from
ShaderMaterial.forceSinglePass
fragmentShader
fragmentShader:
string
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:55
Inherited from
ShaderMaterial.fragmentShader
glslVersion
glslVersion:
GLSLVersion|null
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:116
Default
nullInherited from
ShaderMaterial.glslVersion
id
id:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:213
Unique number of this material instance.
Inherited from
ShaderMaterial.id
index0AttributeName
index0AttributeName:
string|undefined
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:106
Default
undefinedInherited from
ShaderMaterial.index0AttributeName
isMaterial
readonlyisMaterial:true
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:82
Read-only flag to check if a given object is of type Material.
Remarks
This is a constant value
Default Value
true
Inherited from
ShaderMaterial.isMaterial
isShaderMaterial
readonlyisShaderMaterial:true
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:34
Read-only flag to check if a given object is of type ShaderMaterial.
Remarks
This is a constant value
Default Value
true
Inherited from
ShaderMaterial.isShaderMaterial
lights
lights:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:80
Default
falseInherited from
ShaderMaterial.lights
linewidth
linewidth:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:60
Default
1Inherited from
ShaderMaterial.linewidth
name
name:
string
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:271
Material name. Default is an empty string.
Default
''Inherited from
ShaderMaterial.name
opacity
opacity:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:277
Opacity. Default is 1.
Default
1Inherited from
ShaderMaterial.opacity
polygonOffset
polygonOffset:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:283
Whether to use polygon offset. Default is false. This corresponds to the POLYGON_OFFSET_FILL WebGL feature.
Default
falseInherited from
ShaderMaterial.polygonOffset
polygonOffsetFactor
polygonOffsetFactor:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:289
Sets the polygon offset factor. Default is 0.
Default
0Inherited from
ShaderMaterial.polygonOffsetFactor
polygonOffsetUnits
polygonOffsetUnits:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:295
Sets the polygon offset units. Default is 0.
Default
0Inherited from
ShaderMaterial.polygonOffsetUnits
precision
precision:
"highp"|"mediump"|"lowp"|null
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:301
Override the renderer's default precision for this material. Can be "highp", "mediump" or "lowp". Defaults is null.
Default
nullInherited from
ShaderMaterial.precision
premultipliedAlpha
premultipliedAlpha:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:307
Whether to premultiply the alpha (transparency) value. See WebGL / Materials / Transparency for an example of the difference. Default is false.
Default
falseInherited from
ShaderMaterial.premultipliedAlpha
shadowSide
shadowSide:
Side|null
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:333
Defines which of the face sides will cast shadows. Default is null. If null, the value is opposite that of side, above.
Default
nullInherited from
ShaderMaterial.shadowSide
side
side:
Side
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:326
Defines which of the face sides will be rendered - front, back or both. Default is THREE.FrontSide. Other options are THREE.BackSide and THREE.DoubleSide.
Default
THREE.FrontSide
Inherited from
ShaderMaterial.side
stencilFail
stencilFail:
StencilOp
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:249
Which stencil operation to perform when the comparison function returns false. Default is KeepStencilOp. See the stencil operation constants for all possible values.
Default
THREE.KeepStencilOpInherited from
ShaderMaterial.stencilFail
stencilFunc
stencilFunc:
StencilFunc
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:225
The stencil comparison function to use. Default is AlwaysStencilFunc. See stencil operation constants for all possible values.
Default
THREE.AlwaysStencilFuncInherited from
ShaderMaterial.stencilFunc
stencilFuncMask
stencilFuncMask:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:243
The bit mask to use when comparing against the stencil buffer. Default is 0xFF.
Default
0xffInherited from
ShaderMaterial.stencilFuncMask
stencilRef
stencilRef:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:231
The value to use when performing stencil comparisons or stencil operations. Default is 0.
Default
0Inherited from
ShaderMaterial.stencilRef
stencilWrite
stencilWrite:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:219
Whether rendering this material has any effect on the stencil buffer. Default is false.
Default
falseInherited from
ShaderMaterial.stencilWrite
stencilWriteMask
stencilWriteMask:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:237
The bit mask to use when writing to the stencil buffer. Default is 0xFF.
Default
0xffInherited from
ShaderMaterial.stencilWriteMask
stencilZFail
stencilZFail:
StencilOp
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:257
Which stencil operation to perform when the comparison function returns true but the depth test fails. Default is KeepStencilOp. See the stencil operation constants for all possible values.
Default
THREE.KeepStencilOpInherited from
ShaderMaterial.stencilZFail
stencilZPass
stencilZPass:
StencilOp
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:265
Which stencil operation to perform when the comparison function returns true and the depth test passes. Default is KeepStencilOp. See the stencil operation constants for all possible values.
Default
THREE.KeepStencilOpInherited from
ShaderMaterial.stencilZPass
toneMapped
toneMapped:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:341
Defines whether this material is tone mapped according to the renderer's WebGLRenderer.toneMapping toneMapping setting. It is ignored when rendering to a render target or using post processing.
Default
trueInherited from
ShaderMaterial.toneMapped
transparent
transparent:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:348
Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects. When set to true, the extent to which the material is transparent is controlled by setting it's .opacity property.
Default
falseInherited from
ShaderMaterial.transparent
type
type:
string
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:39
Default
'ShaderMaterial'Inherited from
ShaderMaterial.type
uniforms
uniforms:
object
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:49
Index Signature
[uniform: string]: IUniform<any>
Default
{}Inherited from
ShaderMaterial.uniforms
uniformsGroups
uniformsGroups:
UniformsGroup[]
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:51
Inherited from
ShaderMaterial.uniformsGroups
uniformsNeedUpdate
uniformsNeedUpdate:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:111
Default
falseInherited from
ShaderMaterial.uniformsNeedUpdate
userData
userData:
Record<string,any>
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:377
An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.
Default
{}Inherited from
ShaderMaterial.userData
uuid
uuid:
string
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:359
UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.
Inherited from
ShaderMaterial.uuid
version
version:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:383
This starts at 0 and counts how many times .needsUpdate is set to true.
Default
0Inherited from
ShaderMaterial.version
vertexColors
vertexColors:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:365
Defines whether vertex coloring is used. Default is false.
Default
falseInherited from
ShaderMaterial.vertexColors
vertexShader
vertexShader:
string
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:53
Inherited from
ShaderMaterial.vertexShader
visible
visible:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/Material.d.ts:371
Defines whether this material is visible. Default is true.
Default
trueInherited from
ShaderMaterial.visible
wireframe
wireframe:
boolean
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:65
Default
falseInherited from
ShaderMaterial.wireframe
wireframeLinewidth
wireframeLinewidth:
number
Defined in: node_modules/.pnpm/@types+three@0.165.0/node_modules/@types/three/src/materials/ShaderMaterial.d.ts:70
Default
1Inherited from
ShaderMaterial.wireframeLinewidth