Skip to content

EffectConstants

EffectConstants<S> = { [K in ConstantKeys<S>]: S[K] extends () => infer R ? R : never }

Defined in: packages/three-flatland/src/materials/MaterialEffect.ts:52

Read-only constants from factory function fields. The reference is frozen at construction time and cannot be reassigned, but the object’s internals are freely mutable and mutations take effect immediately (e.g. this.forwardPlus.resize(w, h) works live — no remove/re-add needed).

Type Parameters

S

S extends EffectSchema

Docs Examples Showcases

Getting Started

Introduction Installation Quick Start

Concepts

The Flatland Pipeline Batch Rendering 2D Lighting Shadows & Occlusion

Guides

Sprites Animation Loaders Tilemaps Lighting Shadows Baking TSL Nodes Pass Effects Skia Slug Text Devtools

Resources

API Reference

nodes/src

Interfaces

CRTOptions DissolveOptions Light2DResult LitSpriteOptions OutlineOptions

Type Aliases

ColorInput FloatInput Vec2Input Vec3Input Vec4Input

Functions

afterimage afterimageGlow afterimageTinted alphaMask alphaMaskInvert alphaMaskValue alphaTest alphaTestOpaque ambientLight2D analogGlitch bayerDither bayerDither2x2 bayerDither4x4 bayerDither8x8 bloom bloomAnamorphic bloomSimple bloomThreshold blurBox blurBox3x3 blurBoxDirectional blurBoxSmooth blurFocus blurGaussian blurGaussian2Pass blurGaussian9 blurKawase blurKawaseDown blurKawaseMulti blurKawaseSimple blurKawaseUp blurMotion blurMotionObject blurMotionVelocity blurRadial blurRadialDistance blurShake blurSpin brightness brightnessClamped brightnessMultiply c64Palette cgaPalette chromaticAberration chromaticAberrationCustom chromaticAberrationPulse chromaticAberrationRadial colorBleeding colorRemap colorRemapCustom colorReplace colorReplaceHard colorReplaceMultiple contrast contrastSCurve crtBloom crtColorBleed crtComplete crtConvergence crtCurvature crtCurvatureWithCorners crtVignette directionalLight2D dissolve dissolveDirectional dissolvePixelated dissolveSimple distortBarrel distortBulge distortDisplace distortNoise distortPerlin distortPinch distortPixelate distortPixelateCount distortShatter distortSimplex distortSpherize distortTurbulence distortTwirl dmgPalette dotMatrix eagle fadeEdge fadeEdgeHorizontal fadeEdgeRadial fadeEdgeVertical filmGrain flash flashAdditive flashAlpha flashDamage flashHeal flashPowerUp flashSmooth gbcPalette ghost ghostSpeed ghostTrail glowSelective grayscale hq2x hq3x hq4x hueShift hueShiftNormalized interlacing lcdBacklightBleed lcdGBC lcdGhosting lcdGrid lcdMotionGhost lcdPocket litCelShaded litDiffuse litRim litSpecular litSprite litSpriteMulti md9bitPalette normalFromHeight normalFromHeightSmooth ntscComposite outline outline8 palettize palettizeDithered palettizeNearest phosphorApertureGrille phosphorMask phosphorShadowMask phosphorSimple phosphorSlotMask pixelate pixelateBySize pocketPalette pointLight2D posterize posterizeGamma ppuPalette pulse pulseGlow pulseHeartbeat pulseRadial pulseRainbow quantize quantizeRGB sai2x sampleSprite saturate scale2x scale3x scanlines scanlinesGlow scanlinesGrid scanlinesInterlaced scanlinesSmooth shadow2D shadowDrop shadowDropSoft shadowSDF2D shadowSoft2D shimmer shimmerHolographic shimmerMetallic shimmerWave signalInterference snesPalette sparkle sparkleRainbow sparkleStar speedLines spotLight2D spriteUV staticNoise superEagle tint tintAdditive trail trailAdditive trailBlur trailVelocity uvFlip uvOffset uvRotate uvScale vbPalette vhsDistortion vignette waveHorizontal waveRadial waveRipple waveVertical waveWater

presets/src

Variables

DefaultLightEffect NormalMapProvider

three-flatland/src

Classes

AnimatedSprite2D AnimationController EffectMaterial Flatland ForwardPlusLighting GlobalUniforms Layer LDtkLoader Light2D LightEffect MaterialEffect PassEffect Sprite2D Sprite2DMaterial SpriteGroup SpriteSheetLoader TextureConfig TextureLoader TiledLoader TileLayer TileMap2D Tileset

Interfaces

AnimatedSprite2DOptions Animation AnimationFrame AnimationSetDefinition AnimationState BatchKey ChannelNodeContext ChannelNodeMap ChunkCoord ColorTransformContext DevtoolsProviderHandle EffectField EffectMaterialOptions EffectNodeContext FlatlandOptions InstanceAttributeConfig LayerConfig LDtkLoaderOptions Light2DOptions Light2DUniforms LightEffectBuildContext LightEffectRuntimeContext NormalRegion NormalSourceDescriptor ObjectLayerData OcclusionPassOptions PassEffectContext PlayOptions RenderStats Sprite2DMaterialOptions Sprite2DOptions SpriteFrame SpriteFrameRect SpriteGroupOptions SpriteSheet SpriteSheetJSONArray SpriteSheetJSONHash SpriteSheetLoaderOptions TextureLoaderOptions TextureOptions TileAnimationFrame TileDefinition TiledLoaderOptions TileInstance TileLayerData TileLayerOptions TileMap2DOptions TileMapData TileMapObject TileNormalCustomData TilesetCell TilesetData

Type Aliases

BlendMode ChannelName CollisionShape ColorTransformFn EffectConstants EffectSchema EffectSchemaValue EffectValues InstanceAttributeType LayerName LayerType LayerValue Light2DType LightEffectClass MaterialEffectClass NormalBump NormalDirection ObservableStrategy PassEffectClass PassEffectFn Snapshot SortMode SpriteSortFunction TexturePreset TileLookupFn UniformKeys WithRequiredChannels

Variables

channelDefaults DEFAULT_BATCH_SIZE EFFECT_BIT_OFFSET Layers LIT_FLAG_MASK MAX_LIGHTS_PER_TILE observable RECEIVE_SHADOWS_MASK TEXTURE_PRESETS TILE_SIZE VERSION

Functions

applyHierarchicalPresets applyTextureOptions computeTier concatAnimations createAnimation createAnimationFromPattern createAnimationsFromNaming createDevtoolsProvider createLightEffect createMaterialEffect createPassEffect decodeSortKey encodeSortKey framesToRegions getPackedComponent isDevtoolsActive isLight2D readCastShadowFlag readEnableBits readFlip readLitFlag readReceiveShadowsFlag readShadowRadius readSystemFlags registerDebugArray registerDebugTexture resolveTextureOptions reverseAnimation shallowEqual tilesetToRegions tileToRegions touchDebugArray touchDebugTexture unregisterDebugArray unregisterDebugTexture uvToWorld wholeTextureRegion worldToUV wrapWithLightFlags

three-flatland/src/react

Type Aliases

EffectElement LightEffectElement

Functions

attachEffect attachLighting