[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fpaint\u002Fpulse":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":184,"categorySlug":184,"categoryTitle":404,"curated":405,"description":157,"editUrl":9,"extension":406,"group":184,"groupTitle":407,"kind":408,"meta":409,"navigation":410,"path":411,"seo":412,"sourceUrl":413,"stem":414,"wordCount":9,"__hash__":415},"primitives\u002Fdocs\u002Fprimitives\u002F6.paint\u002F15.pulse.md","pulse",{"type":149,"value":150,"toc":397},"minimark",[151,154,158,179,194,217,222,273,277,357,361,383,387,393],[152,153,147],"h1",{"id":147},[155,156,157],"p",{},"A gentle brightness pulse that follows a pattern field, hovering around 1.",[159,160,165],"pre",{"className":161,"code":162,"language":163,"meta":164,"style":164},"language-ts shiki shiki-themes github-dark","pulse(field: Field, opts: {speed: number; span: number; depth: number}): Field\n","ts","",[8,166,167],{"__ignoreMap":164},[168,169,172,175],"span",{"class":170,"line":171},"line",1,[168,173,147],{"class":174},"svObZ",[168,176,178],{"class":177},"s95oV","(field: Field, opts: {speed: number; span: number; depth: number}): Field\n",[155,180,181,182,185,186,189,190,193],{},"Import ",[8,183,184],{},"paint"," from ",[8,187,188],{},"shaders\u002Fstd"," and use ",[8,191,192],{},"paint.pulse",".",[155,195,196,197,200,201,203,204,206,207,210,211,213,214,193],{},"The result swings between 1 − ",[8,198,199],{},"depth"," and 1 + ",[8,202,199],{},", so ",[8,205,199],{}," around 0.02 is subtle. ",[8,208,209],{},"speed"," is how fast it breathes, ",[8,212,168],{}," how much the pattern staggers the phase. Use it as the gain in ",[8,215,216],{},"shimmered",[218,219,221],"h2",{"id":220},"parameters","Parameters",[223,224,225,241],"table",{},[226,227,228],"thead",{},[229,230,231,235,238],"tr",{},[232,233,234],"th",{},"Name",[232,236,237],{},"Type",[232,239,240],{},"Notes",[242,243,244,259],"tbody",{},[229,245,246,252,257],{},[247,248,249],"td",{},[8,250,251],{},"field",[247,253,254],{},[8,255,256],{},"Field",[247,258],{},[229,260,261,266,271],{},[247,262,263],{},[8,264,265],{},"opts",[247,267,268],{},[8,269,270],{},"{speed: number; span: number; depth: number}",[247,272],{},[218,274,276],{"id":275},"example","Example",[159,278,280],{"className":161,"code":279,"language":163,"meta":164,"style":164},"paint: shimmered(rampOver(threshold(pattern, {low: 0.3, high: 0.7}), stops(p('colorSpace'))), pulse(pattern, {speed: 2.5, span: 8, depth: 0.015}))\n",[8,281,282],{"__ignoreMap":164},[168,283,284,286,289,291,294,297,299,302,305,309,312,315,318,321,323,325,327,331,334,336,339,342,345,348,351,354],{"class":170,"line":171},[168,285,184],{"class":174},[168,287,288],{"class":177},": ",[168,290,216],{"class":174},[168,292,293],{"class":177},"(",[168,295,296],{"class":174},"rampOver",[168,298,293],{"class":177},[168,300,301],{"class":174},"threshold",[168,303,304],{"class":177},"(pattern, {low: ",[168,306,308],{"class":307},"sDLfK","0.3",[168,310,311],{"class":177},", high: ",[168,313,314],{"class":307},"0.7",[168,316,317],{"class":177},"}), ",[168,319,320],{"class":174},"stops",[168,322,293],{"class":177},[168,324,155],{"class":174},[168,326,293],{"class":177},[168,328,330],{"class":329},"sU2Wk","'colorSpace'",[168,332,333],{"class":177},"))), ",[168,335,147],{"class":174},[168,337,338],{"class":177},"(pattern, {speed: ",[168,340,341],{"class":307},"2.5",[168,343,344],{"class":177},", span: ",[168,346,347],{"class":307},"8",[168,349,350],{"class":177},", depth: ",[168,352,353],{"class":307},"0.015",[168,355,356],{"class":177},"}))\n",[218,358,360],{"id":359},"see-also","See also",[362,363,364,374],"ul",{},[365,366,367,373],"li",{},[368,369,371],"a",{"href":370},"\u002Fdocs\u002Fprimitives\u002Fpaint\u002Fshimmered",[8,372,216],{}," — Multiplies a paint's color and alpha by a gain field, for a slow shimmer over a pattern.",[365,375,376,382],{},[368,377,379],{"href":378},"\u002Fdocs\u002Fprimitives\u002Fpaint\u002Fflowfield",[8,380,381],{},"flowField"," — A swirling, animated wave pattern from −1 to 1.",[218,384,386],{"id":385},"used-by","Used by",[155,388,389],{},[368,390,392],{"href":391},"\u002Fdocs\u002Fcomponents\u002Fswirl","Swirl",[394,395,396],"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 .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":164,"searchDepth":398,"depth":398,"links":399},2,[400,401,402,403],{"id":220,"depth":398,"text":221},{"id":275,"depth":398,"text":276},{"id":359,"depth":398,"text":360},{"id":385,"depth":398,"text":386},"Fields, palettes & ramps",false,"md","Painting","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fpaint\u002Fpulse",{"title":147,"description":157},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Ffields.ts#L592","docs\u002Fprimitives\u002F6.paint\u002F15.pulse","cX5GAxtUGJe9DBq9pyAeFttxlGoCSh2LPWlOprrS4Es"]