Class SSAOMaterial

A Screen Space Ambient Occlusion (SSAO) shader material.

Implements

Hierarchy

ShaderMaterial
- SSAOMaterial

Implements

Resizable

Index

Constructors

constructor

Constructors

constructor

new SSAOMaterial(camera): SSAOMaterial
Constructs a new SSAO material.
Parameters
- camera: Camera
  A camera.
Returns SSAOMaterial
Overrides ShaderMaterial.constructor

Properties

alphaHash

alphaHash: boolean

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.

alphaToCoverage

alphaToCoverage: boolean

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

false

blendAlpha

blendAlpha: number

Represents the alpha value of the constant blend color. This property has only an effect when using custom blending with ConstantAlphaFactor or OneMinusConstantAlphaFactor.

Default

blendColor

blendColor: Color

Represent the RGB values of the constant blend color. This property has only an effect when using custom blending with ConstantColorFactor or OneMinusConstantColorFactor.

Default

0x000000

blendDst

blendDst: BlendingDstFactor

Blending destination. It's one of the blending mode constants defined in Three.js. Default is OneMinusSrcAlphaFactor.

Default

THREE.OneMinusSrcAlphaFactor

blendDstAlpha

blendDstAlpha: number

The tranparency of the .blendDst. Default is null.

Default

null

blendEquation

blendEquation: BlendingEquation

Blending equation to use when applying blending. It's one of the constants defined in Three.js. Default is AddEquation.

Default

THREE.AddEquation

blendEquationAlpha

blendEquationAlpha: number

The tranparency of the .blendEquation. Default is null.

Default

null

blending

blending: Blending

Which blending to use when displaying objects with this material. Default is NormalBlending.

Default

THREE.NormalBlending

blendSrc

blendSrc:
    | 200
    | 201
    | 202
    | 203
    | 204
    | 205
    | 206
    | 207
    | 208
    | 209
    | 210
    | 211
    | 212
    | 213
    | 214

Blending source. It's one of the blending mode constants defined in Three.js. Default is SrcAlphaFactor.

Default

THREE.SrcAlphaFactor

blendSrcAlpha

blendSrcAlpha: number

The tranparency of the .blendSrc. Default is null.

Default

null

clipIntersection

clipIntersection: boolean

Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union. Default is false.

Default

false

clipping

clipping: boolean

Default

false

clippingPlanes

clippingPlanes: Plane[]

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

null

clipShadows

clipShadows: boolean

Defines whether to clip shadows according to the clipping planes specified on this material. Default is false.

Default

false

colorWrite

colorWrite: boolean

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

true

defaultAttributeValues

defaultAttributeValues: any

Default

{ 'color': [ 1, 1, 1 ], 'uv': [ 0, 0 ], 'uv1': [ 0, 0 ] }

defines

defines: {
[key: string]: any;
}

Default

{}

depthFunc

depthFunc: DepthModes

Which depth function to use. Default is LessEqualDepth. See the depth mode constants for all possible values.

Default

THREE.LessEqualDepth

depthTest

depthTest: boolean

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

true

depthWrite

depthWrite: boolean

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

true

dithering

dithering: boolean

Whether to apply dithering to the color to remove the appearance of banding. Default is false.

Default

false

extensions

extensions: {
clipCullDistance: boolean;
multiDraw: boolean;
}

Default

{
     *   clipCullDistance: false,
     *   multiDraw: false
     * }

fog

fog: boolean

Default

false

forceSinglePass

forceSinglePass: boolean

Default

false

fragmentShader

fragmentShader: string

glslVersion

glslVersion: GLSLVersion

Default

null

id

id: number

Unique number of this material instance.

index0AttributeName

index0AttributeName: string

Default

undefined

`Readonly`isMaterial

isMaterial: true

Read-only flag to check if a given object is of type Material.

Remarks

This is a constant value

Default Value

true

`Readonly`isShaderMaterial

isShaderMaterial: true

Read-only flag to check if a given object is of type ShaderMaterial.

