Application Settings

Blits provides a flexible and performant way to configure your application at launch using the settings object passed to Blits.Launch. These settings allow you to fine-tune rendering, performance, input, fonts, and more.

Below is a comprehensive overview of the available settings you can provide to a Blits Application:

Basic Settings

Setting	Type	Description
w	number	Width of the application (canvas)
h	number	Height of the application (canvas)
debugLevel	number | string[]	Debug level for console log messages
multithreaded	boolean	Enable multithreaded rendering

Fonts & Text

Setting	Type	Description
fonts	Font[]	Array of font objects to register
defaultFont	string	Default font family to use

Example font object:

{
  family: 'lato',
  type: 'msdf', // or 'web'
  file: 'fonts/Lato-Regular.ttf',
}

Rendering & Performance

Setting	Type	Description
renderQuality	'low' | 'medium' | 'high' | 'retina' | number	Controls render quality (1 = 100%)
screenResolution	'hd' | 'fhd' | '4k' | number	Sets device screen resolution
pixelRatio	number	Custom pixel ratio (overrides screenResolution)
canvasColor	string	Background color of the canvas
fpsInterval	number	Interval (ms) for FPS updates (0 disables)
webWorkersLimit	number	Max number of web workers for image handling
gpuMemory	object	GPU memory management (see below)
gpuMemoryLimit	number	(Deprecated) Use gpuMemory instead
textureProcessingTimeLimit	number	Max ms per frame for texture processing
viewportMargin	number | [number,number,number,number]	Extra margin for preloading elements
advanced	object	Advanced renderer settings (use with care)

GPU Memory Example

{
  max: 200, // MB
  target: 0.8, // 80% of max
  cleanupInterval: 5000, // ms
  baseline: 25, // MB
  strict: false
}

Input & Focus

Setting	Type	Description
keymap	object	Custom key mapping for input events
holdTimeout	number	Time (ms) to consider a key press as hold

Renderer

Setting	Type	Description
renderMode	'webgl' | 'canvas'	Renderer mode (default: 'webgl')
canvas	HTMLCanvasElement	Custom canvas to render to

Effects & Shaders

Setting	Type	Description
effects	ShaderEffect[]	Effects for DynamicShader
shaders	Shader[]	Custom shaders

Inspector & Debugging

Setting	Type	Description
inspector	boolean	Enable the inspector tool

Accessibility

Setting	Type	Description
announcer	boolean	Enable/disable text-to-speech announcer

Example Usage

Blits.Launch(App, 'app', {
  w: 1920,
  h: 1080,
  debugLevel: 1,
  renderQuality: 'high',
  fonts: [
    { family: 'lato', type: 'msdf', file: 'fonts/Lato-Regular.ttf' },
  ],
  keymap: {
    ArrowLeft: 'left',
    ArrowRight: 'right',
  },
  gpuMemory: {
    max: 200,
    target: 0.8,
    cleanupInterval: 5000,
    baseline: 25,
    strict: false,
  },
  inspector: false,
  announcer: true,
})