Class

Pass

Pass(parametersopt)

A pass

Constructor

new Pass(parametersopt)

Constructor
Parameters:
Name Type Attributes Description
parameters Array.<Array> <optional>
 An array of parameters

View Source Material/Pass.js, line 49

Extends

Members

BlendMode

blendMode

Blend mode
Inherited From:

View Source StateBlock.js, line 292

DepthFunction

depthFunction

Depth function to use
Inherited From:
Default Value:
  • {DepthFunction.Less}

View Source StateBlock.js, line 301

boolean

depthTest

Indicates if we want to test pixels with values in the depth buffer
Inherited From:
Default Value:
  • {true}

View Source StateBlock.js, line 319

boolean

depthWrite

Indicates if we want to write in the depth buffer
Inherited From:
Default Value:
  • {true}

View Source StateBlock.js, line 310

DrawingMode

drawingMode

Drawing mode
Inherited From:
Default Value:
  • {DrawingMode.Triangles}

View Source StateBlock.js, line 328

FaceCulling

faceCulling

Face culling
Inherited From:
Default Value:
  • {FaceCulling.Back}

View Source StateBlock.js, line 337

StencilOperation

stencilDepthTestFail

Operation to execute when stencil test failed using depth buffer
Inherited From:
Default Value:
  • {StencilOperation.Keep}

View Source StateBlock.js, line 400

StencilFunction

stencilFunction

Stencil function to use
Inherited From:
Default Value:
  • {StencilFunction.Less}

View Source StateBlock.js, line 346

number

stencilMask

Stencil mask value
Inherited From:
Default Value:
  • {255}

View Source StateBlock.js, line 364

number

stencilReference

Stencil reference value
Inherited From:
Default Value:
  • {0}

View Source StateBlock.js, line 355

StencilOperation

stencilSuccess

Operation to execute when stencil test is a success
Inherited From:
Default Value:
  • {StencilOperation.Keep}

View Source StateBlock.js, line 409

boolean

stencilTest

Indicates if stencil test is active
Inherited From:
Default Value:
  • {false}

View Source StateBlock.js, line 373

StencilOperation

stencilTestFail

Operation to execute when stencil test failed
Inherited From:
Default Value:
  • {StencilOperation.Keep}

View Source StateBlock.js, line 391

number

stencilWrite

Value to write in the stencil buffer when stencil is active
Inherited From:
Default Value:
  • {0xFF}

View Source StateBlock.js, line 382

Methods

add(name, type, value) → {Pass}

Add a parameter to the material
Parameters:
Name Type Description
name string Parameter's name
type Type Parameter's type
value Array.<number> | number | boolean | Texture | Float32Array Parameter's value

View Source Material/Pass.js, line 80

A reference to the instance
Pass

getParameters() → {Array.<PassParameter>}

Return an array with all material's parameters

View Source Material/Pass.js, line 119

An array of PassParameter
Array.<PassParameter>

isEqual(state) → {boolean}

Check if the given StateBlock instance is equal to this one
Parameters:
Name Type Description
state StateBlock A StateBlock instance
Inherited From:

View Source StateBlock.js, line 418

True if the two states are equals, otherwise false
boolean

set(name, value) → {Pass}

Set parameter's value
Parameters:
Name Type Description
name string Parameter's name
value Array.<number> | number | boolean | Texture | Float32Array Parameter's value

View Source Material/Pass.js, line 103

A reference to the instance
Pass