[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Flists\u002Flistof":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":457,"categorySlug":457,"categoryTitle":458,"curated":459,"description":158,"editUrl":9,"extension":460,"group":461,"groupTitle":462,"kind":463,"meta":464,"navigation":465,"path":466,"seo":467,"sourceUrl":468,"stem":469,"wordCount":9,"__hash__":470},"primitives\u002Fdocs\u002Fprimitives\u002F5.lists\u002F1.listof.md","listOf",{"type":149,"value":150,"toc":451},"minimark",[151,155,159,187,197,233,238,288,292,403,420,424,437,441,447],[152,153,147],"h1",{"id":154},"listof",[156,157,158],"p",{},"Read a list prop inside a hand-written builder: its live item count and each item's fields.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","listOf(params: {uniforms: Record\u003Cstring, Expr>}, prop: string): ListRef\n","ts","",[8,167,168],{"__ignoreMap":165},[169,170,173,176,180,184],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(params: {uniforms: Record",[169,181,183],{"class":182},"snl16","\u003C",[169,185,186],{"class":178},"string, Expr>}, prop: string): ListRef\n",[156,188,189,190,192,193,196],{},"Import ",[8,191,147],{}," from ",[8,194,195],{},"shaders\u002Fstd",".",[156,198,199,202,203,206,207,210,211,214,215,206,218,221,222,225,226,229,230,196],{},[8,200,201],{},"listOf(params, 'lights')"," gives ",[8,204,205],{},"count"," and ",[8,208,209],{},"at(i)",", whose ",[8,212,213],{},".position('position')",", ",[8,216,217],{},".color('color')",[8,219,220],{},".number('intensity')"," read item ",[8,223,224],{},"i"," by field name. Throws when ",[8,227,228],{},"prop"," is not a list prop or a field name is not in its item spec. Loop with ",[8,231,232],{},"accumulate",[234,235,237],"h2",{"id":236},"parameters","Parameters",[239,240,241,257],"table",{},[242,243,244],"thead",{},[245,246,247,251,254],"tr",{},[248,249,250],"th",{},"Name",[248,252,253],{},"Type",[248,255,256],{},"Notes",[258,259,260,275],"tbody",{},[245,261,262,268,273],{},[263,264,265],"td",{},[8,266,267],{},"params",[263,269,270],{},[8,271,272],{},"{uniforms: Record\u003Cstring, Expr>}",[263,274],{},[245,276,277,281,286],{},[263,278,279],{},[8,280,228],{},[263,282,283],{},[8,284,285],{},"string",[263,287],{},[234,289,291],{"id":290},"example","Example",[160,293,295],{"className":162,"code":294,"language":164,"meta":165,"style":165},"const lights = listOf(params, 'lights')\nconst rgb = accumulate(lights, (i) => mul(lights.at(i).color('color').member('rgb'), lights.at(i).number('intensity')), {zero: 'vec3f'})\n",[8,296,297,322],{"__ignoreMap":165},[169,298,299,302,306,309,312,315,319],{"class":171,"line":172},[169,300,301],{"class":182},"const",[169,303,305],{"class":304},"sDLfK"," lights",[169,307,308],{"class":182}," =",[169,310,311],{"class":175}," listOf",[169,313,314],{"class":178},"(params, ",[169,316,318],{"class":317},"sU2Wk","'lights'",[169,320,321],{"class":178},")\n",[169,323,325,327,330,332,335,338,341,344,347,350,353,356,359,362,365,368,371,374,376,379,382,384,386,389,391,394,397,400],{"class":171,"line":324},2,[169,326,301],{"class":182},[169,328,329],{"class":304}," rgb",[169,331,308],{"class":182},[169,333,334],{"class":175}," accumulate",[169,336,337],{"class":178},"(lights, (",[169,339,224],{"class":340},"s9osk",[169,342,343],{"class":178},") ",[169,345,346],{"class":182},"=>",[169,348,349],{"class":175}," mul",[169,351,352],{"class":178},"(lights.",[169,354,355],{"class":175},"at",[169,357,358],{"class":178},"(i).",[169,360,361],{"class":175},"color",[169,363,364],{"class":178},"(",[169,366,367],{"class":317},"'color'",[169,369,370],{"class":178},").",[169,372,373],{"class":175},"member",[169,375,364],{"class":178},[169,377,378],{"class":317},"'rgb'",[169,380,381],{"class":178},"), lights.",[169,383,355],{"class":175},[169,385,358],{"class":178},[169,387,388],{"class":175},"number",[169,390,364],{"class":178},[169,392,393],{"class":317},"'intensity'",[169,395,396],{"class":178},")), {zero: ",[169,398,399],{"class":317},"'vec3f'",[169,401,402],{"class":178},"})\n",[404,405,406],"blockquote",{},[156,407,408,412,413,416,417,196],{},[409,410,411],"strong",{},"Tip."," A position field's y is stored flipped; use ",[8,414,415],{},"sub(1, pos.member('y'))"," to compare it with ",[8,418,419],{},"uv",[234,421,423],{"id":422},"see-also","See also",[425,426,427],"ul",{},[428,429,430,436],"li",{},[431,432,434],"a",{"href":433},"\u002Fdocs\u002Fprimitives\u002Flists\u002Faccumulate",[8,435,232],{}," — Add up a per-item value over every item of a list, in a real GPU loop over the live count.",[234,438,440],{"id":439},"used-by","Used by",[156,442,443],{},[431,444,446],{"href":445},"\u002Fdocs\u002Fcomponents\u002Firradiance","Irradiance",[448,449,450],"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 .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 .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}html pre.shiki code .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}",{"title":165,"searchDepth":324,"depth":324,"links":452},[453,454,455,456],{"id":236,"depth":324,"text":237},{"id":290,"depth":324,"text":291},{"id":422,"depth":324,"text":423},{"id":439,"depth":324,"text":440},"lists","List props",false,"md","define","Defining a shader","function",{},true,"\u002Fdocs\u002Fprimitives\u002Flists\u002Flistof",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Flists.ts#L58","docs\u002Fprimitives\u002F5.lists\u002F1.listof","QdSKm1o6mFWXnAbQadMvAbfYs93tjPNjz9YwCMjF4p0"]