[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fmotion\u002Fcycle":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":199,"categorySlug":199,"categoryTitle":380,"curated":381,"description":382,"editUrl":9,"extension":383,"group":384,"groupTitle":385,"kind":386,"meta":387,"navigation":388,"path":389,"seo":390,"sourceUrl":391,"stem":392,"wordCount":9,"__hash__":393},"primitives\u002Fdocs\u002Fprimitives\u002F23.motion\u002F3.cycle.md","cycle",{"type":149,"value":150,"toc":374},"minimark",[151,154,166,194,209,225,230,280,284,335,339,370],[152,153,147],"h1",{"id":147},[155,156,157,158,161,162,165],"p",{},"A repeating cycle as two numbers: ",[8,159,160],{},"progress"," (0..1 through the current cycle) and ",[8,163,164],{},"index"," (which cycle this is).",[167,168,173],"pre",{"className":169,"code":170,"language":171,"meta":172,"style":172},"language-ts shiki shiki-themes github-dark","cycle(t: Expr, period: Expr | number): {progress: Expr; index: Expr}\n","ts","",[8,174,175],{"__ignoreMap":172},[176,177,180,183,187,191],"span",{"class":178,"line":179},"line",1,[176,181,147],{"class":182},"svObZ",[176,184,186],{"class":185},"s95oV","(t: Expr, period: Expr ",[176,188,190],{"class":189},"snl16","|",[176,192,193],{"class":185}," number): {progress: Expr; index: Expr}\n",[155,195,196,197,200,201,204,205,208],{},"Import ",[8,198,199],{},"motion"," from ",[8,202,203],{},"shaders\u002Fstd"," and use ",[8,206,207],{},"motion.cycle",".",[155,210,211,214,215,217,218,220,221,224],{},[8,212,213],{},"period"," is the cycle length in seconds. The \"every N seconds\" word: fade something in with ",[8,216,160],{},", and feed ",[8,219,164],{}," to ",[8,222,223],{},"cycleSeed"," when each pass should look different.",[226,227,229],"h2",{"id":228},"parameters","Parameters",[231,232,233,249],"table",{},[234,235,236],"thead",{},[237,238,239,243,246],"tr",{},[240,241,242],"th",{},"Name",[240,244,245],{},"Type",[240,247,248],{},"Notes",[250,251,252,267],"tbody",{},[237,253,254,260,265],{},[255,256,257],"td",{},[8,258,259],{},"t",[255,261,262],{},[8,263,264],{},"Expr",[255,266],{},[237,268,269,273,278],{},[255,270,271],{},[8,272,213],{},[255,274,275],{},[8,276,277],{},"Expr | number",[255,279],{},[226,281,283],{"id":282},"example","Example",[167,285,287],{"className":169,"code":286,"language":171,"meta":172,"style":172},"const {progress, index} = motion.cycle(animatedTime(params), 2) \u002F\u002F a new pass every 2 s\n",[8,288,289],{"__ignoreMap":172},[176,290,291,294,297,300,303,305,308,311,314,316,319,322,325,328,331],{"class":178,"line":179},[176,292,293],{"class":189},"const",[176,295,296],{"class":185}," {",[176,298,160],{"class":299},"sDLfK",[176,301,302],{"class":185},", ",[176,304,164],{"class":299},[176,306,307],{"class":185},"} ",[176,309,310],{"class":189},"=",[176,312,313],{"class":185}," motion.",[176,315,147],{"class":182},[176,317,318],{"class":185},"(",[176,320,321],{"class":182},"animatedTime",[176,323,324],{"class":185},"(params), ",[176,326,327],{"class":299},"2",[176,329,330],{"class":185},") ",[176,332,334],{"class":333},"sAwPA","\u002F\u002F a new pass every 2 s\n",[226,336,338],{"id":337},"see-also","See also",[340,341,342,352,361],"ul",{},[343,344,345,351],"li",{},[346,347,349],"a",{"href":348},"\u002Fdocs\u002Fprimitives\u002Fmotion\u002Fcycleseed",[8,350,223],{}," — A random but stable number, 0..1, for each cycle index.",[343,353,354,360],{},[346,355,357],{"href":356},"\u002Fdocs\u002Fprimitives\u002Fmotion\u002Fphase",[8,358,359],{},"phase"," — How far through a repeating cycle the clock is, 0..1.",[343,362,363,369],{},[346,364,366],{"href":365},"\u002Fdocs\u002Fprimitives\u002Fmotion\u002Fpulsetrain",[8,367,368],{},"pulseTrain"," — An on\u002Foff rhythm: 1 for the first part of each cycle, 0 for the rest.",[371,372,373],"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 .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html pre.shiki code .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}",{"title":172,"searchDepth":375,"depth":375,"links":376},2,[377,378,379],{"id":228,"depth":375,"text":229},{"id":282,"depth":375,"text":283},{"id":337,"depth":375,"text":338},"Motion & timing",false,"A repeating cycle as two numbers: `progress` (0..1 through the current cycle) and `index` (which cycle this is).","md","space","Shapes, frames & warps","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fmotion\u002Fcycle",{"title":147,"description":382},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fmotion.ts#L54","docs\u002Fprimitives\u002F23.motion\u002F3.cycle","ZZKwr6XplfF2qkjUL3irEAPSbLyo3O-1SKfjvdhgqzo"]