[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fwarps\u002Fdisplacebylayer":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":221,"categorySlug":221,"categoryTitle":464,"curated":465,"description":158,"editUrl":9,"extension":466,"group":467,"groupTitle":468,"kind":469,"meta":470,"navigation":471,"path":472,"seo":473,"sourceUrl":474,"stem":475,"wordCount":9,"__hash__":476},"primitives\u002Fdocs\u002Fprimitives\u002F20.warps\u002F19.displacebylayer.md","displaceByLayer",{"type":149,"value":150,"toc":458},"minimark",[151,155,159,216,231,291,296,331,339,342,346,416,426,430,444,448,454],[152,153,147],"h1",{"id":154},"displacebylayer",[156,157,158],"p",{},"Distort the child using another layer's pixels as a displacement map.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","displaceByLayer(slots: {\n    source: PropRef\n    amount: ArgSpec\n    channels: PropRef\n    angle: ArgSpec\n    edges: PropRef\n}): GatherEffect\n","ts","",[8,167,168,180,186,192,198,204,210],{"__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","(slots: {\n",[169,181,183],{"class":171,"line":182},2,[169,184,185],{"class":178},"    source: PropRef\n",[169,187,189],{"class":171,"line":188},3,[169,190,191],{"class":178},"    amount: ArgSpec\n",[169,193,195],{"class":171,"line":194},4,[169,196,197],{"class":178},"    channels: PropRef\n",[169,199,201],{"class":171,"line":200},5,[169,202,203],{"class":178},"    angle: ArgSpec\n",[169,205,207],{"class":171,"line":206},6,[169,208,209],{"class":178},"    edges: PropRef\n",[169,211,213],{"class":171,"line":212},7,[169,214,215],{"class":178},"}): GatherEffect\n",[156,217,218,219,222,223,226,227,230],{},"Import ",[8,220,221],{},"warps"," from ",[8,224,225],{},"shaders\u002Fstd"," and use ",[8,228,229],{},"warps.displaceByLayer",".",[156,232,233,234,237,238,241,242,245,246,249,250,253,254,257,258,261,262,265,266,269,270,245,273,275,276,279,280,279,283,286,287,290],{},"This one goes in ",[8,235,236],{},"effect:",", not ",[8,239,240],{},"map:",", because it reads a second layer. ",[8,243,244],{},"source"," is a prop marked ",[8,247,248],{},"compileTime: true"," that holds the other layer's id. ",[8,251,252],{},"amount"," (0–1) sets how far pixels move. ",[8,255,256],{},"channels"," is a prop holding ",[8,259,260],{},"'twoAxis'"," (red moves x, green moves y) or ",[8,263,264],{},"'directional'"," (brightness pushes along ",[8,267,268],{},"angle",", in degrees). Mid-grey means no movement. ",[8,271,272],{},"edges",[8,274,248],{}," holding ",[8,277,278],{},"'stretch'",", ",[8,281,282],{},"'transparent'",[8,284,285],{},"'mirror'"," or ",[8,288,289],{},"'wrap'",". With no source selected the child passes through unchanged.",[292,293,295],"h2",{"id":294},"parameters","Parameters",[297,298,299,315],"table",{},[300,301,302],"thead",{},[303,304,305,309,312],"tr",{},[306,307,308],"th",{},"Name",[306,310,311],{},"Type",[306,313,314],{},"Notes",[316,317,318],"tbody",{},[303,319,320,326,329],{},[321,322,323],"td",{},[8,324,325],{},"slots",[321,327,328],{},"`{",[321,330],{},[160,332,337],{"className":333,"code":335,"language":336},[334],"language-text","source: PropRef\namount: ArgSpec\nchannels: PropRef\nangle: ArgSpec\nedges: PropRef\n","text",[8,338,335],{"__ignoreMap":165},[156,340,341],{},"}` |  |",[292,343,345],{"id":344},"example","Example",[160,347,349],{"className":162,"code":348,"language":164,"meta":165,"style":165},"effect: warps.displaceByLayer({source: p('source'), amount: p('amount'), channels: p('channelMode'), angle: p('angle'), edges: p('edges')})\n",[8,350,351],{"__ignoreMap":165},[169,352,353,356,359,361,364,366,369,373,376,378,380,383,386,388,390,393,396,398,400,403,406,408,410,413],{"class":171,"line":172},[169,354,355],{"class":175},"effect",[169,357,358],{"class":178},": warps.",[169,360,147],{"class":175},[169,362,363],{"class":178},"({source: ",[169,365,156],{"class":175},[169,367,368],{"class":178},"(",[169,370,372],{"class":371},"sU2Wk","'source'",[169,374,375],{"class":178},"), amount: ",[169,377,156],{"class":175},[169,379,368],{"class":178},[169,381,382],{"class":371},"'amount'",[169,384,385],{"class":178},"), channels: ",[169,387,156],{"class":175},[169,389,368],{"class":178},[169,391,392],{"class":371},"'channelMode'",[169,394,395],{"class":178},"), angle: ",[169,397,156],{"class":175},[169,399,368],{"class":178},[169,401,402],{"class":371},"'angle'",[169,404,405],{"class":178},"), edges: ",[169,407,156],{"class":175},[169,409,368],{"class":178},[169,411,412],{"class":371},"'edges'",[169,414,415],{"class":178},")})\n",[417,418,419],"blockquote",{},[156,420,421,425],{},[422,423,424],"strong",{},"Tip."," An animated source layer displaces live.",[292,427,429],{"id":428},"see-also","See also",[431,432,433],"ul",{},[434,435,436,443],"li",{},[437,438,440],"a",{"href":439},"\u002Fdocs\u002Fprimitives\u002Fwarps\u002Fliquiddisplace",[8,441,442],{},"liquidDisplace"," — Move the child smoothly by a displacement field your own simulation produces.",[292,445,447],{"id":446},"used-by","Used by",[156,449,450],{},[437,451,453],{"href":452},"\u002Fdocs\u002Fcomponents\u002Fdisplacementmap","DisplacementMap",[455,456,457],"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 .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);}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":165,"searchDepth":182,"depth":182,"links":459},[460,461,462,463],{"id":294,"depth":182,"text":295},{"id":344,"depth":182,"text":345},{"id":428,"depth":182,"text":429},{"id":446,"depth":182,"text":447},"Warps",false,"md","space","Shapes, frames & warps","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fwarps\u002Fdisplacebylayer",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fwarps.ts#L583","docs\u002Fprimitives\u002F20.warps\u002F19.displacebylayer","28dObEkI-1yPGFSuKAqfITF5JnSgiTq_bWF_h6R1TOc"]