Remarks

This is a constant value

Default Value

true

lights

lights: boolean

Default

false

linewidth

linewidth: number

Default

name

name: string

Material name. Default is an empty string.

Default

''

opacity

opacity: number

Opacity. Default is 1.

Default

polygonOffset

polygonOffset: boolean

Whether to use polygon offset. Default is false. This corresponds to the POLYGON_OFFSET_FILL WebGL feature.

Default

false

polygonOffsetFactor

polygonOffsetFactor: number

Sets the polygon offset factor. Default is 0.

Default

polygonOffsetUnits

polygonOffsetUnits: number

Sets the polygon offset units. Default is 0.

Default

precision

precision: "highp" | "mediump" | "lowp"

Override the renderer's default precision for this material. Can be "highp", "mediump" or "lowp". Defaults is null.

Default

null

premultipliedAlpha

premultipliedAlpha: boolean

Whether to premultiply the alpha (transparency) value. See WebGL / Materials / Transparency for an example of the difference. Default is false.

Default

false

shadowSide

shadowSide: Side

Defines which of the face sides will cast shadows. Default is null. If null, the value is opposite that of side, above.

Default

null

side

side: Side

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

stencilFail

stencilFail: StencilOp

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.KeepStencilOp

stencilFunc

stencilFunc: StencilFunc

The stencil comparison function to use. Default is AlwaysStencilFunc. See stencil operation constants for all possible values.

Default

THREE.AlwaysStencilFunc

stencilFuncMask

stencilFuncMask: number

The bit mask to use when comparing against the stencil buffer. Default is 0xFF.

Default

0xff

stencilRef

stencilRef: number

The value to use when performing stencil comparisons or stencil operations. Default is 0.

Default

stencilWrite

stencilWrite: boolean

Whether rendering this material has any effect on the stencil buffer. Default is false.

Default

false

stencilWriteMask

stencilWriteMask: number

The bit mask to use when writing to the stencil buffer. Default is 0xFF.

Default

0xff

stencilZFail

stencilZFail: StencilOp

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.KeepStencilOp

stencilZPass

stencilZPass: StencilOp

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.KeepStencilOp

toneMapped

toneMapped: boolean

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

true

transparent

transparent: boolean

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

false

type

type: string

Default

'ShaderMaterial'

uniforms

uniforms: {
[uniform: string]: IUniform;
}

Default

{}

uniformsGroups

uniformsGroups: UniformsGroup[]

uniformsNeedUpdate

uniformsNeedUpdate: boolean

Default

false

userData

userData: Record<string, any>

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

{}

uuid

uuid: string

UUID of this material instance. This gets automatically assigned, so this shouldn't be edited.

version

version: number

This starts at 0 and counts how many times .needsUpdate is set to true.

Default

vertexColors

vertexColors: boolean

Defines whether vertex coloring is used. Default is false.

Default

false

vertexShader

vertexShader: string

visible

visible: boolean

Defines whether this material is visible. Default is true.

Default

true

wireframe

wireframe: boolean

Default

false

wireframeLinewidth

wireframeLinewidth: number

Default

Accessors

alphaTest

get alphaTest(): number
Gets the alpha value to be used when running an alpha test. Default is 0.

Returns number
Default
```
0
```
Inherited from ShaderMaterial.alphaTest
set alphaTest(value): void
Sets the alpha value to be used when running an alpha test. Default is 0.
Parameters
- value: number
Returns void
Default
```
0
```
Inherited from ShaderMaterial.alphaTest

bias

get bias(): number
The depth bias. Range: [0.0, 1.0].

Returns number
set bias(arg): void
Parameters
- arg: number
Returns void

depthBuffer

set depthBuffer(arg): void
The depth buffer.
Parameters
- arg: Texture
  The buffer.
Returns void

depthPacking

set depthPacking(arg): void
The depth packing strategy.
Parameters
- arg: DepthPackingStrategies
  The depth packing strategy.
Returns void

distanceFalloff

