Skip to content
flatland

distortBarrel

distortBarrel(uv, strength?, zoom?): Node <"vec2">

Defined in: packages/nodes/src/distortion/distort.ts:124

Barrel distortion - simulates lens distortion. Commonly used for CRT screen curvature simulation.

Parameters

Section titled “Parameters”

uv

Section titled “uv”

Node <"vec2">

Input UV coordinates (should be 0-1)

strength?

Section titled “strength?”

FloatInput = 0.1

Distortion strength (positive = barrel, negative = pincushion)

zoom?

Section titled “zoom?”

FloatInput = 1

Zoom adjustment to compensate for distortion (default: 1)

Returns

Section titled “Returns”

Node <"vec2">

Distorted UV coordinates

Example

Section titled “Example”
// CRT-like barrel distortion
const curved = distortBarrel(uv, 0.2)
Docs Examples Showcases

Getting Started

IntroductionInstallationQuick Start

Concepts

The Flatland PipelineBatch Rendering2D LightingShadows & Occlusion

Guides

SpritesAnimationLoadersTilemapsLightingShadowsBakingTSL NodesPass EffectsSkiaSlug TextDevtools

Resources

BrandingLLMs

API Reference

nodes/src
Interfaces
CRTOptionsDissolveOptionsLight2DResultLitSpriteOptionsOutlineOptions
Type Aliases
ColorInputFloatInputVec2InputVec3InputVec4Input
Functions
afterimageafterimageGlowafterimageTintedalphaMaskalphaMaskInvertalphaMaskValuealphaTestalphaTestOpaqueambientLight2DanalogGlitchbayerDitherbayerDither2x2bayerDither4x4bayerDither8x8bloombloomAnamorphicbloomSimplebloomThresholdblurBoxblurBox3x3blurBoxDirectionalblurBoxSmoothblurFocusblurGaussianblurGaussian2PassblurGaussian9blurKawaseblurKawaseDownblurKawaseMultiblurKawaseSimpleblurKawaseUpblurMotionblurMotionObjectblurMotionVelocityblurRadialblurRadialDistanceblurShakeblurSpinbrightnessbrightnessClampedbrightnessMultiplyc64PalettecgaPalettechromaticAberrationchromaticAberrationCustomchromaticAberrationPulsechromaticAberrationRadialcolorBleedingcolorRemapcolorRemapCustomcolorReplacecolorReplaceHardcolorReplaceMultiplecontrastcontrastSCurvecrtBloomcrtColorBleedcrtCompletecrtConvergencecrtCurvaturecrtCurvatureWithCornerscrtVignettedirectionalLight2DdissolvedissolveDirectionaldissolvePixelateddissolveSimpledistortBarreldistortBulgedistortDisplacedistortNoisedistortPerlindistortPinchdistortPixelatedistortPixelateCountdistortShatterdistortSimplexdistortSpherizedistortTurbulencedistortTwirldmgPalettedotMatrixeaglefadeEdgefadeEdgeHorizontalfadeEdgeRadialfadeEdgeVerticalfilmGrainflashflashAdditiveflashAlphaflashDamageflashHealflashPowerUpflashSmoothgbcPaletteghostghostSpeedghostTrailglowSelectivegrayscalehq2xhq3xhq4xhueShifthueShiftNormalizedinterlacinglcdBacklightBleedlcdGBClcdGhostinglcdGridlcdMotionGhostlcdPocketlitCelShadedlitDiffuselitRimlitSpecularlitSpritelitSpriteMultimd9bitPalettenormalFromHeightnormalFromHeightSmoothntscCompositeoutlineoutline8palettizepalettizeDitheredpalettizeNearestphosphorApertureGrillephosphorMaskphosphorShadowMaskphosphorSimplephosphorSlotMaskpixelatepixelateBySizepocketPalettepointLight2DposterizeposterizeGammappuPalettepulsepulseGlowpulseHeartbeatpulseRadialpulseRainbowquantizequantizeRGBsai2xsampleSpritesaturatescale2xscale3xscanlinesscanlinesGlowscanlinesGridscanlinesInterlacedscanlinesSmoothshadow2DshadowDropshadowDropSoftshadowSDF2DshadowSoft2DshimmershimmerHolographicshimmerMetallicshimmerWavesignalInterferencesnesPalettesparklesparkleRainbowsparkleStarspeedLinesspotLight2DspriteUVstaticNoisesuperEagletinttintAdditivetrailtrailAdditivetrailBlurtrailVelocityuvFlipuvOffsetuvRotateuvScalevbPalettevhsDistortionvignettewaveHorizontalwaveRadialwaveRipplewaveVerticalwaveWater
presets/src
Variables
DefaultLightEffectNormalMapProvider
three-flatland/src
Classes
AnimatedSprite2DAnimationControllerEffectMaterialFlatlandForwardPlusLightingGlobalUniformsLayerLDtkLoaderLight2DLightEffectMaterialEffectPassEffectSprite2DSprite2DMaterialSpriteGroupSpriteSheetLoaderTextureConfigTextureLoaderTiledLoaderTileLayerTileMap2DTileset
Interfaces
AnimatedSprite2DOptionsAnimationAnimationFrameAnimationSetDefinitionAnimationStateBatchKeyChannelNodeContextChannelNodeMapChunkCoordColorTransformContextDevtoolsProviderHandleEffectFieldEffectMaterialOptionsEffectNodeContextFlatlandOptionsInstanceAttributeConfigLayerConfigLDtkLoaderOptionsLight2DOptionsLight2DUniformsLightEffectBuildContextLightEffectRuntimeContextNormalRegionNormalSourceDescriptorObjectLayerDataOcclusionPassOptionsPassEffectContextPlayOptionsRenderStatsSprite2DMaterialOptionsSprite2DOptionsSpriteFrameSpriteFrameRectSpriteGroupOptionsSpriteSheetSpriteSheetJSONArraySpriteSheetJSONHashSpriteSheetLoaderOptionsTextureLoaderOptionsTextureOptionsTileAnimationFrameTileDefinitionTiledLoaderOptionsTileInstanceTileLayerDataTileLayerOptionsTileMap2DOptionsTileMapDataTileMapObjectTileNormalCustomDataTilesetCellTilesetData
Type Aliases
BlendModeChannelNameCollisionShapeColorTransformFnEffectConstantsEffectSchemaEffectSchemaValueEffectValuesInstanceAttributeTypeLayerNameLayerTypeLayerValueLight2DTypeLightEffectClassMaterialEffectClassNormalBumpNormalDirectionObservableStrategyPassEffectClassPassEffectFnSnapshotSortModeSpriteSortFunctionTexturePresetTileLookupFnUniformKeysWithRequiredChannels
Variables
channelDefaultsDEFAULT_BATCH_SIZEEFFECT_BIT_OFFSETLayersLIT_FLAG_MASKMAX_LIGHTS_PER_TILEobservableRECEIVE_SHADOWS_MASKTEXTURE_PRESETSTILE_SIZEVERSION
Functions
applyHierarchicalPresetsapplyTextureOptionscomputeTierconcatAnimationscreateAnimationcreateAnimationFromPatterncreateAnimationsFromNamingcreateDevtoolsProvidercreateLightEffectcreateMaterialEffectcreatePassEffectdecodeSortKeyencodeSortKeyframesToRegionsgetPackedComponentisDevtoolsActiveisLight2DreadCastShadowFlagreadEnableBitsreadFlipreadLitFlagreadReceiveShadowsFlagreadShadowRadiusreadSystemFlagsregisterDebugArrayregisterDebugTextureresolveTextureOptionsreverseAnimationshallowEqualtilesetToRegionstileToRegionstouchDebugArraytouchDebugTextureunregisterDebugArrayunregisterDebugTextureuvToWorldwholeTextureRegionworldToUVwrapWithLightFlags
three-flatland/src/react
Type Aliases
EffectElementLightEffectElement
Functions
attachEffectattachLighting