Skip to content
flatland

LightEffectClass

LightEffectClass<S> = LightEffect & EffectValues<S> & EffectConstants<S>

Defined in: packages/three-flatland/src/lights/LightEffect.ts:720

Type for a LightEffect class created by the factory. Instances have typed properties matching the schema.

Type Parameters

Section titled “Type Parameters”

S

Section titled “S”

S extends EffectSchema

new LightEffectClass(): LightEffect & EffectValues<S> & EffectConstants<S>

Type for a LightEffect class created by the factory. Instances have typed properties matching the schema.

Returns

Section titled “Returns”

LightEffect & EffectValues<S> & EffectConstants<S>

Properties

Section titled “Properties”

_constantFactories

Section titled “_constantFactories”

readonly _constantFactories: Record<string, () => unknown>

Defined in: packages/three-flatland/src/lights/LightEffect.ts:730

_fieldKeys

Section titled “_fieldKeys”

readonly _fieldKeys: Readonly<Record<string, readonly string[]>>

Defined in: packages/three-flatland/src/lights/LightEffect.ts:727

_fieldMap

Section titled “_fieldMap”

readonly _fieldMap: ReadonlyMap<string, EffectField>

Defined in: packages/three-flatland/src/lights/LightEffect.ts:728

_fields

Section titled “_fields”

readonly _fields: EffectField[]

Defined in: packages/three-flatland/src/lights/LightEffect.ts:726

_initialized

Section titled “_initialized”

readonly _initialized: boolean

Defined in: packages/three-flatland/src/lights/LightEffect.ts:731

_totalFloats

Section titled “_totalFloats”

readonly _totalFloats: number

Defined in: packages/three-flatland/src/lights/LightEffect.ts:729

lightName

Section titled “lightName”

readonly lightName: string

Defined in: packages/three-flatland/src/lights/LightEffect.ts:722

lightSchema

Section titled “lightSchema”

readonly lightSchema: S

Defined in: packages/three-flatland/src/lights/LightEffect.ts:723

needsShadows

Section titled “needsShadows”

readonly needsShadows: boolean

Defined in: packages/three-flatland/src/lights/LightEffect.ts:724

requires

Section titled “requires”

readonly requires: readonly ChannelName[]

Defined in: packages/three-flatland/src/lights/LightEffect.ts:725

Methods

Section titled “Methods”

_initialize()

Section titled “_initialize()”

_initialize(): void

Defined in: packages/three-flatland/src/lights/LightEffect.ts:732

Returns

Section titled “Returns”

void

buildLightFn()

Section titled “buildLightFn()”

buildLightFn(context): ColorTransformFn

Defined in: packages/three-flatland/src/lights/LightEffect.ts:733

Parameters

Section titled “Parameters”
context
Section titled “context”

LightEffectBuildContext<S>

Returns

Section titled “Returns”

ColorTransformFn

DocsExamples

Getting Started

IntroductionInstallationQuick Start

Concepts

The Flatland PipelineBatch Rendering2D LightingShadows & OcclusionDevtools Architecture

Guides

SpritesSet up a Flatland sceneAlpha API MigrationPixel-Perfect RenderingAnimationLoadersTilemapsHit TestingLightingShadowsBakingTSL NodesPass EffectsSkiaSlug TextDevtools

Resources

BrandingLLMs

API Reference

