[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agentframe\u002Ffitjitteredgrid":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":404,"categorySlug":405,"categoryTitle":406,"curated":407,"description":408,"editUrl":9,"extension":409,"group":410,"groupTitle":411,"kind":412,"meta":413,"navigation":414,"path":415,"seo":416,"sourceUrl":417,"stem":418,"wordCount":9,"__hash__":419},"primitives\u002Fdocs\u002Fprimitives\u002F42.sim-agentframe\u002F4.fitjitteredgrid.md","fitJitteredGrid",{"type":149,"value":150,"toc":399},"minimark",[151,155,167,212,227,233,240,245,305,309,358,362,395],[152,153,147],"h1",{"id":154},"fitjitteredgrid",[156,157,158,159,162,163,166],"p",{},"A grid of about ",[8,160,161],{},"count"," roughly square cells over the canvas plus an ",[8,164,165],{},"overscan"," border on every side, for agents that rest on a jittered grid.",[168,169,174],"pre",{"className":170,"code":171,"language":172,"meta":173,"style":173},"language-ts shiki shiki-themes github-dark","fitJitteredGrid(\n  count: number,\n  domainX: number,\n  overscan: number,\n): { cols: number; cellW: number; cellH: number; }\n","ts","",[8,175,176,188,194,200,206],{"__ignoreMap":173},[177,178,181,184],"span",{"class":179,"line":180},"line",1,[177,182,147],{"class":183},"svObZ",[177,185,187],{"class":186},"s95oV","(\n",[177,189,191],{"class":179,"line":190},2,[177,192,193],{"class":186},"  count: number,\n",[177,195,197],{"class":179,"line":196},3,[177,198,199],{"class":186},"  domainX: number,\n",[177,201,203],{"class":179,"line":202},4,[177,204,205],{"class":186},"  overscan: number,\n",[177,207,209],{"class":179,"line":208},5,[177,210,211],{"class":186},"): { cols: number; cellW: number; cellH: number; }\n",[156,213,214,215,218,219,222,223,226],{},"Import ",[8,216,217],{},"sim"," from ",[8,220,221],{},"shaders\u002Fstd"," and use ",[8,224,225],{},"sim.agentFrame.fitJitteredGrid",".",[156,228,229,232],{},[8,230,231],{},"domainX"," is the canvas width in heights (the aspect).",[156,234,235,236,239],{},"Returns the column count and the cell size, which ",[8,237,238],{},"field.jitteredGridHome"," reads.",[241,242,244],"h2",{"id":243},"parameters","Parameters",[246,247,248,264],"table",{},[249,250,251],"thead",{},[252,253,254,258,261],"tr",{},[255,256,257],"th",{},"Name",[255,259,260],{},"Type",[255,262,263],{},"Notes",[265,266,267,281,293],"tbody",{},[252,268,269,274,279],{},[270,271,272],"td",{},[8,273,161],{},[270,275,276],{},[8,277,278],{},"number",[270,280],{},[252,282,283,287,291],{},[270,284,285],{},[8,286,231],{},[270,288,289],{},[8,290,278],{},[270,292],{},[252,294,295,299,303],{},[270,296,297],{},[8,298,165],{},[270,300,301],{},[8,302,278],{},[270,304],{},[241,306,308],{"id":307},"example","Example",[168,310,312],{"className":170,"code":311,"language":172,"meta":173,"style":173},"const {cols, cellW, cellH} = agentFrame.fitJitteredGrid(count, domainX, 0.1)\n",[8,313,314],{"__ignoreMap":173},[177,315,316,320,323,327,330,333,335,338,341,344,347,349,352,355],{"class":179,"line":180},[177,317,319],{"class":318},"snl16","const",[177,321,322],{"class":186}," {",[177,324,326],{"class":325},"sDLfK","cols",[177,328,329],{"class":186},", ",[177,331,332],{"class":325},"cellW",[177,334,329],{"class":186},[177,336,337],{"class":325},"cellH",[177,339,340],{"class":186},"} ",[177,342,343],{"class":318},"=",[177,345,346],{"class":186}," agentFrame.",[177,348,147],{"class":183},[177,350,351],{"class":186},"(count, domainX, ",[177,353,354],{"class":325},"0.1",[177,356,357],{"class":186},")\n",[241,359,361],{"id":360},"see-also","See also",[363,364,365,386],"ul",{},[366,367,368,375,376,378,379,382,383,226],"li",{},[369,370,372],"a",{"href":371},"\u002Fdocs\u002Fprimitives\u002Fsim-agentframe\u002Ffitisogrid",[8,373,374],{},"fitIsoGrid"," — A W×H grid of square cells holding about ",[8,377,161],{}," agents at the canvas ",[8,380,381],{},"aspect",", each side clamped to ",[8,384,385],{},"[min, max]",[366,387,388,394],{},[369,389,391],{"href":390},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Ffield",[8,392,393],{},"field"," — What a turning agent samples at its position: the magnetic field at the cursor, and its resting place on a jittered grid.",[396,397,398],"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 .snl16, html code.shiki .snl16{--shiki-default:#F97583}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}",{"title":173,"searchDepth":190,"depth":190,"links":400},[401,402,403],{"id":243,"depth":190,"text":244},{"id":307,"depth":190,"text":308},{"id":360,"depth":190,"text":361},"sim.agentFrame","sim-agentframe","Agent frame",false,"A grid of about `count` roughly square cells over the canvas plus an `overscan` border on every side, for agents that rest on a jittered grid.","md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agentframe\u002Ffitjitteredgrid",{"title":147,"description":408},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002FagentFrame.ts#L191","docs\u002Fprimitives\u002F42.sim-agentframe\u002F4.fitjitteredgrid","dphXvhLV0qPtDbTVzIOsfQLZeQ9qA82xpbSDfiJ1xEE"]