FlatlandConfig

Defined in: packages/three-flatland/src/config/FlatlandConfig.ts:57

Library-wide configuration above rendering and texture-specific defaults.

The system defaults to 'pixel-art', coordinating integer camera scaling, projected-pivot snapping, and pixel-art texture loading. More-specific subsystem, class, and instance options can override either branch.

Example

FlatlandConfig.options = 'smooth'

// Or customize one branch while retaining the pixel-art system defaults.
FlatlandConfig.options = { texture: 'smooth' }

Constructors

Constructor

new FlatlandConfig(): FlatlandConfig

Returns

FlatlandConfig

Accessors

options

Get Signature

get static options(): FlatlandSetting

Defined in: packages/three-flatland/src/config/FlatlandConfig.ts:60

Returns

FlatlandSetting

Set Signature

set static options(value): void

Defined in: packages/three-flatland/src/config/FlatlandConfig.ts:64

Parameters

value

FlatlandSetting

Returns

void

---

resolved

Get Signature

get static resolved(): Readonly<Required<FlatlandConfigOptions>>

Defined in: packages/three-flatland/src/config/FlatlandConfig.ts:69

Fully resolved library-wide options.

Returns

Readonly<Required<FlatlandConfigOptions>>

Methods

reset()

static reset(): void

Defined in: packages/three-flatland/src/config/FlatlandConfig.ts:74

Reset the library-wide setting to the coordinated 'pixel-art' preset.

Returns

void