nodes/src
Interfaces
CRTOptionsDissolveOptionsLight2DResultLitSpriteOptionsOutlineOptions
Type Aliases
ColorInputFloatInputVec2InputVec3InputVec4Input
Functions
afterimageafterimageGlowafterimageTintedalphaMaskalphaMaskInvertalphaMaskValuealphaTestalphaTestOpaqueambientLight2DanalogGlitchbayerDitherbayerDither2x2bayerDither4x4bayerDither8x8bloombloomAnamorphicbloomSimplebloomThresholdblurBoxblurBox3x3blurBoxDirectionalblurBoxSmoothblurFocusblurGaussianblurGaussian2PassblurGaussian9blurKawaseblurKawaseDownblurKawaseMultiblurKawaseSimpleblurKawaseUpblurMotionblurMotionObjectblurMotionVelocityblurRadialblurRadialDistanceblurShakeblurSpinbrightnessbrightnessClampedbrightnessMultiplyc64PalettecgaPalettechromaticAberrationchromaticAberrationCustomchromaticAberrationPulsechromaticAberrationRadialcolorBleedingcolorRemapcolorRemapCustomcolorReplacecolorReplaceHardcolorReplaceMultiplecontrastcontrastSCurvecrtBloomcrtColorBleedcrtCompletecrtConvergencecrtCurvaturecrtCurvatureWithCornerscrtVignettedirectionalLight2DdissolvedissolveDirectionaldissolvePixelateddissolveSimpledistortBarreldistortBulgedistortDisplacedistortNoisedistortPerlindistortPinchdistortPixelatedistortPixelateCountdistortShatterdistortSimplexdistortSpherizedistortTurbulencedistortTwirldmgPalettedotMatrixeaglefadeEdgefadeEdgeHorizontalfadeEdgeRadialfadeEdgeVerticalfilmGrainflashflashAdditiveflashAlphaflashDamageflashHealflashPowerUpflashSmoothgbcPaletteghostghostSpeedghostTrailglowSelectivegrayscalehq2xhq3xhq4xhueShifthueShiftNormalizedinterlacinglcdBacklightBleedlcdGBClcdGhostinglcdGridlcdMotionGhostlcdPocketlinearRgbToOklablinearRgbToOklchlitCelShadedlitDiffuselitRimlitSpecularlitSpritelitSpriteMultimd9bitPalettenormalFromHeightnormalFromHeightSmoothntscCompositeoklabLerpoklabToLinearRgboklabToRgboklchHueShiftoklchLerpoklchLightnessoklchSaturateoklchToLinearRgboklchToRgboutlineoutline8palettizepalettizeDitheredpalettizeNearestphosphorApertureGrillephosphorMaskphosphorShadowMaskphosphorSimplephosphorSlotMaskpixelatepixelateBySizepocketPalettepointLight2DposterizeposterizeGammappuPalettepulsepulseGlowpulseHeartbeatpulseRadialpulseRainbowquantizequantizeRGBrgbToOklabrgbToOklchsai2xsampleSpritesaturatescale2xscale3xscanlinesscanlinesGlowscanlinesGridscanlinesInterlacedscanlinesSmoothshadow2DshadowDropshadowDropSoftshadowSDF2DshadowSoft2DshimmershimmerHolographicshimmerMetallicshimmerWavesignalInterferencesnesPalettesparklesparkleRainbowsparkleStarspeedLinesspotLight2DspriteUVstaticNoisesuperEagletinttintAdditivetrailtrailAdditivetrailBlurtrailVelocityuvFlipuvOffsetuvRotateuvScalevbPalettevhsDistortionvignettewaveHorizontalwaveRadialwaveRipplewaveVerticalwaveWater
presets/src
Variables
DefaultLightEffectNormalMapProvider
three-flatland/src
Classes
AlphaMapAnimatedSprite2DAnimationControllerBatchQueryViewEffectMaterialFlatlandFlatlandConfigForwardPlusLightingGlobalUniformsLDtkLoaderLight2DLightEffectMaterialEffectPassEffectPixelPerfectCameraRenderingConfigSortLayerSortLayerGroupSprite2DSprite2DMaterialSpriteGroupSpriteSheetLoaderTextureConfigTextureLoaderTiledLoaderTileLayerTileMap2DTileset
Interfaces
AnimatedSprite2DOptionsAnimationAnimationFrameAnimationSetDefinitionAnimationStateAtlasJsonBatchKeyBatchQueryTagChannelNodeContextChannelNodeMapChunkCoordColorTransformContextDevtoolsProviderHandleEffectFieldEffectMaterialOptionsEffectNodeContextFlatlandConfigOptionsFlatlandOptionsInstanceAttributeConfigLDtkLoaderOptionsLight2DOptionsLight2DUniformsLightEffectBuildContextLightEffectRuntimeContextNormalRegionNormalSourceDescriptorObjectLayerDataOcclusionPassOptionsOklabOklchPassEffectContextPixelPerfectCameraOptionsPlayOptionsRayPlaneHitRemoteBridgeHandleRenderingOptionsRenderStatsResolveAlphaMapOptionsSortLayerConfigSortLayerDescriptorSortLayerRegistrySprite2DMaterialOptionsSprite2DOptionsSpriteFrameSpriteFrameRectSpriteGroupOptionsSpriteSheetSpriteSheetJSONArraySpriteSheetJSONHashSpriteSheetLoaderOptionsTextureLoaderOptionsTextureOptionsTileAnimationFrameTileDefinitionTiledLoaderOptionsTileInstanceTileLayerDataTileLayerOptionsTileMap2DOptionsTileMapDataTileMapObjectTileNormalCustomDataTilesetCellTilesetDataTilesetGridTilesetGridOptionsWebSocketLike
Type Aliases
BlendModeBuiltInSortLayerChannelNameClipRectCollisionShapeColorTransformFnEffectConstantsEffectSchemaEffectSchemaValueEffectValuesFlatlandPresetFlatlandSettingHitTestModeInstanceAttributeTypeLight2DTypeLightEffectClassMaterialEffectClassNormalBumpNormalDirectionObservableStrategyPassEffectClassPassEffectFnPixelScaleRenderingPresetRenderingSettingSnapshotSortLayerNameSortLayerValueSortModeSpriteSortFunctionTexturePresetTileLookupFnUniformKeysWithRequiredChannels
Variables
ALL_HIT_TEST_MODESALPHA_SIDECAR_DESCRIPTORchannelDefaultsEFFECT_BIT_OFFSETFLATLAND_PRESETSIsAlphaBlendedBatchIsAlphaTestedBatchIsLitBatchIsUnlitBatchLIT_FLAG_MASKMAX_LIGHTS_PER_TILEobservableRECEIVE_SHADOWS_MASKRENDERING_PRESETSSortLayersTEXTURE_PRESETSTILE_SIZEVERSION
Functions
analogousapplyHierarchicalPresetsapplyTextureOptionsbuildTilesetGridclampOklchcolorToOklabcolorToOklchcomplementarycomputeTierconcatAnimationscontrastRatiocreateAnimationcreateAnimationFromPatterncreateAnimationsFromNamingcreateConsumerRemoteBridgecreateDevtoolsProvidercreateIntersectioncreateLightEffectcreateMaterialEffectcreatePassEffectcreateProviderRemoteBridgedeclareSortLayerdecodeAlphaPngdecodeDebugMessagedecodeSortKeydeltaEOklabencodeDebugMessageencodeSortKeyequallySpacedHuesframesToRegionsgamutMapOklchgetPackedComponentgetSortLayergradientOklchisDevtoolsActiveisInGamutisLight2DlerpOklablerpOklchlinearRgbToOklablinearToSrgbmonochromaticPaletteoklabToColoroklabToLinearRgboklabToOklchoklchToColoroklchToOklabrayPlaneZ0readCastShadowFlagreadEnableBitsreadFlipreadLitFlagreadReceiveShadowsFlagreadShadowRadiusreadSystemFlagsregisterDebugArrayregisterDebugTexturerelativeLuminanceresolveAlphaMapresolveHitTestModeresolvePixelPerfectresolveRenderingOptionsresolveSortLayerresolveTextureOptionsreverseAnimationshallowEqualsplitComplementarysrgbToLineartetradictilesetCellAttilesetToRegionstileToRegionstouchDebugArraytouchDebugTexturetriadicunregisterDebugArrayunregisterDebugTextureuvToWorldwcagLevelwholeTextureRegionworldToUVwrapWithLightFlags
three-flatland/src/react
Interfaces
UsePixelPerfectCameraBindingOptionsUsePixelPerfectCameraOptions
Type Aliases
EffectElementLightEffectElement
Functions
attachEffectattachLightingcreateFlatlandComputeusePixelPerfectCamerausePixelPerfectCameraBinding