[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fop":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":380,"categorySlug":380,"categoryTitle":411,"curated":412,"description":157,"editUrl":9,"extension":413,"group":414,"groupTitle":415,"kind":416,"meta":417,"navigation":418,"path":419,"seo":420,"sourceUrl":421,"stem":422,"wordCount":9,"__hash__":423},"primitives\u002Fdocs\u002Fprimitives\u002F36.simulate\u002F3.op.md","op",{"type":149,"value":150,"toc":405},"minimark",[151,154,158,179,189,214,219,310,327,331,367,371,391,395,401],[152,153,147],"h1",{"id":147},[155,156,157],"p",{},"The steps and outputs a grid simulation is built from.",[159,160,165],"pre",{"className":161,"code":162,"language":163,"meta":164,"style":164},"language-ts shiki shiki-themes github-dark","op: { wave, splat, gradient }\n","ts","",[8,166,167],{"__ignoreMap":164},[168,169,172,175],"span",{"class":170,"line":171},"line",1,[168,173,147],{"class":174},"svObZ",[168,176,178],{"class":177},"s95oV",": { wave, splat, gradient }\n",[155,180,181,182,184,185,188],{},"Import ",[8,183,147],{}," from ",[8,186,187],{},"shaders\u002Fstd",".",[155,190,191,194,195,198,199,202,203,206,207,210,211,188],{},[8,192,193],{},"op.wave"," and ",[8,196,197],{},"op.splat"," go in ",[8,200,201],{},"step"," and run in order once per frame. ",[8,204,205],{},"op.gradient"," goes in ",[8,208,209],{},"derive",", named, and becomes an output an effect can read with ",[8,212,213],{},"sim.output('name')",[215,216,218],"h2",{"id":217},"example","Example",[159,220,222],{"className":161,"code":221,"language":163,"meta":164,"style":164},"step: [op.wave({damping: p('decay')}), op.splat({at: pointer({teleportGuard: 'on'}), amount: pointerSpeed({max: 2}), radius: p('radius')})],\nderive: {displacement: op.gradient()},\n",[8,223,224,290],{"__ignoreMap":164},[168,225,226,228,231,234,237,239,242,246,249,252,255,258,261,264,267,270,273,277,280,282,284,287],{"class":170,"line":171},[168,227,201],{"class":174},[168,229,230],{"class":177},": [op.",[168,232,233],{"class":174},"wave",[168,235,236],{"class":177},"({damping: ",[168,238,155],{"class":174},[168,240,241],{"class":177},"(",[168,243,245],{"class":244},"sU2Wk","'decay'",[168,247,248],{"class":177},")}), op.",[168,250,251],{"class":174},"splat",[168,253,254],{"class":177},"({at: ",[168,256,257],{"class":174},"pointer",[168,259,260],{"class":177},"({teleportGuard: ",[168,262,263],{"class":244},"'on'",[168,265,266],{"class":177},"}), amount: ",[168,268,269],{"class":174},"pointerSpeed",[168,271,272],{"class":177},"({max: ",[168,274,276],{"class":275},"sDLfK","2",[168,278,279],{"class":177},"}), radius: ",[168,281,155],{"class":174},[168,283,241],{"class":177},[168,285,286],{"class":244},"'radius'",[168,288,289],{"class":177},")})],\n",[168,291,293,295,298,301,304,307],{"class":170,"line":292},2,[168,294,209],{"class":174},[168,296,297],{"class":177},": {",[168,299,300],{"class":174},"displacement",[168,302,303],{"class":177},": op.",[168,305,306],{"class":174},"gradient",[168,308,309],{"class":177},"()},\n",[311,312,313],"blockquote",{},[155,314,315,319,320,323,324,326],{},[316,317,318],"strong",{},"Tip."," The current engine implements exactly ",[8,321,322],{},"[op.wave, op.splat]"," with ",[8,325,205],{}," derived. Other combinations throw at definition time.",[215,328,330],{"id":329},"members","Members",[332,333,334,348,356],"ul",{},[335,336,337,343,344,347],"li",{},[338,339,341],"a",{"href":340},"\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fop-wave",[8,342,193],{}," — A wave step: the grid ripples outward from any disturbance and fades by ",[8,345,346],{},"damping"," (a prop, 0–20).",[335,349,350,355],{},[338,351,353],{"href":352},"\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fop-splat",[8,354,197],{}," — A brush step: a soft round push into the grid at the pointer, scaled by how fast it moves.",[335,357,358,363,364,188],{},[338,359,361],{"href":360},"\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fop-gradient",[8,362,205],{}," — A derived output: the grid's slope at every cell as a 2D vector, ready for ",[8,365,366],{},"displaceBy",[215,368,370],{"id":369},"see-also","See also",[332,372,373,382],{},[335,374,375,381],{},[338,376,378],{"href":377},"\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fsimulate",[8,379,380],{},"simulate"," — Declare a simulation the engine runs for you.",[335,383,384,390],{},[338,385,387],{"href":386},"\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fgridsim",[8,388,389],{},"GridSim"," — A declared grid simulation.",[215,392,394],{"id":393},"used-by","Used by",[155,396,397],{},[338,398,400],{"href":399},"\u002Fdocs\u002Fcomponents\u002Fcursorripples","CursorRipples",[402,403,404],"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}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}",{"title":164,"searchDepth":292,"depth":292,"links":406},[407,408,409,410],{"id":217,"depth":292,"text":218},{"id":329,"depth":292,"text":330},{"id":369,"depth":292,"text":370},{"id":393,"depth":292,"text":394},"Simulate",false,"md","simulation","Simulation","object",{},true,"\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fop",{"title":147,"description":157},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim.ts#L85","docs\u002Fprimitives\u002F36.simulate\u002F3.op","JOj_FPWT7-xJEXhH1_1a3Q378cXK6i9kK5TTuE_1AYU"]