Create a new Application instance.
Automatically registers these component systems with the application's component system registry:
The canvas element.
Optionaloptions: {The options object to configure the Application.
OptionalassetPrefix?: stringPrefix to apply to asset urls before loading.
OptionalelementInput?: ElementInputInput handler for ElementComponents.
Optionalgamepads?: GamePadsGamepad handler for input.
OptionalgraphicsDevice?: GraphicsDeviceThe graphics device used by the application. If not provided, a WebGl graphics device will be created.
OptionalgraphicsDeviceOptions?: anyOptions object that is passed into the GraphicsDevice constructor.
Optionalkeyboard?: KeyboardKeyboard handler for input.
Optionalmouse?: MouseMouse handler for input.
OptionalscriptPrefix?: stringPrefix to apply to script urls before loading.
OptionalscriptsOrder?: string[]Scripts in order of loading first.
Optionaltouch?: TouchDeviceTouchDevice handler for input.
The asset registry managed by the application.
When true, the application's render function is called every frame. Setting autoRender to false is useful to applications where the rendered image may often be unchanged over time. This can heavily reduce the application's load on the CPU and GPU. Defaults to true.
Used to handle input for ElementComponents.
Used to access GamePad input.
The graphics device used by the application.
Handles localization.
The keyboard device.
The run-time lightmapper.
The resource loader.
Clamps per-frame delta time to an upper bound. Useful since returning from a tab deactivation can generate huge values for dt, which can adversely affect game state. Defaults to 0.1 (seconds).
The mouse device.
Set to true to render the scene on the next iteration of the main loop. This only has an effect if autoRender is set to false. The value of renderNextFrame is set back to false again as soon as the scene has been rendered.
The root entity of the application.
The scene managed by the application.
The scene registry managed by the application.
The application's script registry.
Scripts in order of loading first.
The application's component system registry.
Scales the global time delta. Defaults to 1.
Used to get touch events input.
The XR Manager that provides ability to start VR/AR sessions.
The application's batch manager. The batch manager is used to merge mesh instances in the scene, which reduces the overall number of draw calls, thereby boosting performance.
The current fill mode of the canvas. Can be:
The current resolution mode of the canvas, Can be:
Apply scene settings to the current scene. Useful when your scene settings are parsed or generated from a non-URL source.
The scene settings to be applied.
The physics settings to be applied.
The world space vector representing global gravity in the physics simulation. Must be a fixed size array with three number elements, corresponding to each axis [ X, Y, Z ].
The rendering settings to be applied.
Enable baking ambient light into lightmaps.
Number of samples to use when baking ambient light.
Brightness of the baked ambient occlusion.
Contrast of the baked ambient occlusion.
How much of the sphere to include when baking ambient light.
Lux (lm/m^2) value for ambient light intensity.
Enable clustered lighting.
The exposure value tweaks the overall brightness of the scene.
The type of fog used by the scene. Can be:
The color of the fog (if enabled). Must be a fixed size array with three number elements, corresponding to each color channel [ R, G, B ].
The distance from the viewpoint where linear fog reaches its maximum. This property is only valid if the fog property is set to FOG_LINEAR.
The distance from the viewpoint where linear fog begins. This property is only valid if the fog property is set to FOG_LINEAR.
The gamma correction to apply when rendering the scene. Can be:
The color of the scene's ambient light. Must be a fixed size array with three number elements, corresponding to each color channel [ R, G, B ].
If set to true, the clustered lighting will support area lights.
Number of cells along each world space axis the space containing lights is subdivided into.
Only lights with bakeDir=true will be used for generating the dominant light direction.
Resolution of the atlas texture storing all non-directional cookie textures.
If set to true, the clustered lighting will support cookie textures.
Maximum number of lights a cell can store.
Resolution of the atlas texture storing all non-directional shadow textures.
If set to true, the clustered lighting will support shadows.
The type of shadow filtering used by all shadows. Can be:
The maximum lightmap resolution.
The lightmap baking mode. Can be:
The lightmap resolution multiplier.
Optionalskybox?: null | numberThe asset ID of the cube map texture to be used as the scene's skybox. Defaults to null.
Multiplier for skybox intensity.
Lux (lm/m^2) value for skybox intensity when physical light units are enabled.
The mip level of the skybox to be displayed. Only valid for prefiltered cubemap skyboxes.
Rotation of skybox.
The tonemapping transform to apply when writing fragments to the frame buffer. Can be:
const settings = {
physics: {
gravity: [0, -9.8, 0]
},
render: {
fog_end: 1000,
tonemapping: 0,
skybox: null,
fog_density: 0.01,
gamma_correction: 1,
exposure: 1,
fog_start: 1,
global_ambient: [0, 0, 0],
skyboxIntensity: 1,
skyboxRotation: [0, 0, 0],
fog_color: [0, 0, 0],
lightmapMode: 1,
fog: 'none',
lightmapMaxResolution: 2048,
skyboxMip: 2,
lightmapSizeMultiplier: 16
}
};
app.applySceneSettings(settings);
Load the application configuration file and apply application properties and fill the asset registry.
The URL of the configuration file to load.
The Function called when the configuration file is loaded and parsed (or an error occurs).
Draws a single line. Line start and end coordinates are specified in world space. The line will be flat-shaded with the specified color.
The start world space coordinate of the line.
The end world space coordinate of the line.
Optionalcolor: ColorThe color of the line. It defaults to white if not specified.
OptionaldepthTest: booleanSpecifies if the line is depth tested against the depth buffer. Defaults to true.
Optionallayer: LayerThe layer to render the line into. Defaults to LAYERID_IMMEDIATE.
// Render a 1-unit long white line
const start = new pc.Vec3(0, 0, 0);
const end = new pc.Vec3(1, 0, 0);
app.drawLine(start, end);
Renders an arbitrary number of discrete line segments. The lines are not connected by each subsequent point in the array. Instead, they are individual segments specified by two points.
An array of points to draw lines between. Each point is represented by 3 numbers - x, y and z coordinate.
A single color for all lines, or an array of colors to color the lines. If an array is specified, number of colors it stores must match the number of positions provided.
OptionaldepthTest: boolean = trueSpecifies if the lines are depth tested against the depth buffer. Defaults to true.
Optionallayer: Layer = ...The layer to render the lines into. Defaults to LAYERID_IMMEDIATE.
Renders an arbitrary number of discrete line segments. The lines are not connected by each subsequent point in the array. Instead, they are individual segments specified by two points. Therefore, the lengths of the supplied position and color arrays must be the same and also must be a multiple of 2. The colors of the ends of each line segment will be interpolated along the length of each line.
An array of points to draw lines between. The length of the array must be a multiple of 2.
An array of colors or a single color. If an array is specified, this must be the same length as the position array. The length of the array must also be a multiple of 2.
OptionaldepthTest: boolean = trueSpecifies if the lines are depth tested against the depth buffer. Defaults to true.
Optionallayer: Layer = ...The layer to render the lines into. Defaults to LAYERID_IMMEDIATE.
Fire an event, all additional arguments are passed on to the event listener.
Name of event to fire.
Optionalarg1: anyFirst argument that is passed to the event handler.
Optionalarg2: anySecond argument that is passed to the event handler.
Optionalarg3: anyThird argument that is passed to the event handler.
Optionalarg4: anyFourth argument that is passed to the event handler.
Optionalarg5: anyFifth argument that is passed to the event handler.
Optionalarg6: anySixth argument that is passed to the event handler.
Optionalarg7: anySeventh argument that is passed to the event handler.
Optionalarg8: anyEighth argument that is passed to the event handler.
Self for chaining.
Test if there are any handlers bound to an event name.
The name of the event to test.
True if the object has handlers bound to the specified event name.
Initialize the app.
Options specifying the init parameters for the app.
Queries the visibility of the window or tab in which the application is running.
True if the application is not visible and false otherwise.
Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.
Optionalname: stringName of the event to unbind.
Optionalcallback: HandleEventCallbackFunction to be unbound.
Optionalscope: anyScope that was used as the this when the event is fired.
Self for chaining.
const handler = () => {};
obj.on('test', handler);
obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this
Attach an event handler to an event.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optionalscope: any = ...Object to use as 'this' when the event is fired, defaults to current this.
Can be used for removing event in the future.
Attach an event handler to an event. This handler will be removed after being fired once.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optionalscope: any = ...Object to use as 'this' when the event is fired, defaults to current this.
Load all assets in the asset registry that are marked as 'preload'.
Function called when all assets are loaded.
Resize the application's canvas element in line with the current fill mode.
Optionalwidth: numberThe width of the canvas. Only used if current fill mode is FILLMODE_NONE.
Optionalheight: numberThe height of the canvas. Only used if current fill mode is FILLMODE_NONE.
A object containing the values calculated to use as width and height.
Sets the area light LUT tables for this app.
LUT table of type array to be set.
LUT table of type array to be set.
Controls how the canvas fills the window and resizes when the window changes.
The mode to use when setting the size of the canvas. Can be:
Optionalwidth: numberThe width of the canvas (only used when mode is FILLMODE_NONE).
Optionalheight: numberThe height of the canvas (only used when mode is FILLMODE_NONE).
Change the resolution of the canvas, and set the way it behaves when the window is resized.
The mode to use when setting the resolution. Can be:
Optionalwidth: numberThe horizontal resolution, optional in AUTO mode, if not provided canvas clientWidth is used.
Optionalheight: numberThe vertical resolution, optional in AUTO mode, if not provided canvas clientHeight is used.
Sets the skybox asset to current scene, and subscribes to asset load/change events.
Asset of type skybox to be set to, or null to remove skybox.
Start the application. This function does the following:
This function is called internally by PlayCanvas applications made in the Editor but you will need to call start yourself if you are using the engine stand-alone.
Update the application. This function will call the update functions and then the postUpdate functions of all enabled components. It will then update the current state of all connected input devices. This function is called internally in the application's main loop and does not need to be called explicitly.
The time delta in seconds since the last frame.
Updates the GraphicsDevice canvas size to match the canvas size on the document page. It is recommended to call this function when the canvas size changes (e.g on window resize and orientation change events) so that the canvas resolution is immediately updated.
StaticgetGet the current application. In the case where there are multiple running applications, the function can get an application based on a supplied canvas id. This function is particularly useful when the current Application is not readily available. For example, in the JavaScript console of the browser's developer tools.
Optionalid: stringIf defined, the returned application should use the canvas which has this id. Otherwise current application will be returned.
The running application, if any.
Application is a subclass of AppBase, which represents the base functionality for all PlayCanvas applications. It acts as a convenience class by internally registering all ComponentSystems and ResourceHandlers implemented in the PlayCanvas Engine. This makes app setup simple but results in the full engine being included when bundling your application.