[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fradiance\u002Firradiancefield":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":230,"categorySlug":230,"categoryTitle":442,"curated":443,"description":158,"editUrl":9,"extension":444,"group":445,"groupTitle":446,"kind":447,"meta":448,"navigation":449,"path":450,"seo":451,"sourceUrl":452,"stem":453,"wordCount":9,"__hash__":454},"primitives\u002Fdocs\u002Fprimitives\u002F16.radiance\u002F1.irradiancefield.md","irradianceField",{"type":149,"value":150,"toc":436},"minimark",[151,155,159,225,240,283,288,325,329,380,395,399,422,426,432],[152,153,147],"h1",{"id":154},"irradiancefield",[156,157,158],"p",{},"The light spilling from a shape's edges, gathered once into a texture and read per pixel.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","irradianceField(spec: IrradianceFieldSpec): {\n    compute: GpuComputeNode\n    sample: (params: GpuFragmentParams) => Expr | undefined\n}\n","ts","",[8,167,168,180,186,219],{"__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","(spec: IrradianceFieldSpec): {\n",[169,181,183],{"class":171,"line":182},2,[169,184,185],{"class":178},"    compute: GpuComputeNode\n",[169,187,189,192,196,200,203,206,209,212,215],{"class":171,"line":188},3,[169,190,191],{"class":178},"    sample: (",[169,193,195],{"class":194},"s9osk","params",[169,197,199],{"class":198},"snl16",":",[169,201,202],{"class":175}," GpuFragmentParams",[169,204,205],{"class":178},") ",[169,207,208],{"class":198},"=>",[169,210,211],{"class":178}," Expr ",[169,213,214],{"class":198},"|",[169,216,218],{"class":217},"sDLfK"," undefined\n",[169,220,222],{"class":171,"line":221},4,[169,223,224],{"class":178},"}\n",[156,226,227,228,231,232,235,236,239],{},"Import ",[8,229,230],{},"radiance"," from ",[8,233,234],{},"shaders\u002Fstd"," and use ",[8,237,238],{},"radiance.irradianceField",".",[156,241,242,243,246,247,250,251,254,255,258,259,262,263,266,267,266,270,266,273,266,276,266,279,282],{},"Returns two halves. Put ",[8,244,245],{},"compute"," on your definition's ",[8,248,249],{},"compute:"," field. In your material, call ",[8,252,253],{},"sample(params)"," for the rgb light at the pixel. It returns ",[8,256,257],{},"undefined"," when there is no GPU to gather on, so write ",[8,260,261],{},"sample(params) ?? splat3(0)",". It reads your standard shape props (",[8,264,265],{},"center",", ",[8,268,269],{},"scale",[8,271,272],{},"rotation",[8,274,275],{},"shape",[8,277,278],{},"shapeSdfUrl",[8,280,281],{},"shapeType",") plus the props named in the spec. The texture only re-gathers when a light or the shape changes.",[284,285,287],"h2",{"id":286},"parameters","Parameters",[289,290,291,307],"table",{},[292,293,294],"thead",{},[295,296,297,301,304],"tr",{},[298,299,300],"th",{},"Name",[298,302,303],{},"Type",[298,305,306],{},"Notes",[308,309,310],"tbody",{},[295,311,312,318,323],{},[313,314,315],"td",{},[8,316,317],{},"spec",[313,319,320],{},[8,321,322],{},"IrradianceFieldSpec",[313,324],{},[284,326,328],{"id":327},"example","Example",[160,330,332],{"className":162,"code":331,"language":164,"meta":165,"style":165},"const spill = irradianceField(GATHER).sample(params) ?? math.splat3(0)\n",[8,333,334],{"__ignoreMap":165},[169,335,336,339,342,345,348,351,354,357,360,363,366,369,372,374,377],{"class":171,"line":172},[169,337,338],{"class":198},"const",[169,340,341],{"class":217}," spill",[169,343,344],{"class":198}," =",[169,346,347],{"class":175}," irradianceField",[169,349,350],{"class":178},"(",[169,352,353],{"class":217},"GATHER",[169,355,356],{"class":178},").",[169,358,359],{"class":175},"sample",[169,361,362],{"class":178},"(params) ",[169,364,365],{"class":198},"??",[169,367,368],{"class":178}," math.",[169,370,371],{"class":175},"splat3",[169,373,350],{"class":178},[169,375,376],{"class":217},"0",[169,378,379],{"class":178},")\n",[381,382,383],"blockquote",{},[156,384,385,389,390,392,393,239],{},[386,387,388],"strong",{},"Tip."," Build the spec once as a constant and use it for both ",[8,391,249],{}," and ",[8,394,359],{},[284,396,398],{"id":397},"see-also","See also",[400,401,402,413],"ul",{},[403,404,405,412],"li",{},[406,407,409],"a",{"href":408},"\u002Fdocs\u002Fprimitives\u002Fradiance\u002Fgatherirradiance",[8,410,411],{},"gatherIrradiance"," — The light arriving at a pixel from a glowing shape edge, with the shape's body blocking it.",[403,414,415,421],{},[406,416,418],{"href":417},"\u002Fdocs\u002Fprimitives\u002Fradiance\u002Fshadowvisibility",[8,419,420],{},"shadowVisibility"," — How much of a light reaches a point, 1 when nothing is in the way and 0 when the shape blocks it.",[284,423,425],{"id":424},"used-by","Used by",[156,427,428],{},[406,429,431],{"href":430},"\u002Fdocs\u002Fcomponents\u002Firradiance","Irradiance",[433,434,435],"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 .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}html pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}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);}",{"title":165,"searchDepth":182,"depth":182,"links":437},[438,439,440,441],{"id":286,"depth":182,"text":287},{"id":327,"depth":182,"text":328},{"id":397,"depth":182,"text":398},{"id":424,"depth":182,"text":425},"Radiance",false,"md","light","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fradiance\u002Firradiancefield",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fradiance.ts#L375","docs\u002Fprimitives\u002F16.radiance\u002F1.irradiancefield","HnaeLkUlfxHU8EZgh4H79_X2T2ow-Wb-nTGd95JoQI8"]