[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Ftrackedviewport":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":452,"categorySlug":453,"categoryTitle":454,"curated":455,"description":158,"editUrl":9,"extension":456,"group":457,"groupTitle":458,"kind":459,"meta":460,"navigation":461,"path":462,"seo":463,"sourceUrl":464,"stem":465,"wordCount":9,"__hash__":466},"primitives\u002Fdocs\u002Fprimitives\u002F37.sim-grids\u002F13.trackedviewport.md","trackedViewport",{"type":149,"value":150,"toc":446},"minimark",[151,155,159,264,279,289,294,331,335,414,418,432,436,442],[152,153,147],"h1",{"id":154},"trackedviewport",[156,157,158],"p",{},"The canvas size in pixels, kept current across resizes, in the two forms a stage wants.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","trackedViewport(params: GpuFragmentParams): {\n    tracked(): {width: number; height: number}\n    safe(fp: GridFrameParams): {width: number; height: number}\n}\n","ts","",[8,167,168,180,219,259],{"__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","(params: GpuFragmentParams): {\n",[169,181,183,186,189,193,196,200,202,206,209,212,214,216],{"class":171,"line":182},2,[169,184,185],{"class":175},"    tracked",[169,187,188],{"class":178},"()",[169,190,192],{"class":191},"snl16",":",[169,194,195],{"class":178}," {",[169,197,199],{"class":198},"s9osk","width",[169,201,192],{"class":191},[169,203,205],{"class":204},"sDLfK"," number",[169,207,208],{"class":178},"; ",[169,210,211],{"class":198},"height",[169,213,192],{"class":191},[169,215,205],{"class":204},[169,217,218],{"class":178},"}\n",[169,220,222,225,228,231,233,236,239,241,243,245,247,249,251,253,255,257],{"class":171,"line":221},3,[169,223,224],{"class":175},"    safe",[169,226,227],{"class":178},"(",[169,229,230],{"class":198},"fp",[169,232,192],{"class":191},[169,234,235],{"class":175}," GridFrameParams",[169,237,238],{"class":178},")",[169,240,192],{"class":191},[169,242,195],{"class":178},[169,244,199],{"class":198},[169,246,192],{"class":191},[169,248,205],{"class":204},[169,250,208],{"class":178},[169,252,211],{"class":198},[169,254,192],{"class":191},[169,256,205],{"class":204},[169,258,218],{"class":178},[169,260,262],{"class":171,"line":261},4,[169,263,218],{"class":178},[156,265,266,267,270,271,274,275,278],{},"Import ",[8,268,269],{},"sim"," from ",[8,272,273],{},"shaders\u002Fstd"," and use ",[8,276,277],{},"sim.grids.trackedViewport",".",[156,280,281,284,285,288],{},[8,282,283],{},"tracked()"," is the size at the last resize, for a pass that works in the canvas's own pixels. ",[8,286,287],{},"safe(fp)"," prefers the size this frame reports and never returns less than 1, for an aspect ratio.",[290,291,293],"h2",{"id":292},"parameters","Parameters",[295,296,297,313],"table",{},[298,299,300],"thead",{},[301,302,303,307,310],"tr",{},[304,305,306],"th",{},"Name",[304,308,309],{},"Type",[304,311,312],{},"Notes",[314,315,316],"tbody",{},[301,317,318,324,329],{},[319,320,321],"td",{},[8,322,323],{},"params",[319,325,326],{},[8,327,328],{},"GpuFragmentParams",[319,330],{},[290,332,334],{"id":333},"example","Example",[160,336,338],{"className":162,"code":337,"language":164,"meta":165,"style":165},"const viewport = trackedViewport(params)\nop.values('write', (f) => { const s = viewport.safe(f.frameParams); paramsU.write({aspect: s.width \u002F s.height}) })\n",[8,339,340,357],{"__ignoreMap":165},[169,341,342,345,348,351,354],{"class":171,"line":172},[169,343,344],{"class":191},"const",[169,346,347],{"class":204}," viewport",[169,349,350],{"class":191}," =",[169,352,353],{"class":175}," trackedViewport",[169,355,356],{"class":178},"(params)\n",[169,358,359,362,365,367,371,374,377,380,383,386,388,391,393,396,399,402,405,408,411],{"class":171,"line":182},[169,360,361],{"class":178},"op.",[169,363,364],{"class":175},"values",[169,366,227],{"class":178},[169,368,370],{"class":369},"sU2Wk","'write'",[169,372,373],{"class":178},", (",[169,375,376],{"class":198},"f",[169,378,379],{"class":178},") ",[169,381,382],{"class":191},"=>",[169,384,385],{"class":178}," { ",[169,387,344],{"class":191},[169,389,390],{"class":204}," s",[169,392,350],{"class":191},[169,394,395],{"class":178}," viewport.",[169,397,398],{"class":175},"safe",[169,400,401],{"class":178},"(f.frameParams); paramsU.",[169,403,404],{"class":175},"write",[169,406,407],{"class":178},"({aspect: s.width ",[169,409,410],{"class":191},"\u002F",[169,412,413],{"class":178}," s.height}) })\n",[290,415,417],{"id":416},"see-also","See also",[419,420,421],"ul",{},[422,423,424,431],"li",{},[425,426,428],"a",{"href":427},"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fgridsim",[8,429,430],{},"gridSim"," — A field of cells advanced every frame by an ordered list of stages.",[290,433,435],{"id":434},"used-by","Used by",[156,437,438],{},[425,439,441],{"href":440},"\u002Fdocs\u002Fcomponents\u002Fpixelsort","PixelSort",[443,444,445],"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 .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}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":447},[448,449,450,451],{"id":292,"depth":182,"text":293},{"id":333,"depth":182,"text":334},{"id":416,"depth":182,"text":417},{"id":434,"depth":182,"text":435},"sim.grids","sim-grids","Grid programs",false,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Ftrackedviewport",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fgrids.ts#L395","docs\u002Fprimitives\u002F37.sim-grids\u002F13.trackedviewport","-_4yxzAJfSZKT1vf0I-x0VYAzdfCS2R7f4l6e--F5iU"]