[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fframes\u002Fsegmentframe":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":239,"categorySlug":239,"categoryTitle":474,"curated":475,"description":158,"editUrl":9,"extension":476,"group":477,"groupTitle":478,"kind":479,"meta":480,"navigation":481,"path":482,"seo":483,"sourceUrl":484,"stem":485,"wordCount":9,"__hash__":486},"primitives\u002Fdocs\u002Fprimitives\u002F19.frames\u002F3.segmentframe.md","segmentFrame",{"type":149,"value":150,"toc":467},"minimark",[151,155,159,234,249,279,284,321,325,389,405,409,449,453,463],[152,153,147],"h1",{"id":154},"segmentframe",[156,157,158],"p",{},"A frame along the line between two position props: how far each pixel is along it and across it.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","segmentFrame(slots: {from: PropRef; to: PropRef}): (params: GpuFragmentParams, surface: { uv: Expr; aspect: Expr; }) => SegmentFrame\n","ts","",[8,167,168],{"__ignoreMap":165},[169,170,173,176,180,184,187,191,193,196,199,202,204,207,210,212,215,218,221,223,225,228,231],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(slots: {from: PropRef; to: PropRef})",[169,181,183],{"class":182},"snl16",":",[169,185,186],{"class":178}," (",[169,188,190],{"class":189},"s9osk","params",[169,192,183],{"class":182},[169,194,195],{"class":175}," GpuFragmentParams",[169,197,198],{"class":178},", ",[169,200,201],{"class":189},"surface",[169,203,183],{"class":182},[169,205,206],{"class":178}," { ",[169,208,209],{"class":189},"uv",[169,211,183],{"class":182},[169,213,214],{"class":175}," Expr",[169,216,217],{"class":178},"; ",[169,219,220],{"class":189},"aspect",[169,222,183],{"class":182},[169,224,214],{"class":175},[169,226,227],{"class":178},"; }) ",[169,229,230],{"class":182},"=>",[169,232,233],{"class":178}," SegmentFrame\n",[156,235,236,237,240,241,244,245,248],{},"Import ",[8,238,239],{},"frames"," from ",[8,242,243],{},"shaders\u002Fstd"," and use ",[8,246,247],{},"frames.segmentFrame",".",[156,250,251,252,255,256,258,259,262,263,266,267,270,271,274,275,278],{},"Pass ",[8,253,254],{},"{from: p('from'), to: p('to')}"," and call the result with ",[8,257,190],{}," and a surface. ",[8,260,261],{},"along"," is 0 at ",[8,264,265],{},"from"," and equals ",[8,268,269],{},"length"," at ",[8,272,273],{},"to",". ",[8,276,277],{},"across"," is the signed distance from the line. All three are aspect-corrected, in canvas-height units.",[280,281,283],"h2",{"id":282},"parameters","Parameters",[285,286,287,303],"table",{},[288,289,290],"thead",{},[291,292,293,297,300],"tr",{},[294,295,296],"th",{},"Name",[294,298,299],{},"Type",[294,301,302],{},"Notes",[304,305,306],"tbody",{},[291,307,308,314,319],{},[309,310,311],"td",{},[8,312,313],{},"slots",[309,315,316],{},[8,317,318],{},"{from: PropRef; to: PropRef}",[309,320],{},[280,322,324],{"id":323},"example","Example",[160,326,328],{"className":162,"code":327,"language":164,"meta":165,"style":165},"const {along, across, length} = segmentFrame({from: p('from'), to: p('to')})(params, surfaceOf(params))\n",[8,329,330],{"__ignoreMap":165},[169,331,332,335,338,341,343,345,347,349,352,355,358,361,363,366,370,373,375,377,380,383,386],{"class":171,"line":172},[169,333,334],{"class":182},"const",[169,336,337],{"class":178}," {",[169,339,261],{"class":340},"sDLfK",[169,342,198],{"class":178},[169,344,277],{"class":340},[169,346,198],{"class":178},[169,348,269],{"class":340},[169,350,351],{"class":178},"} ",[169,353,354],{"class":182},"=",[169,356,357],{"class":175}," segmentFrame",[169,359,360],{"class":178},"({from: ",[169,362,156],{"class":175},[169,364,365],{"class":178},"(",[169,367,369],{"class":368},"sU2Wk","'from'",[169,371,372],{"class":178},"), to: ",[169,374,156],{"class":175},[169,376,365],{"class":178},[169,378,379],{"class":368},"'to'",[169,381,382],{"class":178},")})(params, ",[169,384,385],{"class":175},"surfaceOf",[169,387,388],{"class":178},"(params))\n",[390,391,392],"blockquote",{},[156,393,394,398,399,401,402,404],{},[395,396,397],"strong",{},"Tip."," Divide ",[8,400,261],{}," by ",[8,403,269],{}," for a 0–1 position along the line, the natural gradient parameter.",[280,406,408],{"id":407},"see-also","See also",[410,411,412,423,432],"ul",{},[413,414,415,422],"li",{},[416,417,419],"a",{"href":418},"\u002Fdocs\u002Fprimitives\u002Fframes\u002Fcentredframe",[8,420,421],{},"centredFrame"," — A frame centred on a position prop: each pixel's offset from the centre and its distance.",[413,424,425,431],{},[416,426,428],{"href":427},"\u002Fdocs\u002Fprimitives\u002Fframes\u002Fdirectionframe",[8,429,430],{},"directionFrame"," — The two axes of a direction given in degrees, for patterns that run along it.",[413,433,434,439,440,442,443,446,447,248],{},[416,435,437],{"href":436},"\u002Fdocs\u002Fprimitives\u002Fframes\u002Fsurfaceof",[8,438,385],{}," — The canvas a generator paints on: its ",[8,441,209],{},", its ",[8,444,445],{},"viewport"," size in pixels and its ",[8,448,220],{},[280,450,452],{"id":451},"used-by","Used by",[156,454,455,198,459],{},[416,456,458],{"href":457},"\u002Fdocs\u002Fcomponents\u002Fprism","Prism",[416,460,462],{"href":461},"\u002Fdocs\u002Fcomponents\u002Fwaveform","Waveform",[464,465,466],"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 pre.shiki code .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}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}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":165,"searchDepth":468,"depth":468,"links":469},2,[470,471,472,473],{"id":282,"depth":468,"text":283},{"id":323,"depth":468,"text":324},{"id":407,"depth":468,"text":408},{"id":451,"depth":468,"text":452},"Frames & coordinates",false,"md","space","Shapes, frames & warps","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fframes\u002Fsegmentframe",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fframes.ts#L125","docs\u002Fprimitives\u002F19.frames\u002F3.segmentframe","bMXXEpvx79-5K4De7dC2lDjaa4xQhmqPQfheAeD9Jr8"]