[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Ffilter\u002Fdisplaceby":129},{"stars":4},5505,[6,11,15,19,23,27,31,35,39,43,47,51,55,59,63,67,72,76,80,84,88,93,97,101,105,109,113,117,121,125],{"path":7,"title":8,"description":9,"category":10},"\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",{"path":12,"title":13,"description":14,"category":10},"\u002Fdocs\u002Fguide\u002Fquickstart","Quickstart","Install Shaders, render your first effect, and drive a prop from state.",{"path":16,"title":17,"description":18,"category":10},"\u002Fdocs\u002Fguide\u002Fcomposing-effects","Composing effects","Stack components as layers and nest them to control which layers an effect touches.",{"path":20,"title":21,"description":22,"category":10},"\u002Fdocs\u002Fguide\u002Fblending-masking","Blending and masking","Control how a layer mixes with the layers below it, and reveal one layer through another.",{"path":24,"title":25,"description":26,"category":10},"\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":28,"title":29,"description":30,"category":10},"\u002Fdocs\u002Fguide\u002Fdynamic-props","Dynamic props","Drive any numeric or position prop from time, the cursor, or another layer, without writing animation code.",{"path":32,"title":33,"description":34,"category":10},"\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":36,"title":37,"description":38,"category":10},"\u002Fdocs\u002Fguide\u002Fsizing-and-units","Sizing and units","Size and place layers in CSS units (px, %, vw, rem, and canvas units) that stay correct as the canvas and window resize.",{"path":40,"title":41,"description":42,"category":10},"\u002Fdocs\u002Fguide\u002Ftransforms","Transforms","Position, size, and rotate any layer inside the canvas with a bounding box, in any CSS unit.",{"path":44,"title":45,"description":46,"category":10},"\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":48,"title":49,"description":50,"category":10},"\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":52,"title":53,"description":54,"category":10},"\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":56,"title":57,"description":58,"category":10},"\u002Fdocs\u002Fguide\u002Fperformance","Performance","Learn what makes an effect expensive on the GPU and how to keep it inside the frame budget.",{"path":60,"title":61,"description":62,"category":10},"\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":64,"title":65,"description":66,"category":10},"\u002Fdocs\u002Fguide\u002Ftelemetry","Telemetry","The `\u003CShader>` component occasionally sends an anonymous performance report to help us improve the engine over time.",{"path":68,"title":69,"description":70,"category":71},"\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":73,"title":74,"description":75,"category":71},"\u002Fdocs\u002Fguide\u002Fcli","Shaders CLI","Install your own shaders and Pro shaders into your codebase as component files, and keep them in sync with the design editor.",{"path":77,"title":78,"description":79,"category":71},"\u002Fdocs\u002Fguide\u002Fagent-skill","Agent skill","Give your coding agent a skill that teaches it to build with Shaders components, the CLI and Pro shaders.",{"path":81,"title":82,"description":83,"category":10},"\u002Fdocs\u002Fguide\u002Fvideo-rendering","Rendering to video","Turn a shader effect into a video file, from the design editor or from a frame-by-frame pipeline such as Remotion, Hyperframes or Puppeteer.",{"path":85,"title":86,"description":87,"category":10},"\u002Fdocs\u002Fguide\u002Fssr","Server rendering","Render Shaders in Next.js, Nuxt, SvelteKit, SolidStart and other SSR apps by keeping each shader on the client.",{"path":89,"title":90,"description":91,"category":92},"\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":94,"title":95,"description":96,"category":92},"\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":98,"title":99,"description":100,"category":92},"\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":102,"title":103,"description":104,"category":92},"\u002Fdocs\u002Fguide\u002Fmasking-and-blending","Masking and blending","How blend modes and masks combine components in the design editor.",{"path":106,"title":107,"description":108,"category":92},"\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":110,"title":111,"description":112,"category":92},"\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":114,"title":115,"description":116,"category":92},"\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":118,"title":119,"description":120,"category":92},"\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":122,"title":123,"description":124,"category":92},"\u002Fdocs\u002Fguide\u002Fglass-component-spotlight","Component spotlight: Glass","A short look at the Glass component and the liquid-glass look it creates.",{"path":126,"title":127,"description":128,"category":92},"\u002Fdocs\u002Fguide\u002Fdigital-looks-component-spotlight","Component spotlight: Digital looks","A look at the digital stylization components for glitchy, futuristic, or technical effects.",{"id":130,"title":131,"body":132,"categoryId":420,"categorySlug":420,"categoryTitle":421,"curated":422,"description":142,"editUrl":423,"extension":424,"group":425,"groupTitle":426,"kind":427,"meta":428,"navigation":429,"path":430,"seo":431,"sourceUrl":432,"stem":433,"wordCount":423,"__hash__":434},"primitives\u002Fdocs\u002Fprimitives\u002F25.filter\u002F3.displaceby.md","displaceBy",{"type":133,"value":134,"toc":414},"minimark",[135,139,143,196,206,250,255,305,309,368,382,386,400,404,410],[136,137,131],"h1",{"id":138},"displaceby",[140,141,142],"p",{},"Push the child's pixels around by a vector field from one of your simulations.",[144,145,150],"pre",{"className":146,"code":147,"language":148,"meta":149,"style":149},"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","",[10,151,152,164,184,190],{"__ignoreMap":149},[153,154,157,160],"span",{"class":155,"line":156},"line",1,[153,158,131],{"class":159},"svObZ",[153,161,163],{"class":162},"s95oV","(\n",[153,165,167,170,174,177,181],{"class":155,"line":166},2,[153,168,169],{"class":162},"  field: ",[153,171,173],{"class":172},"snl16","import",[153,175,176],{"class":162},"(",[153,178,180],{"class":179},"sU2Wk","'.\u002Fsim'",[153,182,183],{"class":162},").SimOutputRef,\n",[153,185,187],{"class":155,"line":186},3,[153,188,189],{"class":162},"  opts: {strength: PropRef; chromatic: PropRef; edges: PropRef},\n",[153,191,193],{"class":155,"line":192},4,[153,194,195],{"class":162},"): DisplaceByEffect\n",[140,197,198,199,201,202,205],{},"Import ",[10,200,131],{}," from ",[10,203,204],{},"shaders\u002Fstd",".",[140,207,208,211,212,201,215,218,219,222,223,226,227,230,231,234,235,238,239,238,242,245,246,249],{},[10,209,210],{},"field"," is a simulation output, such as ",[10,213,214],{},"waves.output('displacement')",[10,216,217],{},"simulate.grid",". ",[10,220,221],{},"strength"," scales the push (the library uses 0–20), capped at about 15% of the canvas. ",[10,224,225],{},"chromatic"," (0–3) splits red and blue slightly apart from green along the push, like a lens. ",[10,228,229],{},"edges"," is a prop marked ",[10,232,233],{},"compileTime: true"," holding ",[10,236,237],{},"'stretch'",", ",[10,240,241],{},"'transparent'",[10,243,244],{},"'mirror'"," or ",[10,247,248],{},"'wrap'",". Gather.",[251,252,254],"h2",{"id":253},"parameters","Parameters",[256,257,258,274],"table",{},[259,260,261],"thead",{},[262,263,264,268,271],"tr",{},[265,266,267],"th",{},"Name",[265,269,270],{},"Type",[265,272,273],{},"Notes",[275,276,277,291],"tbody",{},[262,278,279,284,289],{},[280,281,282],"td",{},[10,283,210],{},[280,285,286],{},[10,287,288],{},"import('.\u002Fsim').SimOutputRef",[280,290],{},[262,292,293,298,303],{},[280,294,295],{},[10,296,297],{},"opts",[280,299,300],{},[10,301,302],{},"{strength: PropRef; chromatic: PropRef; edges: PropRef}",[280,304],{},[251,306,308],{"id":307},"example","Example",[144,310,312],{"className":146,"code":311,"language":148,"meta":149,"style":149},"effect: displaceBy(waves.output('displacement'), {strength: p('intensity'), chromatic: p('chromaticSplit'), edges: p('edges')})\n",[10,313,314],{"__ignoreMap":149},[153,315,316,319,322,324,327,330,332,335,338,340,342,345,348,350,352,355,358,360,362,365],{"class":155,"line":156},[153,317,318],{"class":159},"effect",[153,320,321],{"class":162},": ",[153,323,131],{"class":159},[153,325,326],{"class":162},"(waves.",[153,328,329],{"class":159},"output",[153,331,176],{"class":162},[153,333,334],{"class":179},"'displacement'",[153,336,337],{"class":162},"), {strength: ",[153,339,140],{"class":159},[153,341,176],{"class":162},[153,343,344],{"class":179},"'intensity'",[153,346,347],{"class":162},"), chromatic: ",[153,349,140],{"class":159},[153,351,176],{"class":162},[153,353,354],{"class":179},"'chromaticSplit'",[153,356,357],{"class":162},"), edges: ",[153,359,140],{"class":159},[153,361,176],{"class":162},[153,363,364],{"class":179},"'edges'",[153,366,367],{"class":162},")})\n",[369,370,371],"blockquote",{},[140,372,373,377,378,381],{},[374,375,376],"strong",{},"Tip."," The simulation must derive the field with ",[10,379,380],{},"op.gradient()","; the definition fails loudly otherwise.",[251,383,385],{"id":384},"see-also","See also",[387,388,389],"ul",{},[390,391,392,399],"li",{},[393,394,396],"a",{"href":395},"\u002Fdocs\u002Fprimitives\u002Ffilter\u002Fgather",[10,397,398],{},"gather"," — Write your own gather effect: a function that can read the child anywhere.",[251,401,403],{"id":402},"used-by","Used by",[140,405,406],{},[393,407,409],{"href":408},"\u002Fdocs\u002Fcomponents\u002Fcursorripples","CursorRipples",[411,412,413],"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":149,"searchDepth":166,"depth":166,"links":415},[416,417,418,419],{"id":253,"depth":166,"text":254},{"id":307,"depth":166,"text":308},{"id":384,"depth":166,"text":385},{"id":402,"depth":166,"text":403},"filter","Filter effects",false,null,"md","effects","Filters & effects","function",{},true,"\u002Fdocs\u002Fprimitives\u002Ffilter\u002Fdisplaceby",{"title":131,"description":142},"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"]