[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Fpeelcompose":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":466,"categorySlug":467,"categoryTitle":468,"curated":469,"description":158,"editUrl":9,"extension":470,"group":215,"groupTitle":471,"kind":472,"meta":473,"navigation":474,"path":475,"seo":476,"sourceUrl":477,"stem":478,"wordCount":9,"__hash__":479},"primitives\u002Fdocs\u002Fprimitives\u002F27.effects-blurs\u002F37.peelcompose.md","peelCompose",{"type":149,"value":150,"toc":460},"minimark",[151,155,159,210,225,232,237,286,294,297,301,396,400,446,450,456],[152,153,147],"h1",{"id":154},"peelcompose",[156,157,158],"p",{},"A finished page peel: the cast shadows, the flat page and the lit curl, layered back to front.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","peelCompose(frame: GatherFrame, parts: {\n    shade: PeelShade\n    sheen: PeelShade\n    overhang: PeelShade\n    reveal: PeelShade\n}): SampleStage\n","ts","",[8,167,168,180,186,192,198,204],{"__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","(frame: GatherFrame, parts: {\n",[169,181,183],{"class":171,"line":182},2,[169,184,185],{"class":178},"    shade: PeelShade\n",[169,187,189],{"class":171,"line":188},3,[169,190,191],{"class":178},"    sheen: PeelShade\n",[169,193,195],{"class":171,"line":194},4,[169,196,197],{"class":178},"    overhang: PeelShade\n",[169,199,201],{"class":171,"line":200},5,[169,202,203],{"class":178},"    reveal: PeelShade\n",[169,205,207],{"class":171,"line":206},6,[169,208,209],{"class":178},"}): SampleStage\n",[156,211,212,213,216,217,220,221,224],{},"Import ",[8,214,215],{},"effects"," from ",[8,218,219],{},"shaders\u002Fstd"," and use ",[8,222,223],{},"effects.blurs.peelCompose",".",[156,226,227,228,231],{},"The sampling stage of a peel. Pass the four shading terms built on the same frame. Wrap it in ",[8,229,230],{},"gatherStack"," with no overlays.",[233,234,236],"h2",{"id":235},"parameters","Parameters",[238,239,240,256],"table",{},[241,242,243],"thead",{},[244,245,246,250,253],"tr",{},[247,248,249],"th",{},"Name",[247,251,252],{},"Type",[247,254,255],{},"Notes",[257,258,259,274],"tbody",{},[244,260,261,267,272],{},[262,263,264],"td",{},[8,265,266],{},"frame",[262,268,269],{},[8,270,271],{},"GatherFrame",[262,273],{},[244,275,276,281,284],{},[262,277,278],{},[8,279,280],{},"parts",[262,282,283],{},"`{",[262,285],{},[160,287,292],{"className":288,"code":290,"language":291},[289],"language-text","shade: PeelShade\nsheen: PeelShade\noverhang: PeelShade\nreveal: PeelShade\n","text",[8,293,290],{"__ignoreMap":165},[156,295,296],{},"}` |  |",[233,298,300],{"id":299},"example","Example",[160,302,304],{"className":162,"code":303,"language":164,"meta":165,"style":165},"effect: gatherStack(peelCompose(peel, {shade: curlShading(peel, {shading: 0.55}), sheen: curlSheen(peel, {highlight: 0.4, softness: 0.2}), overhang: overhangShadow(peel, {amount: p('amount'), shadow: 1}), reveal: revealShadow(peel, {amount: p('amount'), shadow: 1})}), [])\n",[8,305,306],{"__ignoreMap":165},[169,307,308,311,314,316,319,321,324,327,330,334,337,340,343,346,349,352,355,358,361,363,365,369,372,375,378,381,383,385,387,389,391,393],{"class":171,"line":172},[169,309,310],{"class":175},"effect",[169,312,313],{"class":178},": ",[169,315,230],{"class":175},[169,317,318],{"class":178},"(",[169,320,147],{"class":175},[169,322,323],{"class":178},"(peel, {shade: ",[169,325,326],{"class":175},"curlShading",[169,328,329],{"class":178},"(peel, {shading: ",[169,331,333],{"class":332},"sDLfK","0.55",[169,335,336],{"class":178},"}), sheen: ",[169,338,339],{"class":175},"curlSheen",[169,341,342],{"class":178},"(peel, {highlight: ",[169,344,345],{"class":332},"0.4",[169,347,348],{"class":178},", softness: ",[169,350,351],{"class":332},"0.2",[169,353,354],{"class":178},"}), overhang: ",[169,356,357],{"class":175},"overhangShadow",[169,359,360],{"class":178},"(peel, {amount: ",[169,362,156],{"class":175},[169,364,318],{"class":178},[169,366,368],{"class":367},"sU2Wk","'amount'",[169,370,371],{"class":178},"), shadow: ",[169,373,374],{"class":332},"1",[169,376,377],{"class":178},"}), reveal: ",[169,379,380],{"class":175},"revealShadow",[169,382,360],{"class":178},[169,384,156],{"class":175},[169,386,318],{"class":178},[169,388,368],{"class":367},[169,390,371],{"class":178},[169,392,374],{"class":332},[169,394,395],{"class":178},"})}), [])\n",[233,397,399],{"id":398},"see-also","See also",[401,402,403,414,422,430,438],"ul",{},[404,405,406,413],"li",{},[407,408,410],"a",{"href":409},"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Fpeelframe",[8,411,412],{},"peelFrame"," — The geometry of a page curling up from one corner: where the curl reads the child from, how far it has turned, and how far each pixel is from the crease.",[404,415,416,421],{},[407,417,419],{"href":418},"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Fcurlshading",[8,420,326],{}," — The darkening in the crook of a curl, easing to full brightness at the lip.",[404,423,424,429],{},[407,425,427],{"href":426},"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Fcurlsheen",[8,428,339],{}," — The band of light running up a curl.",[404,431,432,437],{},[407,433,435],{"href":434},"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Foverhangshadow",[8,436,357],{}," — The shadow a lifted curl casts on the flat page just past the crease.",[404,439,440,445],{},[407,441,443],{"href":442},"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Frevealshadow",[8,444,380],{}," — The shadow on the surface a peel reveals, just inside the crease.",[233,447,449],{"id":448},"used-by","Used by",[156,451,452],{},[407,453,455],{"href":454},"\u002Fdocs\u002Fcomponents\u002Fpagepeel","PagePeel",[457,458,459],"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":165,"searchDepth":182,"depth":182,"links":461},[462,463,464,465],{"id":235,"depth":182,"text":236},{"id":299,"depth":182,"text":300},{"id":398,"depth":182,"text":399},{"id":448,"depth":182,"text":449},"effects.blurs","effects-blurs","Blurs, glows & screens",false,"md","Filters & effects","function",{},true,"\u002Fdocs\u002Fprimitives\u002Feffects-blurs\u002Fpeelcompose",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Feffects\u002Fblurs.ts#L1335","docs\u002Fprimitives\u002F27.effects-blurs\u002F37.peelcompose","N08e3Nf0irDAOzlhTFgTzWJ9ZWrbSGKdaPMXHKbpRHA"]