Class MaterialStencilState
Hierarchy
- MaterialStencilState
Implements
- IStencilState
Index
Constructors
Accessors
Methods
Constructors
constructor
-
Creates a material stencil state instance
Returns MaterialStencilState
Accessors
enabled
-
Enables or disables the stencil test
Returns boolean
-
Enables or disables the stencil test
Parameters
-
value: boolean
Returns any
-
func
-
Gets or sets the stencil function
Returns number
-
Gets or sets the stencil function
Parameters
-
value: number
Returns any
-
func Mask
-
Gets or sets the stencil function mask
Returns number
-
Gets or sets the stencil function mask
Parameters
-
value: number
Returns any
-
func Ref
-
Gets or sets the stencil function reference
Returns number
-
Gets or sets the stencil function reference
Parameters
-
value: number
Returns any
-
mask
-
Gets or sets the stencil mask
Returns number
-
Gets or sets the stencil mask
Parameters
-
value: number
Returns any
-
op Depth Fail
-
Gets or sets the operation when the depth test fails
Returns number
-
Gets or sets the operation when the depth test fails
Parameters
-
value: number
Returns any
-
op Stencil Depth Pass
-
Gets or sets the operation when the stencil+depth test succeeds
Returns number
-
Gets or sets the operation when the stencil+depth test succeeds
Parameters
-
value: number
Returns any
-
op Stencil Fail
-
Gets or sets the operation when the stencil test fails
Returns number
-
Gets or sets the operation when the stencil test fails
Parameters
-
value: number
Returns any
-
Methods
copy ToSearch playground for copyTo
-
Makes a duplicate of the current configuration into another one.
Parameters
-
stencilState: MaterialStencilState
defines stencil state where to copy the info
Returns void
-
get Class NameSearch playground for getClassName
-
Get the current class name, useful for serialization or dynamic coding.
Returns string
"MaterialStencilState"
parseSearch playground for parse
-
Parses a stencil state configuration from a serialized object.
Parameters
-
source: any
Serialized object.
-
scene: Scene
Defines the scene we are parsing for
-
rootUrl: string
Defines the rootUrl to load from
Returns void
-
resetSearch playground for reset
-
Resets all the stencil states to default values
Returns void
serializeSearch playground for serialize
-
Serializes this stencil configuration.
Returns any
- An object with the serialized config.
Class that holds the different stencil states of a material Usage example: https://playground.babylonjs.com/#CW5PRI#10