[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fmotion\u002Fpulsetrain":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":221,"categorySlug":221,"categoryTitle":414,"curated":415,"description":158,"editUrl":9,"extension":416,"group":417,"groupTitle":418,"kind":419,"meta":420,"navigation":421,"path":422,"seo":423,"sourceUrl":424,"stem":425,"wordCount":9,"__hash__":426},"primitives\u002Fdocs\u002Fprimitives\u002F23.motion\u002F6.pulsetrain.md","pulseTrain",{"type":149,"value":150,"toc":409},"minimark",[151,155,159,216,231,245,250,301,305,354,358,405],[152,153,147],"h1",{"id":154},"pulsetrain",[156,157,158],"p",{},"An on\u002Foff rhythm: 1 for the first part of each cycle, 0 for the rest.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","pulseTrain(\n  t: Expr,\n  opts: {period: Expr | number; duty: Expr | number; soften?: number},\n): Expr\n","ts","",[8,167,168,180,186,210],{"__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","(\n",[169,181,183],{"class":171,"line":182},2,[169,184,185],{"class":178},"  t: Expr,\n",[169,187,189,192,196,199,201,204,207],{"class":171,"line":188},3,[169,190,191],{"class":178},"  opts: {period: Expr ",[169,193,195],{"class":194},"snl16","|",[169,197,198],{"class":178}," number; duty: Expr ",[169,200,195],{"class":194},[169,202,203],{"class":178}," number; soften",[169,205,206],{"class":194},"?:",[169,208,209],{"class":178}," number},\n",[169,211,213],{"class":171,"line":212},4,[169,214,215],{"class":178},"): Expr\n",[156,217,218,219,222,223,226,227,230],{},"Import ",[8,220,221],{},"motion"," from ",[8,224,225],{},"shaders\u002Fstd"," and use ",[8,228,229],{},"motion.pulseTrain",".",[156,232,233,236,237,240,241,244],{},[8,234,235],{},"period"," is seconds per cycle and ",[8,238,239],{},"duty"," is the on fraction, 0..1. ",[8,242,243],{},"soften"," eases both edges over that fraction of the cycle. Leave it at 0 for a hard blink.",[246,247,249],"h2",{"id":248},"parameters","Parameters",[251,252,253,269],"table",{},[254,255,256],"thead",{},[257,258,259,263,266],"tr",{},[260,261,262],"th",{},"Name",[260,264,265],{},"Type",[260,267,268],{},"Notes",[270,271,272,287],"tbody",{},[257,273,274,280,285],{},[275,276,277],"td",{},[8,278,279],{},"t",[275,281,282],{},[8,283,284],{},"Expr",[275,286],{},[257,288,289,294,299],{},[275,290,291],{},[8,292,293],{},"opts",[275,295,296],{},[8,297,298],{},"{period: Expr | number; duty: Expr | number; soften?: number}",[275,300],{},[246,302,304],{"id":303},"example","Example",[160,306,308],{"className":162,"code":307,"language":164,"meta":165,"style":165},"const blink = motion.pulseTrain(animatedTime(params), {period: 1.5, duty: 0.3, soften: 0.05})\n",[8,309,310],{"__ignoreMap":165},[169,311,312,315,319,322,325,327,330,333,336,339,342,345,348,351],{"class":171,"line":172},[169,313,314],{"class":194},"const",[169,316,318],{"class":317},"sDLfK"," blink",[169,320,321],{"class":194}," =",[169,323,324],{"class":178}," motion.",[169,326,147],{"class":175},[169,328,329],{"class":178},"(",[169,331,332],{"class":175},"animatedTime",[169,334,335],{"class":178},"(params), {period: ",[169,337,338],{"class":317},"1.5",[169,340,341],{"class":178},", duty: ",[169,343,344],{"class":317},"0.3",[169,346,347],{"class":178},", soften: ",[169,349,350],{"class":317},"0.05",[169,352,353],{"class":178},"})\n",[246,355,357],{"id":356},"see-also","See also",[359,360,361,372,389],"ul",{},[362,363,364,371],"li",{},[365,366,368],"a",{"href":367},"\u002Fdocs\u002Fprimitives\u002Fmotion\u002Fpulsing",[8,369,370],{},"pulsing"," — A knob that switches on and off in a rhythm, for any slot that takes a prop.",[362,373,374,380,381,384,385,388],{},[365,375,377],{"href":376},"\u002Fdocs\u002Fprimitives\u002Fmotion\u002Fcycle",[8,378,379],{},"cycle"," — A repeating cycle as two numbers: ",[8,382,383],{},"progress"," (0..1 through the current cycle) and ",[8,386,387],{},"index"," (which cycle this is).",[362,390,391,397,398,401,402,230],{},[365,392,394],{"href":393},"\u002Fdocs\u002Fprimitives\u002Fmotion\u002Foscillate",[8,395,396],{},"oscillate"," — A smooth back-and-forth between ",[8,399,400],{},"min"," and ",[8,403,404],{},"max",[406,407,408],"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}",{"title":165,"searchDepth":182,"depth":182,"links":410},[411,412,413],{"id":248,"depth":182,"text":249},{"id":303,"depth":182,"text":304},{"id":356,"depth":182,"text":357},"Motion & timing",false,"md","space","Shapes, frames & warps","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fmotion\u002Fpulsetrain",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fmotion.ts#L88","docs\u002Fprimitives\u002F23.motion\u002F6.pulsetrain","Vfi7ZgnF8u0n7K9aVoNoCo4OyUO9vDvqdl_3YIFJGp8"]