[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Ffieldsample":129},{"stars":4},5507,[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":318,"categorySlug":319,"categoryTitle":320,"curated":321,"description":322,"editUrl":323,"extension":324,"group":325,"groupTitle":326,"kind":327,"meta":328,"navigation":329,"path":330,"seo":331,"sourceUrl":332,"stem":333,"wordCount":323,"__hash__":334},"primitives\u002Fdocs\u002Fprimitives\u002F41.sim-agentforces\u002F28.fieldsample.md","FieldSample",{"type":133,"value":134,"toc":312},"minimark",[135,139,155,176,191,197,202,239,243,278,282,308],[136,137,131],"h1",{"id":138},"fieldsample",[140,141,142,143,146,147,150,151,154],"p",{},"What a field sample carries: the direction away from the source (",[10,144,145],{},"rhat","), the ",[10,148,149],{},"strength",", and the line angle ",[10,152,153],{},"phi"," in radians.",[156,157,162],"pre",{"className":158,"code":159,"language":160,"meta":161,"style":161},"language-ts shiki shiki-themes github-dark","FieldSample(props: { rhat: v2f; strength: number; phi: number; }): { rhat: v2f; strength: number; phi: number; }\n","ts","",[10,163,164],{"__ignoreMap":161},[165,166,169,172],"span",{"class":167,"line":168},"line",1,[165,170,131],{"class":171},"svObZ",[165,173,175],{"class":174},"s95oV","(props: { rhat: v2f; strength: number; phi: number; }): { rhat: v2f; strength: number; phi: number; }\n",[140,177,178,179,182,183,186,187,190],{},"Import ",[10,180,181],{},"sim"," from ",[10,184,185],{},"shaders\u002Fstd"," and use ",[10,188,189],{},"sim.agentForces.FieldSample",".",[140,192,193,194,190],{},"Build one when writing your own ",[10,195,196],{},"AgentFieldAt",[198,199,201],"h2",{"id":200},"parameters","Parameters",[203,204,205,221],"table",{},[206,207,208],"thead",{},[209,210,211,215,218],"tr",{},[212,213,214],"th",{},"Name",[212,216,217],{},"Type",[212,219,220],{},"Notes",[222,223,224],"tbody",{},[209,225,226,232,237],{},[227,228,229],"td",{},[10,230,231],{},"props",[227,233,234],{},[10,235,236],{},"{ rhat: v2f; strength: number; phi: number; }",[227,238],{},[198,240,242],{"id":241},"example","Example",[156,244,246],{"className":158,"code":245,"language":160,"meta":161,"style":161},"return FieldSample({rhat, strength: fieldStr, phi: std.atan2(B.y, B.x)})\n",[10,247,248],{"__ignoreMap":161},[165,249,250,254,257,260,263,266,270,273,275],{"class":167,"line":168},[165,251,253],{"class":252},"snl16","return",[165,255,256],{"class":171}," FieldSample",[165,258,259],{"class":174},"({rhat, strength: fieldStr, phi: std.",[165,261,262],{"class":171},"atan2",[165,264,265],{"class":174},"(",[165,267,269],{"class":268},"sDLfK","B",[165,271,272],{"class":174},".y, ",[165,274,269],{"class":268},[165,276,277],{"class":174},".x)})\n",[198,279,281],{"id":280},"see-also","See also",[283,284,285,296],"ul",{},[286,287,288,295],"li",{},[289,290,292],"a",{"href":291},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Ffield-dipoleorradial",[10,293,294],{},"field.dipoleOrRadial"," — The field of a magnet at the cursor: a bar magnet along its travel, or a single pole.",[286,297,298,304,305,190],{},[289,299,301],{"href":300},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Ftorque",[10,302,303],{},"torque"," — The turns an agent that spins in place can feel, for ",[10,306,307],{},"integrator.orientation2d",[309,310,311],"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":161,"searchDepth":313,"depth":313,"links":314},2,[315,316,317],{"id":200,"depth":313,"text":201},{"id":241,"depth":313,"text":242},{"id":280,"depth":313,"text":281},"sim.agentForces","sim-agentforces","Agent forces",false,"What a field sample carries: the direction away from the source (`rhat`), the `strength`, and the line angle `phi` in radians.",null,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Ffieldsample",{"title":131,"description":322},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002FagentForces.ts#L597","docs\u002Fprimitives\u002F41.sim-agentforces\u002F28.fieldsample","4WBTTsu3bdqGn6_LiyJI0n18jIDn-Vdhq8QMKxP2FS0"]