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