Skip to content
flatland

SpriteFrame

Defined in: packages/three-flatland/src/sprites/types.ts:31

Properties

Section titled “Properties”

height

Section titled “height”

height: number

Defined in: packages/three-flatland/src/sprites/types.ts:41

Height in atlas (normalized 0-1)

mesh?

Section titled “mesh?”

optional mesh?: SpriteFrameMesh | null

Defined in: packages/three-flatland/src/sprites/types.ts:55

Tight polygon mesh for the alpha-blend path; null/absent = synth quad.

name

Section titled “name”

name: string

Defined in: packages/three-flatland/src/sprites/types.ts:33

Frame name/identifier

pivot?

Section titled “pivot?”

optional pivot?: object

Defined in: packages/three-flatland/src/sprites/types.ts:47

Pivot point (0-1)

x

Section titled “x”

x: number

y

Section titled “y”

y: number

rotated?

Section titled “rotated?”

optional rotated?: boolean

Defined in: packages/three-flatland/src/sprites/types.ts:49

Is frame rotated 90deg in atlas?

sourceHeight

Section titled “sourceHeight”

sourceHeight: number

Defined in: packages/three-flatland/src/sprites/types.ts:45

Original frame height in pixels

sourceWidth

Section titled “sourceWidth”

sourceWidth: number

Defined in: packages/three-flatland/src/sprites/types.ts:43

Original frame width in pixels

trimmed?

Section titled “trimmed?”

optional trimmed?: boolean

Defined in: packages/three-flatland/src/sprites/types.ts:51

Is frame trimmed?

trimOffset?

Section titled “trimOffset?”

optional trimOffset?: object

Defined in: packages/three-flatland/src/sprites/types.ts:53

Trim offset if trimmed

height

Section titled “height”

height: number

width

Section titled “width”

width: number

x

Section titled “x”

x: number

y

Section titled “y”

y: number

width

Section titled “width”

width: number

Defined in: packages/three-flatland/src/sprites/types.ts:39

Width in atlas (normalized 0-1)

x

Section titled “x”

x: number

Defined in: packages/three-flatland/src/sprites/types.ts:35

X position in atlas (normalized 0-1)

y

Section titled “y”

y: number

Defined in: packages/three-flatland/src/sprites/types.ts:37

Y position in atlas (normalized 0-1)

DocsExamples

Getting Started

IntroductionInstallationQuick Start

Concepts

The Flatland PipelineBatch Rendering2D LightingShadows & OcclusionDevtools Architecture

Guides

SpritesAlpha 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