get distanceFalloff(): number
The occlusion distance falloff. Range: [0.0, 1.0].

Returns number
set distanceFalloff(arg): void
Parameters
- arg: number
Returns void

distanceScaling

get distanceScaling(): boolean
Indicates whether distance-based radius scaling is enabled.

Returns boolean
set distanceScaling(arg): void
Parameters
- arg: boolean
Returns void

distanceThreshold

get distanceThreshold(): number
The occlusion distance threshold. Range: [0.0, 1.0].

Returns number
set distanceThreshold(arg): void
Parameters
- arg: number
Returns void

fade

get fade(): number
The depth fade factor.

Returns number
set fade(arg): void
Parameters
- arg: number
Returns void

intensity

get intensity(): number
The intensity.

Returns number
Deprecated
Use SSAOEffect.intensity instead.
set intensity(arg): void
Parameters
- arg: number
Returns void

minRadiusScale

get minRadiusScale(): number
The minimum radius scale for distance scaling. Range: [0.0, 1.0].

Returns number
set minRadiusScale(arg): void
Parameters
- arg: number
Returns void

needsUpdate

set needsUpdate(value): void
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.
Parameters
- value: boolean
Returns void
Default
```
false
```
Inherited from ShaderMaterial.needsUpdate

noiseTexture

set noiseTexture(arg): void
The noise texture.
Parameters
- arg: Texture
  The texture.
Returns void

normalBuffer

set normalBuffer(arg): void
The normal buffer.
Parameters
- arg: Texture
  The buffer.
Returns void

normalDepthBuffer

set normalDepthBuffer(arg): void
The combined normal-depth buffer.
Parameters
- arg: Texture
  The buffer.
Returns void

proximityFalloff

get proximityFalloff(): number
The occlusion proximity falloff. Range: [0.0, 1.0].

Returns number
set proximityFalloff(arg): void
Parameters
- arg: number
Returns void

proximityThreshold

get proximityThreshold(): number
The occlusion proximity threshold. Range: [0.0, 1.0].

Returns number
set proximityThreshold(arg): void
Parameters
- arg: number
Returns void

radius

get radius(): number
The occlusion sampling radius. Range: [0.0, 1.0].

Returns number
set radius(arg): void
Parameters
- arg: number
Returns void

rings

get rings(): number
The sampling spiral ring count.

Returns number
set rings(arg): void
Parameters
- arg: number
Returns void

samples

get samples(): number
The sample count.

Returns number
set samples(arg): void
Parameters
- arg: number
Returns void

worldDistanceFalloff

get worldDistanceFalloff(): number
The occlusion distance falloff in world units.

Returns number
set worldDistanceFalloff(value): void
Parameters
- value: number
Returns void

worldDistanceThreshold

get worldDistanceThreshold(): number
The occlusion distance falloff. The occlusion distance threshold in world units.

Returns number
set worldDistanceThreshold(value): void
Parameters
- value: number
Returns void

worldProximityFalloff

get worldProximityFalloff(): number
The occlusion proximity falloff in world units.

Returns number
set worldProximityFalloff(value): void
Parameters
- value: number
Returns void

worldProximityThreshold

get worldProximityThreshold(): number
The occlusion proximity threshold in world units.

Returns number
set worldProximityThreshold(value): void
Parameters
- value: number
Returns void

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, SSAOMaterial>
  The function that gets called when the event is fired.
Returns void
Inherited from ShaderMaterial.addEventListener

adoptCameraSettings

adoptCameraSettings(camera): void
Adopts the settings of the given camera.
Parameters
- camera: Camera
  A camera.
Returns void

clone

clone(): this
Return a new material with the same parameters as this material.

Returns this
Inherited from ShaderMaterial.clone

copy

copy(material): this
Copy the parameters from the passed material into this material.
Parameters
- material: Material
Returns this
Inherited from ShaderMaterial.copy

customProgramCacheKey

customProgramCacheKey(): string
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
Fire an event type.
Type Parameters
- T extends "dispose"
Parameters
- event: BaseEvent<T> & {
  dispose: {};
  }[T]
  The event that gets fired.
