UNPKG

2.04 kBTypeScriptView Raw
1import { BLEND_MODES } from '@pixi/constants';
2/**
3 * This is a WebGL state, and is is passed to {@link PIXI.StateSystem}.
4 *
5 * Each mesh rendered may require WebGL to be in a different state.
6 * For example you may want different blend mode or to enable polygon offsets
7 * @memberof PIXI
8 */
9export declare class State {
10 data: number;
11 _blendMode: BLEND_MODES;
12 _polygonOffset: number;
13 constructor();
14 /**
15 * Activates blending of the computed fragment color values.
16 * @default true
17 */
18 get blend(): boolean;
19 set blend(value: boolean);
20 /**
21 * Activates adding an offset to depth values of polygon's fragments
22 * @default false
23 */
24 get offsets(): boolean;
25 set offsets(value: boolean);
26 /**
27 * Activates culling of polygons.
28 * @default false
29 */
30 get culling(): boolean;
31 set culling(value: boolean);
32 /**
33 * Activates depth comparisons and updates to the depth buffer.
34 * @default false
35 */
36 get depthTest(): boolean;
37 set depthTest(value: boolean);
38 /**
39 * Enables or disables writing to the depth buffer.
40 * @default true
41 */
42 get depthMask(): boolean;
43 set depthMask(value: boolean);
44 /**
45 * Specifies whether or not front or back-facing polygons can be culled.
46 * @default false
47 */
48 get clockwiseFrontFace(): boolean;
49 set clockwiseFrontFace(value: boolean);
50 /**
51 * The blend mode to be applied when this state is set. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode.
52 * Setting this mode to anything other than NO_BLEND will automatically switch blending on.
53 * @default PIXI.BLEND_MODES.NORMAL
54 */
55 get blendMode(): BLEND_MODES;
56 set blendMode(value: BLEND_MODES);
57 /**
58 * The polygon offset. Setting this property to anything other than 0 will automatically enable polygon offset fill.
59 * @default 0
60 */
61 get polygonOffset(): number;
62 set polygonOffset(value: number);
63 toString(): string;
64 static for2d(): State;
65}