indigo.shared.config

Members list

Type members

Classlikes

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

Additional settings to help tune aspects of your game's performance.

Additional settings to help tune aspects of your game's performance.

Value parameters

antiAliasing

Smooth the rendered view? Defaults to false.

autoLoadStandardShaders

Should all the standard shaders be made available by default? They can be added individually / manually if you prefer. Defaults to true, to include them.

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.

premultipliedAlpha

Should the renderer use premultiplied alpha? All the standard shaders expect the answer to be yes! Disable with caution, defaults to true.

renderingTechnology

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class GameConfig(viewport: GameViewport, frameRateLimit: Option[FPS], clearColor: RGBA, magnification: Int, resizePolicy: ResizePolicy, 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.

frameRateLimit

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.

resizePolicy

Sets the policy for how Indigo games should resize themselves.

transparentBackground

Make the canvas background transparent.

viewport

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GameConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
GameConfig.type
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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GameViewport

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

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.

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

ResizePolicy instructs Indigo on how you would like the game to handle a change in viewport size.

ResizePolicy instructs Indigo on how you would like the game to handle a change in viewport size.

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all