forked from pmndrs/postprocessing
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMaskMaterial.js
More file actions
256 lines (176 loc) · 4.05 KB
/
MaskMaterial.js
File metadata and controls
256 lines (176 loc) · 4.05 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
import { NoBlending, ShaderMaterial, Uniform, UnsignedByteType } from "three";
import { ColorChannel, MaskFunction } from "../enums/index.js";
import fragmentShader from "./glsl/mask.frag";
import vertexShader from "./glsl/common.vert";
/**
* A mask shader material.
*
* This material applies a mask texture to a buffer.
*/
export class MaskMaterial extends ShaderMaterial {
/**
* Constructs a new mask material.
*
* @param {Texture} [maskTexture] - The mask texture.
*/
constructor(maskTexture = null) {
super({
name: "MaskMaterial",
uniforms: {
maskTexture: new Uniform(maskTexture),
inputBuffer: new Uniform(null),
strength: new Uniform(1.0)
},
blending: NoBlending,
toneMapped: false,
depthWrite: false,
depthTest: false,
fragmentShader,
vertexShader
});
this.colorChannel = ColorChannel.RED;
this.maskFunction = MaskFunction.DISCARD;
}
/**
* The input buffer.
*
* @type {Texture}
*/
set inputBuffer(value) {
this.uniforms.inputBuffer.value = value;
}
/**
* Sets the input buffer.
*
* @deprecated Use inputBuffer instead.
* @param {Texture} value - The input buffer.
*/
setInputBuffer(value) {
this.uniforms.inputBuffer.value = value;
}
/**
* The mask texture.
*
* @type {Texture}
*/
set maskTexture(value) {
this.uniforms.maskTexture.value = value;
delete this.defines.MASK_PRECISION_HIGH;
if(value.type !== UnsignedByteType) {
this.defines.MASK_PRECISION_HIGH = "1";
}
this.needsUpdate = true;
}
/**
* Sets the mask texture.
*
* @deprecated Use maskTexture instead.
* @param {Texture} value - The texture.
*/
setMaskTexture(value) {
this.maskTexture = value;
}
/**
* Sets the color channel to use for masking. Default is `ColorChannel.RED`.
*
* @type {ColorChannel}
*/
set colorChannel(value) {
this.defines.COLOR_CHANNEL = value.toFixed(0);
this.needsUpdate = true;
}
/**
* Sets the color channel to use for masking. Default is `ColorChannel.RED`.
*
* @deprecated Use colorChannel instead.
* @param {ColorChannel} value - The channel.
*/
setColorChannel(value) {
this.colorChannel = value;
}
/**
* The masking technique. Default is `MaskFunction.DISCARD`.
*
* @type {MaskFunction}
*/
set maskFunction(value) {
this.defines.MASK_FUNCTION = value.toFixed(0);
this.needsUpdate = true;
}
/**
* Sets the masking technique. Default is `MaskFunction.DISCARD`.
*
* @deprecated Use maskFunction instead.
* @param {MaskFunction} value - The function.
*/
setMaskFunction(value) {
this.maskFunction = value;
}
/**
* Indicates whether the masking is inverted.
*
* @type {Boolean}
*/
get inverted() {
return (this.defines.INVERTED !== undefined);
}
set inverted(value) {
if(this.inverted && !value) {
delete this.defines.INVERTED;
} else if(value) {
this.defines.INVERTED = "1";
}
this.needsUpdate = true;
}
/**
* Indicates whether the masking is inverted.
*
* @deprecated Use inverted instead.
* @return {Boolean} Whether the masking is inverted.
*/
isInverted() {
return this.inverted;
}
/**
* Determines whether the masking should be inverted.
*
* @deprecated Use inverted instead.
* @param {Boolean} value - Whether the masking should be inverted.
*/
setInverted(value) {
this.inverted = value;
}
/**
* The current mask strength.
*
* Individual mask values will be clamped to [0.0, 1.0]. Has no effect when the mask function is set to `DISCARD`.
*
* @type {Number}
*/
get strength() {
return this.uniforms.strength.value;
}
set strength(value) {
this.uniforms.strength.value = value;
}
/**
* Returns the current mask strength.
*
* @deprecated Use strength instead.
* @return {Number} The mask strength.
*/
getStrength() {
return this.strength;
}
/**
* Sets the mask strength.
*
* Has no effect when the mask function is set to `DISCARD`.
*
* @deprecated Use strength instead.
* @param {Number} value - The mask strength.
*/
setStrength(value) {
this.strength = value;
}
}