-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
settings.ts
282 lines (261 loc) · 7.99 KB
/
settings.ts
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
import { GC_MODES, MIPMAP_MODES, PRECISION, SCALE_MODES, WRAP_MODES } from '@pixi/constants';
import { BrowserAdapter } from './adapter';
import { canUploadSameBuffer } from './utils/canUploadSameBuffer';
import { isMobile } from './utils/isMobile';
import { maxRecommendedTextures } from './utils/maxRecommendedTextures';
import type { ENV, MSAA_QUALITY } from '@pixi/constants';
import type { ICanvas } from './ICanvas';
import type { IAdapter } from './adapter';
export interface IRenderOptions
{
view: ICanvas;
antialias: boolean;
autoDensity: boolean;
backgroundColor: number | string;
background?: number | string;
backgroundAlpha: number;
premultipliedAlpha: boolean;
/** @deprecated */
useContextAlpha?: boolean | 'notMultiplied';
clearBeforeRender: boolean;
preserveDrawingBuffer: boolean;
width: number;
height: number;
legacy: boolean;
hello: boolean;
}
export interface ISettings
{
ADAPTER: IAdapter;
MIPMAP_TEXTURES: MIPMAP_MODES;
ANISOTROPIC_LEVEL: number;
RESOLUTION: number;
/** @deprecated */
FILTER_RESOLUTION?: number;
/** @deprecated */
FILTER_MULTISAMPLE?: MSAA_QUALITY;
SPRITE_MAX_TEXTURES: number;
SPRITE_BATCH_SIZE: number;
RENDER_OPTIONS: IRenderOptions;
GC_MODE: GC_MODES;
GC_MAX_IDLE: number;
GC_MAX_CHECK_COUNT: number;
WRAP_MODE: WRAP_MODES;
SCALE_MODE: SCALE_MODES;
PRECISION_VERTEX: PRECISION;
PRECISION_FRAGMENT: PRECISION;
CAN_UPLOAD_SAME_BUFFER: boolean;
CREATE_IMAGE_BITMAP: boolean;
ROUND_PIXELS: boolean;
RETINA_PREFIX?: RegExp;
FAIL_IF_MAJOR_PERFORMANCE_CAVEAT?: boolean;
UPLOADS_PER_FRAME?: number;
SORTABLE_CHILDREN?: boolean;
PREFER_ENV?: ENV;
STRICT_TEXTURE_CACHE?: boolean;
MESH_CANVAS_PADDING?: number;
TARGET_FPMS?: number;
}
/**
* User's customizable globals for overriding the default PIXI settings, such
* as a renderer's default resolution, framerate, float precision, etc.
* @example
* // Use the native window resolution as the default resolution
* // will support high-density displays when rendering
* PIXI.settings.RESOLUTION = window.devicePixelRatio;
*
* // Disable interpolation when scaling, will make texture be pixelated
* PIXI.settings.SCALE_MODE = PIXI.SCALE_MODES.NEAREST;
* @namespace PIXI.settings
*/
export const settings: ISettings = {
/**
* This adapter is used to call methods that are platform dependent.
* For example `document.createElement` only runs on the web but fails in node environments.
* This allows us to support more platforms by abstracting away specific implementations per platform.
*
* By default the adapter is set to work in the browser. However you can create your own
* by implementing the `IAdapter` interface. See `IAdapter` for more information.
* @name ADAPTER
* @memberof PIXI.settings
* @type {PIXI.IAdapter}
* @default PIXI.BrowserAdapter
*/
ADAPTER: BrowserAdapter,
/**
* Default mipmap mode for textures.
* @static
* @name MIPMAP_TEXTURES
* @memberof PIXI.settings
* @type {PIXI.MIPMAP_MODES}
* @default PIXI.MIPMAP_MODES.POW2
*/
MIPMAP_TEXTURES: MIPMAP_MODES.POW2,
/**
* Default anisotropic filtering level of textures.
* Usually from 0 to 16.
* @static
* @name ANISOTROPIC_LEVEL
* @memberof PIXI.settings
* @type {number}
* @default 0
*/
ANISOTROPIC_LEVEL: 0,
/**
* Default resolution / device pixel ratio of the renderer.
* @static
* @name RESOLUTION
* @memberof PIXI.settings
* @type {number}
* @default 1
*/
RESOLUTION: 1,
/**
* The maximum textures that this device supports.
* @static
* @name SPRITE_MAX_TEXTURES
* @memberof PIXI.settings
* @type {number}
* @default 32
*/
SPRITE_MAX_TEXTURES: maxRecommendedTextures(32),
// TODO: maybe change to SPRITE.BATCH_SIZE: 2000
// TODO: maybe add PARTICLE.BATCH_SIZE: 15000
/**
* The default sprite batch size.
*
* The default aims to balance desktop and mobile devices.
* @static
* @name SPRITE_BATCH_SIZE
* @memberof PIXI.settings
* @type {number}
* @default 4096
*/
SPRITE_BATCH_SIZE: 4096,
/**
* The default render options if none are supplied to {@link PIXI.Renderer}
* or {@link PIXI.CanvasRenderer}.
* @static
* @name RENDER_OPTIONS
* @memberof PIXI.settings
* @type {object}
* @property {PIXI.ICanvas} [view=null] -
* @property {boolean} [antialias=false] -
* @property {boolean} [autoDensity=false] -
* @property {boolean} [premultipliedAlpha=true] -
* @property {number} [backgroundColor=0x000000] -
* @property {number} [backgroundAlpha=1] -
* @property {boolean} [clearBeforeRender=true] -
* @property {boolean} [preserveDrawingBuffer=false] -
* @property {number} [width=800] -
* @property {number} [height=600] -
* @property {boolean} [legacy=false] -
* @property {boolean} [debug=false] -
*/
RENDER_OPTIONS: {
view: null,
antialias: false,
autoDensity: false,
backgroundColor: 0x000000,
backgroundAlpha: 1,
premultipliedAlpha: true,
clearBeforeRender: true,
preserveDrawingBuffer: false,
width: 800,
height: 600,
legacy: false,
hello: false,
},
/**
* Default Garbage Collection mode.
* @static
* @name GC_MODE
* @memberof PIXI.settings
* @type {PIXI.GC_MODES}
* @default PIXI.GC_MODES.AUTO
*/
GC_MODE: GC_MODES.AUTO,
/**
* Default Garbage Collection max idle.
* @static
* @name GC_MAX_IDLE
* @memberof PIXI.settings
* @type {number}
* @default 3600
*/
GC_MAX_IDLE: 60 * 60,
/**
* Default Garbage Collection maximum check count.
* @static
* @name GC_MAX_CHECK_COUNT
* @memberof PIXI.settings
* @type {number}
* @default 600
*/
GC_MAX_CHECK_COUNT: 60 * 10,
/**
* Default wrap modes that are supported by pixi.
* @static
* @name WRAP_MODE
* @memberof PIXI.settings
* @type {PIXI.WRAP_MODES}
* @default PIXI.WRAP_MODES.CLAMP
*/
WRAP_MODE: WRAP_MODES.CLAMP,
/**
* Default scale mode for textures.
* @static
* @name SCALE_MODE
* @memberof PIXI.settings
* @type {PIXI.SCALE_MODES}
* @default PIXI.SCALE_MODES.LINEAR
*/
SCALE_MODE: SCALE_MODES.LINEAR,
/**
* Default specify float precision in vertex shader.
* @static
* @name PRECISION_VERTEX
* @memberof PIXI.settings
* @type {PIXI.PRECISION}
* @default PIXI.PRECISION.HIGH
*/
PRECISION_VERTEX: PRECISION.HIGH,
/**
* Default specify float precision in fragment shader.
* iOS is best set at highp due to https://github.com/pixijs/pixijs/issues/3742
* @static
* @name PRECISION_FRAGMENT
* @memberof PIXI.settings
* @type {PIXI.PRECISION}
* @default PIXI.PRECISION.MEDIUM
*/
PRECISION_FRAGMENT: isMobile.apple.device ? PRECISION.HIGH : PRECISION.MEDIUM,
/**
* Can we upload the same buffer in a single frame?
* @static
* @name CAN_UPLOAD_SAME_BUFFER
* @memberof PIXI.settings
* @type {boolean}
*/
CAN_UPLOAD_SAME_BUFFER: canUploadSameBuffer(),
/**
* Enables bitmap creation before image load. This feature is experimental.
* @static
* @name CREATE_IMAGE_BITMAP
* @memberof PIXI.settings
* @type {boolean}
* @default false
*/
CREATE_IMAGE_BITMAP: false,
/**
* If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation.
* Advantages can include sharper image quality (like text) and faster rendering on canvas.
* The main disadvantage is movement of objects may appear less smooth.
* @static
* @constant
* @memberof PIXI.settings
* @type {boolean}
* @default false
*/
ROUND_PIXELS: false,
};