Returns void
Inherited from ShaderMaterial.dispatchEvent

dispose

dispose(): void
Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Material textures must be disposed of by the dispose() method of Texture.

Returns void
Inherited from ShaderMaterial.dispose

getBias

getBias(): number
Returns the depth bias.

Returns number
The bias.

Deprecated
Use bias instead.

getFade

getFade(): number
Returns the depth fade factor.

Returns number
The fade factor.

Deprecated
Use fade instead.

getIntensity

getIntensity(): number
Returns the intensity.

Returns number
The intensity.

Deprecated
Use intensity instead.

getMinRadiusScale

getMinRadiusScale(): number
Returns the minimum radius scale for distance scaling.

Returns number
The minimum radius scale.

Deprecated
Use minRadiusScale instead.

getRadius

getRadius(): number
Returns the occlusion sampling radius.

Returns number
The radius.

Deprecated
Use radius instead.

getRings

getRings(): number
Returns the amount of spiral turns in the occlusion sampling pattern.

Returns number
The radius.

Deprecated
Use rings instead.

getSamples

getSamples(): number
Returns the amount of occlusion samples per pixel.

Returns number
The sample count.

Deprecated
Use samples instead.

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<{
  dispose: {};
  }[T], T, SSAOMaterial>
  The function that gets called when the event is fired.
Returns boolean
Inherited from ShaderMaterial.hasEventListener

isDistanceScalingEnabled

isDistanceScalingEnabled(): boolean
Indicates whether distance-based radius scaling is enabled.

Returns boolean
Whether distance scaling is enabled.

Deprecated
Use distanceScaling instead.

onBeforeCompile

onBeforeCompile(parameters, renderer): void
An optional callback that is executed immediately before the shader program is compiled. This function is called with the shader source code as a parameter. Useful for the modification of built-in materials. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).
Parameters
- parameters: WebGLProgramParametersWithUniforms
  WebGL program parameters
- renderer: WebGLRenderer
  WebGLRenderer context that is initializing the material
Returns void
Inherited from ShaderMaterial.onBeforeCompile

onBeforeRender

onBeforeRender(renderer, scene, camera, geometry, object, group): void
An optional callback that is executed immediately before the material is used to render a 3D object. Unlike properties, the callback is not supported by .clone(), .copy() and .toJSON(). This callback is only supported in WebGLRenderer (not WebGPURenderer).
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- object: Object3D<Object3DEventMap>
- group: Group<Object3DEventMap>
Returns void
Inherited from ShaderMaterial.onBeforeRender

onBuild

onBuild(object, parameters, renderer): void
Parameters
- object: Object3D<Object3DEventMap>
- parameters: WebGLProgramParametersWithUniforms
- renderer: WebGLRenderer
Returns void
Deprecated
onBuild() has been removed.

Inherited from ShaderMaterial.onBuild

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "dispose"
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<{
  dispose: {};
  }[T], T, SSAOMaterial>
  The listener function that gets removed.
Returns void
Inherited from ShaderMaterial.removeEventListener

setBias

setBias(value): void
Sets the depth bias.
Parameters
- value: number
  The bias.
Returns void
Deprecated
Use bias instead.

setDepthBuffer

setDepthBuffer(buffer, depthPacking?): void
Sets the depth buffer.
Parameters
- buffer: Texture
  The depth texture.
- OptionaldepthPacking: DepthPackingStrategies
  The depth packing strategy.
Returns void
Deprecated
Use depthBuffer and depthPacking instead.

setDistanceCutoff

setDistanceCutoff(threshold, falloff): void
Sets the occlusion distance cutoff.
Parameters
- threshold: number
  The distance threshold. Range [0.0, 1.0].
- falloff: number
  The falloff. Range [0.0, 1.0].
Returns void
Deprecated
Use distanceThreshold and distanceFalloff instead.

setDistanceScalingEnabled

