[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fcomponents\u002Fsatin":155},{"stars":4},3547,[6,12,18,22,26,30,34,38,42,46,50,54,58,62,66,71,75,79,83,88,92,96,100,104,108,112,116,120,124,127,130,134,137,141,144,148,151],{"path":7,"title":8,"description":9,"category":10,"exclude":11,"forceFramework":11},"\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":13,"title":14,"description":15,"category":10,"exclude":16,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fquickstart","Quickstart","Install Shaders, render your first effect, and drive a prop from state.",[17],"js",{"path":19,"title":20,"description":21,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fcomposing-effects","Composing effects","Stack components as layers and nest them to control which layers an effect touches.",{"path":23,"title":24,"description":25,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fblending-masking","Blending and masking","Control how a layer mixes with the layers below it, and reveal one layer through another.",{"path":27,"title":28,"description":29,"category":10,"exclude":11,"forceFramework":11},"\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":31,"title":32,"description":33,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fdynamic-props","Dynamic props","Drive any numeric or position prop from time, the cursor, or another layer, without writing animation code.",{"path":35,"title":36,"description":37,"category":10,"exclude":11,"forceFramework":11},"\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":39,"title":40,"description":41,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Ftransforms","Transforms","Position, size, and rotate any layer inside the canvas with a bounding box, in % or px units.",{"path":43,"title":44,"description":45,"category":10,"exclude":11,"forceFramework":11},"\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":47,"title":48,"description":49,"category":10,"exclude":11,"forceFramework":11},"\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":51,"title":52,"description":53,"category":10,"exclude":11,"forceFramework":11},"\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":55,"title":56,"description":57,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fperformance","Performance","Learn what makes an effect expensive on the GPU and how to keep it inside the frame budget.",{"path":59,"title":60,"description":61,"category":10,"exclude":11,"forceFramework":11},"\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":63,"title":64,"description":65,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Ftelemetry","Telemetry","The `\u003CShader>` component occasionally sends an anonymous performance report to help us improve the engine over time.",{"path":67,"title":68,"description":69,"category":70,"exclude":11,"forceFramework":11},"\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":72,"title":73,"description":74,"category":70,"exclude":11,"forceFramework":11},"\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":76,"title":77,"description":78,"category":70,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fagent-skill","Agent skill","Give your coding agent a skill that teaches it to build with Shaders components, the CLI and presets.",{"path":80,"title":81,"description":82,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fvideo-rendering","Rendering to video","Turn a shader effect into a video file, from the design editor or from a frame-by-frame pipeline such as Remotion, Hyperframes or Puppeteer.",{"path":84,"title":85,"description":86,"category":87,"exclude":11,"forceFramework":11},"\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":89,"title":90,"description":91,"category":87,"exclude":11,"forceFramework":11},"\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":93,"title":94,"description":95,"category":87,"exclude":11,"forceFramework":11},"\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":97,"title":98,"description":99,"category":87,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fmasking-and-blending","Masking and blending","How blend modes and masks combine components in the design editor.",{"path":101,"title":102,"description":103,"category":87,"exclude":11,"forceFramework":11},"\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":105,"title":106,"description":107,"category":87,"exclude":11,"forceFramework":11},"\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":109,"title":110,"description":111,"category":87,"exclude":11,"forceFramework":11},"\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":113,"title":114,"description":115,"category":87,"exclude":11,"forceFramework":11},"\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":117,"title":118,"description":119,"category":87,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fglass-component-spotlight","Component spotlight: Glass","A short look at the Glass component and the liquid-glass look it creates.",{"path":121,"title":122,"description":123,"category":87,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fdigital-looks-component-spotlight","Component spotlight: Digital looks","A look at the digital stylization components for glitchy, futuristic, or technical effects.",{"path":125,"title":14,"description":126,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fjs\u002Fquickstart","Install Shaders without a framework, render your first effect on a canvas, and update props at runtime.",{"path":128,"title":14,"description":129,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Freact\u002Fquickstart","Install Shaders in a React app, render your first effect, and drive a prop from state.",{"path":131,"title":132,"description":133,"category":10,"exclude":11,"forceFramework":11},"\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":135,"title":14,"description":136,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fsolid\u002Fquickstart","Install Shaders in a Solid app, render your first effect, and drive a prop from a signal.",{"path":138,"title":139,"description":140,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fsolid\u002Fssr","SolidStart and SSR","Render Shaders in SolidStart and other Solid SSR apps by keeping each shader on the client.",{"path":142,"title":14,"description":143,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fsvelte\u002Fquickstart","Install Shaders in a Svelte app, render your first effect, and drive a prop from state.",{"path":145,"title":146,"description":147,"category":10,"exclude":11,"forceFramework":11},"\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":149,"title":14,"description":150,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fvue\u002Fquickstart","Install Shaders in a Vue app, render your first effect, and drive a prop from a ref.",{"path":152,"title":153,"description":154,"category":10,"exclude":11,"forceFramework":11},"\u002Fdocs\u002Fguide\u002Fvue\u002Fssr","Nuxt and SSR","Render Shaders in Nuxt and other Vue SSR apps by keeping each shader on the client.",{"id":156,"title":157,"body":158,"category":464,"componentType":465,"description":168,"extension":466,"meta":467,"navigation":400,"path":468,"requiresChild":469,"seo":470,"sourceUrl":471,"stem":472,"__hash__":473},"components\u002Fdocs\u002Fcomponents\u002FSatin.md","Satin",{"type":159,"value":160,"toc":460},"minimark",[161,165,169,172,177,181,185,456],[162,163,157],"h1",{"id":164},"satin",[166,167,168],"p",{},"Flowing satin — a draped cloth of soft rippling folds lit like real fabric: a highlight streaked along the weave, a velvet sheen on the fold flanks and creases falling into shadow, swaying gently in a breeze",[170,171],"shader-preview",{"component":157},[173,174,176],"h2",{"id":175},"props","Props",[178,179],"props-table",{":props":180},"[{\"name\":\"color\",\"type\":\"string\",\"default\":\"#c92c40\",\"description\":\"The dye of the cloth — deep colors show the sheen best\"},{\"name\":\"highlightColor\",\"type\":\"string\",\"default\":\"#c4667b\",\"description\":\"The color of the light caught by the weave — near white for silk, tinted toward the dye for a matte satin\"},{\"name\":\"foldCount\",\"type\":\"number\",\"default\":\"7\",\"description\":\"How many ridges run across the cloth\"},{\"name\":\"foldDirection\",\"type\":\"number\",\"default\":\"90\",\"description\":\"Direction the folds run, in degrees — 90 hangs them vertically like a curtain\"},{\"name\":\"foldDepth\",\"type\":\"number\",\"default\":\"0.5\",\"description\":\"How deep the folds are — 0 is a flat sheet, 1 heavy gathered drapery\"},{\"name\":\"foldWidth\",\"type\":\"number\",\"default\":\"0.14\",\"description\":\"Width of each ridge, relative to the canvas — narrow for fine pleats, wide for broad soft folds\"},{\"name\":\"pinning\",\"type\":\"number\",\"default\":\"0.6\",\"description\":\"How much the cloth is gathered at the top edge — 0 is a loose drape, 1 a curtain pinned at the rail with the folds opening as they fall\"},{\"name\":\"seed\",\"type\":\"number\",\"default\":\"0\",\"description\":\"Random seed — a different layout of folds\"},{\"name\":\"speed\",\"type\":\"number\",\"default\":\"1\",\"description\":\"How fast the cloth moves. 0 pauses.\"},{\"name\":\"breeze\",\"type\":\"number\",\"default\":\"0.4\",\"description\":\"Strength of the breeze — how far the folds ripple and sway\"},{\"name\":\"gloss\",\"type\":\"number\",\"default\":\"0.1\",\"description\":\"How shiny the weave is — 0 soft matte satin, 1 glossy silk with a tight bright streak\"},{\"name\":\"anisotropy\",\"type\":\"number\",\"default\":\"0.7\",\"description\":\"How much the highlight stretches along the threads — the long streak real satin shows\"},{\"name\":\"bloom\",\"type\":\"number\",\"default\":\"0.5\",\"description\":\"The broad soft glow around the highlight — light the weave scatters sideways. 0 leaves the crisp streak alone, 1 a wide satin bloom\"},{\"name\":\"sheen\",\"type\":\"number\",\"default\":\"0.5\",\"description\":\"The velvet glow on the flanks of each fold where the fibres catch the light edge-on\"},{\"name\":\"weave\",\"type\":\"number\",\"default\":\"0.1\",\"description\":\"Visibility of the thread texture — the fine grain that glints inside the highlight\"},{\"name\":\"fiberAngle\",\"type\":\"number\",\"default\":\"90\",\"description\":\"Direction the threads run, in degrees — the highlight streaks along this axis. Usually the fold direction.\"},{\"name\":\"lightAngle\",\"type\":\"number\",\"default\":\"215\",\"description\":\"Direction of the key light, in degrees\"},{\"name\":\"fill\",\"type\":\"number\",\"default\":\"0.35\",\"description\":\"Strength of the fill light from the opposite side — lifts the shadowed flanks\"}]",[173,182,184],{"id":183},"usage","Usage",[186,187,189,253,295,335,375],"code-group",{":tabs":188},"[\"Vue\", \"React\", \"Svelte\", \"Solid\", \"JS\"]",[190,191,196],"pre",{"className":192,"code":193,"language":194,"meta":195,"style":195},"language-vue-html shiki shiki-themes github-dark","\u003CShader>\n  \u003CSatin\n    color=\"#c92c40\"\n  \u002F>\n\u003C\u002FShader>\n","vue-html","",[10,197,198,214,223,237,243],{"__ignoreMap":195},[199,200,203,207,211],"span",{"class":201,"line":202},"line",1,[199,204,206],{"class":205},"s95oV","\u003C",[199,208,210],{"class":209},"s4JwU","Shader",[199,212,213],{"class":205},">\n",[199,215,217,220],{"class":201,"line":216},2,[199,218,219],{"class":205},"  \u003C",[199,221,222],{"class":209},"Satin\n",[199,224,226,230,233],{"class":201,"line":225},3,[199,227,229],{"class":228},"svObZ","    color",[199,231,232],{"class":205},"=",[199,234,236],{"class":235},"sU2Wk","\"#c92c40\"\n",[199,238,240],{"class":201,"line":239},4,[199,241,242],{"class":205},"  \u002F>\n",[199,244,246,249,251],{"class":201,"line":245},5,[199,247,248],{"class":205},"\u003C\u002F",[199,250,210],{"class":209},[199,252,213],{"class":205},[190,254,257],{"className":255,"code":193,"language":256,"meta":195,"style":195},"language-jsx shiki shiki-themes github-dark","jsx",[10,258,259,268,274,283,287],{"__ignoreMap":195},[199,260,261,263,266],{"class":201,"line":202},[199,262,206],{"class":205},[199,264,210],{"class":265},"sDLfK",[199,267,213],{"class":205},[199,269,270,272],{"class":201,"line":216},[199,271,219],{"class":205},[199,273,222],{"class":265},[199,275,276,278,281],{"class":201,"line":225},[199,277,229],{"class":228},[199,279,232],{"class":280},"snl16",[199,282,236],{"class":235},[199,284,285],{"class":201,"line":239},[199,286,242],{"class":205},[199,288,289,291,293],{"class":201,"line":245},[199,290,248],{"class":205},[199,292,210],{"class":265},[199,294,213],{"class":205},[190,296,299],{"className":297,"code":193,"language":298,"meta":195,"style":195},"language-svelte shiki shiki-themes github-dark","svelte",[10,300,301,309,315,323,327],{"__ignoreMap":195},[199,302,303,305,307],{"class":201,"line":202},[199,304,206],{"class":205},[199,306,210],{"class":265},[199,308,213],{"class":205},[199,310,311,313],{"class":201,"line":216},[199,312,219],{"class":205},[199,314,222],{"class":265},[199,316,317,319,321],{"class":201,"line":225},[199,318,229],{"class":228},[199,320,232],{"class":205},[199,322,236],{"class":235},[199,324,325],{"class":201,"line":239},[199,326,242],{"class":205},[199,328,329,331,333],{"class":201,"line":245},[199,330,248],{"class":205},[199,332,210],{"class":265},[199,334,213],{"class":205},[190,336,339],{"className":337,"code":193,"language":338,"meta":195,"style":195},"language-tsx shiki shiki-themes github-dark","tsx",[10,340,341,349,355,363,367],{"__ignoreMap":195},[199,342,343,345,347],{"class":201,"line":202},[199,344,206],{"class":205},[199,346,210],{"class":265},[199,348,213],{"class":205},[199,350,351,353],{"class":201,"line":216},[199,352,219],{"class":205},[199,354,222],{"class":265},[199,356,357,359,361],{"class":201,"line":225},[199,358,229],{"class":228},[199,360,232],{"class":280},[199,362,236],{"class":235},[199,364,365],{"class":201,"line":239},[199,366,242],{"class":205},[199,368,369,371,373],{"class":201,"line":245},[199,370,248],{"class":205},[199,372,210],{"class":265},[199,374,213],{"class":205},[190,376,380],{"className":377,"code":378,"language":379,"meta":195,"style":195},"language-javascript shiki shiki-themes github-dark","import { createShader } from 'shaders\u002Fjs'\n\nconst shader = await createShader(canvas, {\n  components: [\n    { type: 'Satin', props: { color: '#c92c40' } }\n  ]\n})\n","javascript",[10,381,382,396,402,422,427,444,450],{"__ignoreMap":195},[199,383,384,387,390,393],{"class":201,"line":202},[199,385,386],{"class":280},"import",[199,388,389],{"class":205}," { createShader } ",[199,391,392],{"class":280},"from",[199,394,395],{"class":235}," 'shaders\u002Fjs'\n",[199,397,398],{"class":201,"line":216},[199,399,401],{"emptyLinePlaceholder":400},true,"\n",[199,403,404,407,410,413,416,419],{"class":201,"line":225},[199,405,406],{"class":280},"const",[199,408,409],{"class":265}," shader",[199,411,412],{"class":280}," =",[199,414,415],{"class":280}," await",[199,417,418],{"class":228}," createShader",[199,420,421],{"class":205},"(canvas, {\n",[199,423,424],{"class":201,"line":239},[199,425,426],{"class":205},"  components: [\n",[199,428,429,432,435,438,441],{"class":201,"line":245},[199,430,431],{"class":205},"    { type: ",[199,433,434],{"class":235},"'Satin'",[199,436,437],{"class":205},", props: { color: ",[199,439,440],{"class":235},"'#c92c40'",[199,442,443],{"class":205}," } }\n",[199,445,447],{"class":201,"line":446},6,[199,448,449],{"class":205},"  ]\n",[199,451,453],{"class":201,"line":452},7,[199,454,455],{"class":205},"})\n",[457,458,459],"style",{},"html pre.shiki code .s95oV, html code.shiki .s95oV{--shiki-default:#E1E4E8}html pre.shiki code .s4JwU, html code.shiki .s4JwU{--shiki-default:#85E89D}html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}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 .snl16, html code.shiki .snl16{--shiki-default:#F97583}",{"title":195,"searchDepth":216,"depth":216,"links":461},[462,463],{"id":175,"depth":216,"text":176},{"id":183,"depth":216,"text":184},"Textures","Generator","md",{},"\u002Fdocs\u002Fcomponents\u002Fsatin",false,{"title":157,"description":168},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fshaders\u002FSatin\u002Findex.ts","docs\u002Fcomponents\u002FSatin","IlwURr8Q-9p4M14GHG6XDAlNB2k8iKAp6Kx7OwOqUhg"]