[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Ffilter\u002Fdisplaceby":145},[4,10,16,20,24,28,32,36,40,44,48,52,56,60,64,69,73,78,82,86,90,94,98,102,106,110,114,117,120,124,127,131,134,138,141],{"path":5,"title":6,"description":7,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide","Getting started","Shaders is a library of GPU effect components for Vue, React, Svelte, Solid, JavaScript and Framer, with a design editor for building with them.","code",null,{"path":11,"title":12,"description":13,"category":8,"exclude":14,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fquickstart","Quickstart","Install Shaders, render your first effect, and drive a prop from state.",[15],"js",{"path":17,"title":18,"description":19,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcomposing-effects","Composing effects","Stack components as layers and nest them to control which layers an effect touches.",{"path":21,"title":22,"description":23,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fblending-masking","Blending and masking","Control how a layer mixes with the layers below it, and reveal one layer through another.",{"path":25,"title":26,"description":27,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fprops-reactivity","Props and reactivity","Bind props to your framework's state so effects update when it changes, and animate props with an animation library.",{"path":29,"title":30,"description":31,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fdynamic-props","Dynamic props","Drive any numeric or position prop from time, the cursor, or another layer, without writing animation code.",{"path":33,"title":34,"description":35,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Flayout-positioning","Layout and positioning","Size and place a shader in your page with CSS, as a background, a fill, or an inline block.",{"path":37,"title":38,"description":39,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Ftransforms","Transforms","Position, size, and rotate any layer inside the canvas with a bounding box, in % or px units.",{"path":41,"title":42,"description":43,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fshape-effects","Shape effects","Pick the 2D, 3D or custom SVG shape that Glass, Neon, Emboss and other shape effects draw inside.",{"path":45,"title":46,"description":47,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcolor-space","Color space","Match colors to your design tool with the output color space, and keep bright layers from clipping with tone mapping.",{"path":49,"title":50,"description":51,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fhooks-events","Hooks and events","Run code when an effect is ready to show, and show a fallback when the GPU can't run it.",{"path":53,"title":54,"description":55,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fperformance","Performance","Learn what makes an effect expensive on the GPU and how to keep it inside the frame budget.",{"path":57,"title":58,"description":59,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcustom-shaders","Custom components","Write your own component in TypeScript, use it like any component in the library, and write WGSL by hand when you need to.",{"path":61,"title":62,"description":63,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Ftelemetry","Telemetry","The `\u003CShader>` component occasionally sends an anonymous performance report to help us improve the engine over time.",{"path":65,"title":66,"description":67,"category":68,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fmcp","Shaders MCP","Connect your AI coding agent to Shaders so it can find, install and edit effects in your codebase.","workflows",{"path":70,"title":71,"description":72,"category":68,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcli","Shaders CLI","Install shaders and presets into your codebase as component files, and keep them in sync with the design editor.",{"path":74,"title":75,"description":76,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fquick-tour-of-the-design-editor","Quick tour of the design editor","A short walkthrough of the full Shaders workflow, from designing on the infinite canvas to exporting code.","editor",{"path":79,"title":80,"description":81,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fintro-to-the-interface","Intro to the interface","A tour of the design editor interface: the canvas, layers, the Properties panel, and the ways to share and export.",{"path":83,"title":84,"description":85,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcomposing-your-first-shader-effect","Composing your first shader effect","Building a first shader effect in the design editor by stacking and nesting components as layers.",{"path":87,"title":88,"description":89,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fmasking-and-blending","Masking and blending","How blend modes and masks combine components in the design editor.",{"path":91,"title":92,"description":93,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fdynamic-prop-mapping","Dynamic prop mapping","Turning static props into dynamic ones in the design editor: mapping one layer's output into another's prop, following the cursor, or animating automatically.",{"path":95,"title":96,"description":97,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcustom-media-and-transformations","Custom media and transformations","Uploading images, videos, and SVG files to the media gallery, adding them to a composition, and placing them with transformations.",{"path":99,"title":100,"description":101,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Finstalling-a-shader-via-mcp","Installing a shader via MCP","Installing a shader from the design editor into a hero section with the Shaders MCP.",{"path":103,"title":104,"description":105,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fexploring-shape-effects","Exploring shape effects","Applying shape effects such as liquid glass, liquid metal, and glowing edges to built-in shapes and your own SVG.",{"path":107,"title":108,"description":109,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fglass-component-spotlight","Component spotlight: Glass","A short look at the Glass component and the liquid-glass look it creates.",{"path":111,"title":112,"description":113,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fdigital-looks-component-spotlight","Component spotlight: Digital looks","A look at the digital stylization components for glitchy, futuristic, or technical effects.",{"path":115,"title":12,"description":116,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fjs\u002Fquickstart","Install Shaders without a framework, render your first effect on a canvas, and update props at runtime.",{"path":118,"title":12,"description":119,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Freact\u002Fquickstart","Install Shaders in a React app, render your first effect, and drive a prop from state.",{"path":121,"title":122,"description":123,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Freact\u002Fssr","Next.js and SSR","Render Shaders in Next.js and other React SSR apps by keeping each shader on the client.",{"path":125,"title":12,"description":126,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsolid\u002Fquickstart","Install Shaders in a Solid app, render your first effect, and drive a prop from a signal.",{"path":128,"title":129,"description":130,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsolid\u002Fssr","SolidStart and SSR","Render Shaders in SolidStart and other Solid SSR apps by keeping each shader on the client.",{"path":132,"title":12,"description":133,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsvelte\u002Fquickstart","Install Shaders in a Svelte app, render your first effect, and drive a prop from state.",{"path":135,"title":136,"description":137,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsvelte\u002Fssr","SvelteKit and SSR","Render Shaders in SvelteKit and other Svelte SSR apps, where each shader already waits for the browser.",{"path":139,"title":12,"description":140,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fvue\u002Fquickstart","Install Shaders in a Vue app, render your first effect, and drive a prop from a ref.",{"path":142,"title":143,"description":144,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fvue\u002Fssr","Nuxt and SSR","Render Shaders in Nuxt and other Vue SSR apps by keeping each shader on the client.",{"id":146,"title":147,"body":148,"categoryId":436,"categorySlug":436,"categoryTitle":437,"curated":438,"description":158,"editUrl":9,"extension":439,"group":440,"groupTitle":441,"kind":442,"meta":443,"navigation":444,"path":445,"seo":446,"sourceUrl":447,"stem":448,"wordCount":9,"__hash__":449},"primitives\u002Fdocs\u002Fprimitives\u002F25.filter\u002F3.displaceby.md","displaceBy",{"type":149,"value":150,"toc":430},"minimark",[151,155,159,212,222,266,271,321,325,384,398,402,416,420,426],[152,153,147],"h1",{"id":154},"displaceby",[156,157,158],"p",{},"Push the child's pixels around by a vector field from one of your simulations.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","displaceBy(\n  field: import('.\u002Fsim').SimOutputRef,\n  opts: {strength: PropRef; chromatic: PropRef; edges: PropRef},\n): DisplaceByEffect\n","ts","",[8,167,168,180,200,206],{"__ignoreMap":165},[169,170,173,176],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(\n",[169,181,183,186,190,193,197],{"class":171,"line":182},2,[169,184,185],{"class":178},"  field: ",[169,187,189],{"class":188},"snl16","import",[169,191,192],{"class":178},"(",[169,194,196],{"class":195},"sU2Wk","'.\u002Fsim'",[169,198,199],{"class":178},").SimOutputRef,\n",[169,201,203],{"class":171,"line":202},3,[169,204,205],{"class":178},"  opts: {strength: PropRef; chromatic: PropRef; edges: PropRef},\n",[169,207,209],{"class":171,"line":208},4,[169,210,211],{"class":178},"): DisplaceByEffect\n",[156,213,214,215,217,218,221],{},"Import ",[8,216,147],{}," from ",[8,219,220],{},"shaders\u002Fstd",".",[156,223,224,227,228,217,231,234,235,238,239,242,243,246,247,250,251,254,255,254,258,261,262,265],{},[8,225,226],{},"field"," is a simulation output, such as ",[8,229,230],{},"waves.output('displacement')",[8,232,233],{},"simulate.grid",". ",[8,236,237],{},"strength"," scales the push (the library uses 0–20), capped at about 15% of the canvas. ",[8,240,241],{},"chromatic"," (0–3) splits red and blue slightly apart from green along the push, like a lens. ",[8,244,245],{},"edges"," is a prop marked ",[8,248,249],{},"compileTime: true"," holding ",[8,252,253],{},"'stretch'",", ",[8,256,257],{},"'transparent'",[8,259,260],{},"'mirror'"," or ",[8,263,264],{},"'wrap'",". Gather.",[267,268,270],"h2",{"id":269},"parameters","Parameters",[272,273,274,290],"table",{},[275,276,277],"thead",{},[278,279,280,284,287],"tr",{},[281,282,283],"th",{},"Name",[281,285,286],{},"Type",[281,288,289],{},"Notes",[291,292,293,307],"tbody",{},[278,294,295,300,305],{},[296,297,298],"td",{},[8,299,226],{},[296,301,302],{},[8,303,304],{},"import('.\u002Fsim').SimOutputRef",[296,306],{},[278,308,309,314,319],{},[296,310,311],{},[8,312,313],{},"opts",[296,315,316],{},[8,317,318],{},"{strength: PropRef; chromatic: PropRef; edges: PropRef}",[296,320],{},[267,322,324],{"id":323},"example","Example",[160,326,328],{"className":162,"code":327,"language":164,"meta":165,"style":165},"effect: displaceBy(waves.output('displacement'), {strength: p('intensity'), chromatic: p('chromaticSplit'), edges: p('edges')})\n",[8,329,330],{"__ignoreMap":165},[169,331,332,335,338,340,343,346,348,351,354,356,358,361,364,366,368,371,374,376,378,381],{"class":171,"line":172},[169,333,334],{"class":175},"effect",[169,336,337],{"class":178},": ",[169,339,147],{"class":175},[169,341,342],{"class":178},"(waves.",[169,344,345],{"class":175},"output",[169,347,192],{"class":178},[169,349,350],{"class":195},"'displacement'",[169,352,353],{"class":178},"), {strength: ",[169,355,156],{"class":175},[169,357,192],{"class":178},[169,359,360],{"class":195},"'intensity'",[169,362,363],{"class":178},"), chromatic: ",[169,365,156],{"class":175},[169,367,192],{"class":178},[169,369,370],{"class":195},"'chromaticSplit'",[169,372,373],{"class":178},"), edges: ",[169,375,156],{"class":175},[169,377,192],{"class":178},[169,379,380],{"class":195},"'edges'",[169,382,383],{"class":178},")})\n",[385,386,387],"blockquote",{},[156,388,389,393,394,397],{},[390,391,392],"strong",{},"Tip."," The simulation must derive the field with ",[8,395,396],{},"op.gradient()","; the definition fails loudly otherwise.",[267,399,401],{"id":400},"see-also","See also",[403,404,405],"ul",{},[406,407,408,415],"li",{},[409,410,412],"a",{"href":411},"\u002Fdocs\u002Fprimitives\u002Ffilter\u002Fgather",[8,413,414],{},"gather"," — Write your own gather effect: a function that can read the child anywhere.",[267,417,419],{"id":418},"used-by","Used by",[156,421,422],{},[409,423,425],{"href":424},"\u002Fdocs\u002Fcomponents\u002Fcursorripples","CursorRipples",[427,428,429],"style",{},"html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}html pre.shiki code .s95oV, html code.shiki .s95oV{--shiki-default:#E1E4E8}html pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}",{"title":165,"searchDepth":182,"depth":182,"links":431},[432,433,434,435],{"id":269,"depth":182,"text":270},{"id":323,"depth":182,"text":324},{"id":400,"depth":182,"text":401},{"id":418,"depth":182,"text":419},"filter","Filter effects",false,"md","effects","Filters & effects","function",{},true,"\u002Fdocs\u002Fprimitives\u002Ffilter\u002Fdisplaceby",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Ffilter.ts#L80","docs\u002Fprimitives\u002F25.filter\u002F3.displaceby","8xgql6KuVSqHVh-0O5z9lQR2YesXtq1vlru1lg0TuB0"]