[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-orientedworld":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":504,"categorySlug":505,"categoryTitle":506,"curated":507,"description":158,"editUrl":9,"extension":508,"group":509,"groupTitle":510,"kind":511,"meta":512,"navigation":513,"path":514,"seo":515,"sourceUrl":516,"stem":517,"wordCount":9,"__hash__":518},"primitives\u002Fdocs\u002Fprimitives\u002F40.sim-agents\u002F3.renderagents-orientedworld.md","renderAgents.orientedWorld",{"type":149,"value":150,"toc":498},"minimark",[151,155,159,268,283,313,318,367,375,379,448,452,475,479,494],[152,153,147],"h1",{"id":154},"renderagentsorientedworld",[156,157,158],"p",{},"Agents with a heading, drawn as a shape pointing the way they move (or the way they are turned), colored from a rest color to an excited color.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","renderAgents.orientedWorld(layout: WorldSplatLayout & RampResolveLayout, cfg: Omit\u003COrientedWorldSplatConfig, 'name'> & {\n            ramp: Omit\u003CRampResolveConfig, 'name' | 'res' | 'invGain'> & {invGain?: number}\n            names: {splat: string; resolve: string}\n            \u002F** Give the splat the second resource group as well (a shape family's own resources). *\u002F\n            extraOnSplat?: boolean\n        }): RenderAgentsPipelines\n","ts","",[8,167,168,210,237,243,250,262],{"__ignoreMap":165},[169,170,173,177,181,184,188,191,194,197,201,204,207],"span",{"class":171,"line":172},"line",1,[169,174,176],{"class":175},"s95oV","renderAgents.",[169,178,180],{"class":179},"svObZ","orientedWorld",[169,182,183],{"class":175},"(layout: WorldSplatLayout ",[169,185,187],{"class":186},"snl16","&",[169,189,190],{"class":175}," RampResolveLayout, cfg: Omit",[169,192,193],{"class":186},"\u003C",[169,195,196],{"class":175},"OrientedWorldSplatConfig, ",[169,198,200],{"class":199},"sU2Wk","'name'",[169,202,203],{"class":186},">",[169,205,206],{"class":186}," &",[169,208,209],{"class":175}," {\n",[169,211,213,216,218,221,223,226,229,231,234],{"class":171,"line":212},2,[169,214,215],{"class":175},"            ramp: Omit",[169,217,193],{"class":186},[169,219,220],{"class":175},"RampResolveConfig, ",[169,222,200],{"class":199},[169,224,225],{"class":175}," | ",[169,227,228],{"class":199},"'res'",[169,230,225],{"class":175},[169,232,233],{"class":199},"'invGain'",[169,235,236],{"class":175},"> & {invGain?: number}\n",[169,238,240],{"class":171,"line":239},3,[169,241,242],{"class":175},"            names: {splat: string; resolve: string}\n",[169,244,246],{"class":171,"line":245},4,[169,247,249],{"class":248},"sAwPA","            \u002F** Give the splat the second resource group as well (a shape family's own resources). *\u002F\n",[169,251,253,256,259],{"class":171,"line":252},5,[169,254,255],{"class":175},"            extraOnSplat",[169,257,258],{"class":186},"?:",[169,260,261],{"class":175}," boolean\n",[169,263,265],{"class":171,"line":264},6,[169,266,267],{"class":175},"        }): RenderAgentsPipelines\n",[156,269,270,271,274,275,278,279,282],{},"Import ",[8,272,273],{},"sim"," from ",[8,276,277],{},"shaders\u002Fstd"," and use ",[8,280,281],{},"sim.agents.renderAgents.orientedWorld",".",[156,284,285,288,289,292,293,296,297,300,301,304,305,308,309,312],{},[8,286,287],{},"heading: 'velocity'"," reads the direction from the agent's velocity, ",[8,290,291],{},"'angle'"," from a stored angle plus a ",[8,294,295],{},"home"," part. ",[8,298,299],{},"agitation: 'buffer'"," reads excitement from a per-agent value, ",[8,302,303],{},"'speed'"," from the agent's speed. ",[8,306,307],{},"comet: true"," stretches a glow along the heading. ",[8,310,311],{},"res"," is the canvas side in texels.",[314,315,317],"h2",{"id":316},"parameters","Parameters",[319,320,321,337],"table",{},[322,323,324],"thead",{},[325,326,327,331,334],"tr",{},[328,329,330],"th",{},"Name",[328,332,333],{},"Type",[328,335,336],{},"Notes",[338,339,340,355],"tbody",{},[325,341,342,348,353],{},[343,344,345],"td",{},[8,346,347],{},"layout",[343,349,350],{},[8,351,352],{},"WorldSplatLayout & RampResolveLayout",[343,354],{},[325,356,357,362,365],{},[343,358,359],{},[8,360,361],{},"cfg",[343,363,364],{},"`Omit\u003COrientedWorldSplatConfig, 'name'> & {",[343,366],{},[160,368,373],{"className":369,"code":371,"language":372},[370],"language-text","        ramp: Omit\u003CRampResolveConfig, 'name' \\| 'res' \\| 'invGain'> & {invGain?: number}\n        names: {splat: string; resolve: string}\n        \u002F** Give the splat the second resource group as well (a shape family's own resources). *\u002F\n        extraOnSplat?: boolean\n    }` |  |\n","text",[8,374,371],{"__ignoreMap":165},[314,376,378],{"id":377},"example","Example",[160,380,382],{"className":162,"code":381,"language":164,"meta":165,"style":165},"renderAgents.orientedWorld(simLayout, {shape, res: 1024, splatRCap: 16, heading: 'velocity', agitation: 'buffer', comet: true, ramp: {colorSpace: 2, trails: 'on'}, names: {splat: 'boidsSplat', resolve: 'boidsResolve'}})\n",[8,383,384],{"__ignoreMap":165},[169,385,386,388,390,393,397,400,403,406,409,412,415,418,421,424,427,430,433,436,439,442,445],{"class":171,"line":172},[169,387,176],{"class":175},[169,389,180],{"class":179},[169,391,392],{"class":175},"(simLayout, {shape, res: ",[169,394,396],{"class":395},"sDLfK","1024",[169,398,399],{"class":175},", splatRCap: ",[169,401,402],{"class":395},"16",[169,404,405],{"class":175},", heading: ",[169,407,408],{"class":199},"'velocity'",[169,410,411],{"class":175},", agitation: ",[169,413,414],{"class":199},"'buffer'",[169,416,417],{"class":175},", comet: ",[169,419,420],{"class":395},"true",[169,422,423],{"class":175},", ramp: {colorSpace: ",[169,425,426],{"class":395},"2",[169,428,429],{"class":175},", trails: ",[169,431,432],{"class":199},"'on'",[169,434,435],{"class":175},"}, names: {splat: ",[169,437,438],{"class":199},"'boidsSplat'",[169,440,441],{"class":175},", resolve: ",[169,443,444],{"class":199},"'boidsResolve'",[169,446,447],{"class":175},"}})\n",[314,449,451],{"id":450},"see-also","See also",[453,454,455,466],"ul",{},[456,457,458,465],"li",{},[459,460,462],"a",{"href":461},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-pointworld",[8,463,464],{},"renderAgents.pointWorld"," — Round motes with no heading, drawn in one tint with a live softness.",[456,467,468,474],{},[459,469,471],{"href":470},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-volume",[8,472,473],{},"renderAgents.volume"," — A 3D swarm seen in perspective: nearer particles draw larger and brighter, and the color runs from rest to excited with speed.",[314,476,478],{"id":477},"used-by","Used by",[156,480,481,485,486,485,490],{},[459,482,484],{"href":483},"\u002Fdocs\u002Fcomponents\u002Fboids","Boids",", ",[459,487,489],{"href":488},"\u002Fdocs\u002Fcomponents\u002Fmagneticfilings","MagneticFilings",[459,491,493],{"href":492},"\u002Fdocs\u002Fcomponents\u002Fparticleflow","ParticleFlow",[495,496,497],"style",{},"html pre.shiki code .s95oV, html code.shiki .s95oV{--shiki-default:#E1E4E8}html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}html pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}html pre.shiki code .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}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}",{"title":165,"searchDepth":212,"depth":212,"links":499},[500,501,502,503],{"id":316,"depth":212,"text":317},{"id":377,"depth":212,"text":378},{"id":450,"depth":212,"text":451},{"id":477,"depth":212,"text":478},"sim.agents","sim-agents","Agents",false,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-orientedworld",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fagents.ts#L85","docs\u002Fprimitives\u002F40.sim-agents\u002F3.renderagents-orientedworld","eFvmPxf0lngcelN2Bwz8kt6aU13Gm-B7Sov65Svyi0M"]