setDistanceScalingEnabled(value): void
Enables or disables distance-based radius scaling.
Parameters
- value: boolean
  Whether distance scaling should be enabled.
Returns void
Deprecated
Use distanceScaling instead.

setFade

setFade(value): void
Sets the depth fade factor.
Parameters
- value: number
  The fade factor.
Returns void
Deprecated
Use fade instead.

setIntensity

setIntensity(value): void
Sets the intensity.
Parameters
- value: number
  The intensity.
Returns void
Deprecated
Use intensity instead.

setMinRadiusScale

setMinRadiusScale(value): void
Sets the minimum radius scale for distance scaling.
Parameters
- value: number
  The minimum radius scale.
Returns void
Deprecated
Use minRadiusScale instead.

setNoiseTexture

setNoiseTexture(value): void
Sets the noise texture.
Parameters
- value: Texture
  The texture.
Returns void
Deprecated
Use noiseTexture instead.

setNormalBuffer

setNormalBuffer(value): void
Sets the normal buffer.
Parameters
- value: Texture
  The buffer.
Returns void
Deprecated
Use normalBuffer instead.

setNormalDepthBuffer

setNormalDepthBuffer(value): void
Sets the combined normal-depth buffer.
Parameters
- value: Texture
  The buffer.
Returns void
Deprecated
Use normalDepthBuffer instead.

setProximityCutoff

setProximityCutoff(threshold, falloff): void
Sets the occlusion proximity cutoff.
Parameters
- threshold: number
  The range threshold. Range [0.0, 1.0].
- falloff: number
  The falloff. Range [0.0, 1.0].
Returns void
Deprecated
Use proximityThreshold and proximityFalloff instead.

setRadius

setRadius(value): void
Sets the occlusion sampling radius.
Parameters
- value: number
  The radius. Range [1e-6, 1.0].
Returns void
Deprecated
Use radius instead.

setRings

setRings(value): void
Sets the amount of spiral turns in the occlusion sampling pattern.
Parameters
- value: number
  The radius.
Returns void
Deprecated
Use rings instead.

setSamples

setSamples(value): void
Sets the amount of occlusion samples per pixel.
Parameters
- value: number
  The sample count.
Returns void
Deprecated
Use samples instead.

setSize

setSize(width, height): void
Sets the size of this object.
Parameters
- width: number
  The width.
- height: number
  The height.
Returns void
Implementation of Resizable.setSize

setTexelSize

setTexelSize(x, y): void
Sets the texel size.
Parameters
- x: number
  The texel width.
- y: number
  The texel height.
Returns void
Deprecated
Use setSize() instead.

setValues

setValues(parameters): void
Sets the properties based on the values.
Parameters
- parameters: ShaderMaterialParameters
Returns void
Inherited from ShaderMaterial.setValues

toJSON

toJSON(meta?): ShaderMaterialJSON
Convert the material to three.js JSON format.
Parameters
- Optionalmeta: JSONMeta
  Object containing metadata such as textures or images for the material.
Returns ShaderMaterialJSON
Inherited from ShaderMaterial.toJSON

Class SSAOMaterial

Implements

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SSAOMaterial

Properties

alphaHash

alphaToCoverage

Default

blendAlpha

Default

blendColor

Default

blendDst

Default

blendDstAlpha

Default

blendEquation

Default

blendEquationAlpha

Default

blending

Default

blendSrc

Default

blendSrcAlpha

Default

clipIntersection

Default

clipping

Default

clippingPlanes

Default

clipShadows

Default

colorWrite

Default

defaultAttributeValues

Default

defines

Default

depthFunc

Default

depthTest

Default

depthWrite

Default

dithering

Default

extensions

Default

fog

Default

forceSinglePass

Default

fragmentShader

glslVersion

Default

id

index0AttributeName

Default

ReadonlyisMaterial

Remarks

Default Value

ReadonlyisShaderMaterial

Remarks

Default Value

lights

Default

linewidth

Default

name

`Readonly`isMaterial

`Readonly`isShaderMaterial