indigo.shared.config

Type members

Classlikes

final case class AdvancedGameConfig(renderingTechnology: RenderingTechnology, antiAliasing: Boolean, batchSize: Int, premultipliedAlpha: Boolean, autoLoadStandardShaders: Boolean, disableContextMenu: Boolean)

Additional settings to help tune a games performance.

Additional settings to help tune a games performance.

Value parameters:
antiAliasing

Smooth the rendered view? Defaults to false.

batchSize

How many scene nodes to batch together between draws, defaults to 256.

disableContextMenu

By default, context menu on right-click is disable for the canvas.

renderingTechnology

Use WebGL 1.0 or 2.0? Defaults to 2.0 with fallback to 1.0.

Companion:
object
Companion:
class
final case class GameConfig(viewport: GameViewport, frameRateLimit: Option[FPS], clearColor: RGBA, magnification: Int, transparentBackground: Boolean, advanced: AdvancedGameConfig)

All the base settings needed to get a game up and running.

All the base settings needed to get a game up and running.

Value parameters:
advanced

Additional settings to help tune your game.

clearColor

Default background colour. Defaults to Black.

frameRate

Optionally throttles frame rate. By default (None), the browser sets the limits, recommended unless you specifically need a lower framerate.

magnification

Pixel magnification level. Defaults to 1.

transparentBackground

Make the canvas background transparent.

viewport

How big is the window initially? Defaults to 550 x 400 pixels.

Companion:
object
object GameConfig
Companion:
class
final case class GameViewport(size: Size)

Respresents the initial size of the game's viewport.

Respresents the initial size of the game's viewport.

Value parameters:
height

Height in pixels

width

Width in pixels

Companion:
object
Companion:
class

ADT that specifies which renderer to use. The default is to try and use WebGL 2.0 and fallback to WebGL 1.0, but you can force one or the other.

ADT that specifies which renderer to use. The default is to try and use WebGL 2.0 and fallback to WebGL 1.0, but you can force one or the other.

Companion:
object
Companion:
class