[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-orientedworld":129},{"stars":4},5505,[6,11,15,19,23,27,31,35,39,43,47,51,55,59,63,67,72,76,80,84,88,93,97,101,105,109,113,117,121,125],{"path":7,"title":8,"description":9,"category":10},"\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",{"path":12,"title":13,"description":14,"category":10},"\u002Fdocs\u002Fguide\u002Fquickstart","Quickstart","Install Shaders, render your first effect, and drive a prop from state.",{"path":16,"title":17,"description":18,"category":10},"\u002Fdocs\u002Fguide\u002Fcomposing-effects","Composing effects","Stack components as layers and nest them to control which layers an effect touches.",{"path":20,"title":21,"description":22,"category":10},"\u002Fdocs\u002Fguide\u002Fblending-masking","Blending and masking","Control how a layer mixes with the layers below it, and reveal one layer through another.",{"path":24,"title":25,"description":26,"category":10},"\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":28,"title":29,"description":30,"category":10},"\u002Fdocs\u002Fguide\u002Fdynamic-props","Dynamic props","Drive any numeric or position prop from time, the cursor, or another layer, without writing animation code.",{"path":32,"title":33,"description":34,"category":10},"\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":36,"title":37,"description":38,"category":10},"\u002Fdocs\u002Fguide\u002Fsizing-and-units","Sizing and units","Size and place layers in CSS units (px, %, vw, rem, and canvas units) that stay correct as the canvas and window resize.",{"path":40,"title":41,"description":42,"category":10},"\u002Fdocs\u002Fguide\u002Ftransforms","Transforms","Position, size, and rotate any layer inside the canvas with a bounding box, in any CSS unit.",{"path":44,"title":45,"description":46,"category":10},"\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":48,"title":49,"description":50,"category":10},"\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":52,"title":53,"description":54,"category":10},"\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":56,"title":57,"description":58,"category":10},"\u002Fdocs\u002Fguide\u002Fperformance","Performance","Learn what makes an effect expensive on the GPU and how to keep it inside the frame budget.",{"path":60,"title":61,"description":62,"category":10},"\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":64,"title":65,"description":66,"category":10},"\u002Fdocs\u002Fguide\u002Ftelemetry","Telemetry","The `\u003CShader>` component occasionally sends an anonymous performance report to help us improve the engine over time.",{"path":68,"title":69,"description":70,"category":71},"\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":73,"title":74,"description":75,"category":71},"\u002Fdocs\u002Fguide\u002Fcli","Shaders CLI","Install your own shaders and Pro shaders into your codebase as component files, and keep them in sync with the design editor.",{"path":77,"title":78,"description":79,"category":71},"\u002Fdocs\u002Fguide\u002Fagent-skill","Agent skill","Give your coding agent a skill that teaches it to build with Shaders components, the CLI and Pro shaders.",{"path":81,"title":82,"description":83,"category":10},"\u002Fdocs\u002Fguide\u002Fvideo-rendering","Rendering to video","Turn a shader effect into a video file, from the design editor or from a frame-by-frame pipeline such as Remotion, Hyperframes or Puppeteer.",{"path":85,"title":86,"description":87,"category":10},"\u002Fdocs\u002Fguide\u002Fssr","Server rendering","Render Shaders in Next.js, Nuxt, SvelteKit, SolidStart and other SSR apps by keeping each shader on the client.",{"path":89,"title":90,"description":91,"category":92},"\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":94,"title":95,"description":96,"category":92},"\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":98,"title":99,"description":100,"category":92},"\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":102,"title":103,"description":104,"category":92},"\u002Fdocs\u002Fguide\u002Fmasking-and-blending","Masking and blending","How blend modes and masks combine components in the design editor.",{"path":106,"title":107,"description":108,"category":92},"\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":110,"title":111,"description":112,"category":92},"\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":114,"title":115,"description":116,"category":92},"\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":118,"title":119,"description":120,"category":92},"\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":122,"title":123,"description":124,"category":92},"\u002Fdocs\u002Fguide\u002Fglass-component-spotlight","Component spotlight: Glass","A short look at the Glass component and the liquid-glass look it creates.",{"path":126,"title":127,"description":128,"category":92},"\u002Fdocs\u002Fguide\u002Fdigital-looks-component-spotlight","Component spotlight: Digital looks","A look at the digital stylization components for glitchy, futuristic, or technical effects.",{"id":130,"title":131,"body":132,"categoryId":488,"categorySlug":489,"categoryTitle":490,"curated":491,"description":142,"editUrl":492,"extension":493,"group":494,"groupTitle":495,"kind":496,"meta":497,"navigation":498,"path":499,"seo":500,"sourceUrl":501,"stem":502,"wordCount":492,"__hash__":503},"primitives\u002Fdocs\u002Fprimitives\u002F40.sim-agents\u002F3.renderagents-orientedworld.md","renderAgents.orientedWorld",{"type":133,"value":134,"toc":482},"minimark",[135,139,143,252,267,297,302,351,359,363,432,436,459,463,478],[136,137,131],"h1",{"id":138},"renderagentsorientedworld",[140,141,142],"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.",[144,145,150],"pre",{"className":146,"code":147,"language":148,"meta":149,"style":149},"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","",[10,151,152,194,221,227,234,246],{"__ignoreMap":149},[153,154,157,161,165,168,172,175,178,181,185,188,191],"span",{"class":155,"line":156},"line",1,[153,158,160],{"class":159},"s95oV","renderAgents.",[153,162,164],{"class":163},"svObZ","orientedWorld",[153,166,167],{"class":159},"(layout: WorldSplatLayout ",[153,169,171],{"class":170},"snl16","&",[153,173,174],{"class":159}," RampResolveLayout, cfg: Omit",[153,176,177],{"class":170},"\u003C",[153,179,180],{"class":159},"OrientedWorldSplatConfig, ",[153,182,184],{"class":183},"sU2Wk","'name'",[153,186,187],{"class":170},">",[153,189,190],{"class":170}," &",[153,192,193],{"class":159}," {\n",[153,195,197,200,202,205,207,210,213,215,218],{"class":155,"line":196},2,[153,198,199],{"class":159},"            ramp: Omit",[153,201,177],{"class":170},[153,203,204],{"class":159},"RampResolveConfig, ",[153,206,184],{"class":183},[153,208,209],{"class":159}," | ",[153,211,212],{"class":183},"'res'",[153,214,209],{"class":159},[153,216,217],{"class":183},"'invGain'",[153,219,220],{"class":159},"> & {invGain?: number}\n",[153,222,224],{"class":155,"line":223},3,[153,225,226],{"class":159},"            names: {splat: string; resolve: string}\n",[153,228,230],{"class":155,"line":229},4,[153,231,233],{"class":232},"sAwPA","            \u002F** Give the splat the second resource group as well (a shape family's own resources). *\u002F\n",[153,235,237,240,243],{"class":155,"line":236},5,[153,238,239],{"class":159},"            extraOnSplat",[153,241,242],{"class":170},"?:",[153,244,245],{"class":159}," boolean\n",[153,247,249],{"class":155,"line":248},6,[153,250,251],{"class":159},"        }): RenderAgentsPipelines\n",[140,253,254,255,258,259,262,263,266],{},"Import ",[10,256,257],{},"sim"," from ",[10,260,261],{},"shaders\u002Fstd"," and use ",[10,264,265],{},"sim.agents.renderAgents.orientedWorld",".",[140,268,269,272,273,276,277,280,281,284,285,288,289,292,293,296],{},[10,270,271],{},"heading: 'velocity'"," reads the direction from the agent's velocity, ",[10,274,275],{},"'angle'"," from a stored angle plus a ",[10,278,279],{},"home"," part. ",[10,282,283],{},"agitation: 'buffer'"," reads excitement from a per-agent value, ",[10,286,287],{},"'speed'"," from the agent's speed. ",[10,290,291],{},"comet: true"," stretches a glow along the heading. ",[10,294,295],{},"res"," is the canvas side in texels.",[298,299,301],"h2",{"id":300},"parameters","Parameters",[303,304,305,321],"table",{},[306,307,308],"thead",{},[309,310,311,315,318],"tr",{},[312,313,314],"th",{},"Name",[312,316,317],{},"Type",[312,319,320],{},"Notes",[322,323,324,339],"tbody",{},[309,325,326,332,337],{},[327,328,329],"td",{},[10,330,331],{},"layout",[327,333,334],{},[10,335,336],{},"WorldSplatLayout & RampResolveLayout",[327,338],{},[309,340,341,346,349],{},[327,342,343],{},[10,344,345],{},"cfg",[327,347,348],{},"`Omit\u003COrientedWorldSplatConfig, 'name'> & {",[327,350],{},[144,352,357],{"className":353,"code":355,"language":356},[354],"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",[10,358,355],{"__ignoreMap":149},[298,360,362],{"id":361},"example","Example",[144,364,366],{"className":146,"code":365,"language":148,"meta":149,"style":149},"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",[10,367,368],{"__ignoreMap":149},[153,369,370,372,374,377,381,384,387,390,393,396,399,402,405,408,411,414,417,420,423,426,429],{"class":155,"line":156},[153,371,160],{"class":159},[153,373,164],{"class":163},[153,375,376],{"class":159},"(simLayout, {shape, res: ",[153,378,380],{"class":379},"sDLfK","1024",[153,382,383],{"class":159},", splatRCap: ",[153,385,386],{"class":379},"16",[153,388,389],{"class":159},", heading: ",[153,391,392],{"class":183},"'velocity'",[153,394,395],{"class":159},", agitation: ",[153,397,398],{"class":183},"'buffer'",[153,400,401],{"class":159},", comet: ",[153,403,404],{"class":379},"true",[153,406,407],{"class":159},", ramp: {colorSpace: ",[153,409,410],{"class":379},"2",[153,412,413],{"class":159},", trails: ",[153,415,416],{"class":183},"'on'",[153,418,419],{"class":159},"}, names: {splat: ",[153,421,422],{"class":183},"'boidsSplat'",[153,424,425],{"class":159},", resolve: ",[153,427,428],{"class":183},"'boidsResolve'",[153,430,431],{"class":159},"}})\n",[298,433,435],{"id":434},"see-also","See also",[437,438,439,450],"ul",{},[440,441,442,449],"li",{},[443,444,446],"a",{"href":445},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-pointworld",[10,447,448],{},"renderAgents.pointWorld"," — Round motes with no heading, drawn in one tint with a live softness.",[440,451,452,458],{},[443,453,455],{"href":454},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-volume",[10,456,457],{},"renderAgents.volume"," — A 3D swarm seen in perspective: nearer particles draw larger and brighter, and the color runs from rest to excited with speed.",[298,460,462],{"id":461},"used-by","Used by",[140,464,465,469,470,469,474],{},[443,466,468],{"href":467},"\u002Fdocs\u002Fcomponents\u002Fboids","Boids",", ",[443,471,473],{"href":472},"\u002Fdocs\u002Fcomponents\u002Fmagneticfilings","MagneticFilings",[443,475,477],{"href":476},"\u002Fdocs\u002Fcomponents\u002Fparticleflow","ParticleFlow",[479,480,481],"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":149,"searchDepth":196,"depth":196,"links":483},[484,485,486,487],{"id":300,"depth":196,"text":301},{"id":361,"depth":196,"text":362},{"id":434,"depth":196,"text":435},{"id":461,"depth":196,"text":462},"sim.agents","sim-agents","Agents",false,null,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-orientedworld",{"title":131,"description":142},"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"]