[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Flight\u002Fwithframe":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":192,"categorySlug":192,"categoryTitle":466,"curated":467,"description":158,"editUrl":9,"extension":468,"group":192,"groupTitle":469,"kind":470,"meta":471,"navigation":472,"path":473,"seo":474,"sourceUrl":475,"stem":476,"wordCount":9,"__hash__":477},"primitives\u002Fdocs\u002Fprimitives\u002F13.light\u002F7.withframe.md","withFrame",{"type":149,"value":150,"toc":459},"minimark",[151,155,159,187,202,212,217,283,287,393,406,410,440,444,455],[152,153,147],"h1",{"id":154},"withframe",[156,157,158],"p",{},"Evaluate a light part in a frame.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","withFrame(frame: LightValue, part: LightPart, hint?: string): LightValue\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","(frame: LightValue, part: LightPart, hint",[169,181,183],{"class":182},"snl16","?:",[169,185,186],{"class":178}," string): LightValue\n",[156,188,189,190,193,194,197,198,201],{},"Import ",[8,191,192],{},"light"," from ",[8,195,196],{},"shaders\u002Fstd"," and use ",[8,199,200],{},"light.withFrame",".",[156,203,204,205,208,209,211],{},"This is where a framed light starts: a frame, then the part (or ",[8,206,207],{},"modulate"," of several) drawn in it. Pass a name as the third argument when the part reads the frame more than once, so the frame is computed once per pixel. ",[8,210,207],{}," always reads it more than once.",[213,214,216],"h2",{"id":215},"parameters","Parameters",[218,219,220,236],"table",{},[221,222,223],"thead",{},[224,225,226,230,233],"tr",{},[227,228,229],"th",{},"Name",[227,231,232],{},"Type",[227,234,235],{},"Notes",[237,238,239,254,268],"tbody",{},[224,240,241,247,252],{},[242,243,244],"td",{},[8,245,246],{},"frame",[242,248,249],{},[8,250,251],{},"LightValue",[242,253],{},[224,255,256,261,266],{},[242,257,258],{},[8,259,260],{},"part",[242,262,263],{},[8,264,265],{},"LightPart",[242,267],{},[224,269,270,275,280],{},[242,271,272],{},[8,273,274],{},"hint",[242,276,277],{},[8,278,279],{},"string",[242,281,282],{},"Optional.",[213,284,286],{"id":285},"example","Example",[160,288,290],{"className":162,"code":289,"language":164,"meta":165,"style":165},"coverage: withFrame(radialFrame(p('center')), modulate(softRayLobes({count: p('rayCount'), softness: p('softness'), spin: -1}), featherMask({radius: p('radius'), feather: p('feather')})), 'burstFrame')\n",[8,291,292],{"__ignoreMap":165},[169,293,294,297,300,302,305,308,310,312,314,318,321,323,325,328,331,333,335,338,341,343,345,348,351,354,358,361,364,367,369,371,374,377,379,381,384,387,390],{"class":171,"line":172},[169,295,296],{"class":175},"coverage",[169,298,299],{"class":178},": ",[169,301,147],{"class":175},[169,303,304],{"class":178},"(",[169,306,307],{"class":175},"radialFrame",[169,309,304],{"class":178},[169,311,156],{"class":175},[169,313,304],{"class":178},[169,315,317],{"class":316},"sU2Wk","'center'",[169,319,320],{"class":178},")), ",[169,322,207],{"class":175},[169,324,304],{"class":178},[169,326,327],{"class":175},"softRayLobes",[169,329,330],{"class":178},"({count: ",[169,332,156],{"class":175},[169,334,304],{"class":178},[169,336,337],{"class":316},"'rayCount'",[169,339,340],{"class":178},"), softness: ",[169,342,156],{"class":175},[169,344,304],{"class":178},[169,346,347],{"class":316},"'softness'",[169,349,350],{"class":178},"), spin: ",[169,352,353],{"class":182},"-",[169,355,357],{"class":356},"sDLfK","1",[169,359,360],{"class":178},"}), ",[169,362,363],{"class":175},"featherMask",[169,365,366],{"class":178},"({radius: ",[169,368,156],{"class":175},[169,370,304],{"class":178},[169,372,373],{"class":316},"'radius'",[169,375,376],{"class":178},"), feather: ",[169,378,156],{"class":175},[169,380,304],{"class":178},[169,382,383],{"class":316},"'feather'",[169,385,386],{"class":178},")})), ",[169,388,389],{"class":316},"'burstFrame'",[169,391,392],{"class":178},")\n",[394,395,396],"blockquote",{},[156,397,398,402,403,405],{},[399,400,401],"strong",{},"Tip."," Without the name, a ",[8,404,207],{}," of two parts computes the frame twice.",[213,407,409],{"id":408},"see-also","See also",[411,412,413,423,432],"ul",{},[414,415,416,422],"li",{},[417,418,420],"a",{"href":419},"\u002Fdocs\u002Fprimitives\u002Flight\u002Fradialframe",[8,421,307],{}," — The frame for a burst, halo or sweep around a center prop.",[414,424,425,431],{},[417,426,428],{"href":427},"\u002Fdocs\u002Fprimitives\u002Flight\u002Fbeamframe",[8,429,430],{},"beamFrame"," — The frame of a beam that starts at an anchor prop and points at the canvas center.",[414,433,434,439],{},[417,435,437],{"href":436},"\u002Fdocs\u002Fprimitives\u002Flight\u002Fmodulate",[8,438,207],{}," — Multiply light parts drawn in the same frame, such as a mask over a pattern.",[213,441,443],{"id":442},"used-by","Used by",[156,445,446,450,451],{},[417,447,449],{"href":448},"\u002Fdocs\u002Fcomponents\u002Fgodrays","Godrays",", ",[417,452,454],{"href":453},"\u002Fdocs\u002Fcomponents\u002Fsunburst","SunBurst",[456,457,458],"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 .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}",{"title":165,"searchDepth":460,"depth":460,"links":461},2,[462,463,464,465],{"id":215,"depth":460,"text":216},{"id":285,"depth":460,"text":286},{"id":408,"depth":460,"text":409},{"id":442,"depth":460,"text":443},"Light",false,"md","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Flight\u002Fwithframe",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Flight.ts#L254","docs\u002Fprimitives\u002F13.light\u002F7.withframe","3rTTVUmYH4k33TZVrtb1JE7dOIL509Uk5KGBka96SOg"]