[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fcomponents\u002Fsatin":129},{"stars":4},5504,[6,11,15,19,23,27,31,35,39,43,47,51,55,59,63,67,72,76,80,84,88,93,97,101,105,109,113,117,121,125],{"path":7,"title":8,"description":9,"category":10},"\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",{"path":12,"title":13,"description":14,"category":10},"\u002Fdocs\u002Fguide\u002Fquickstart","Quickstart","Install Shaders, render your first effect, and drive a prop from state.",{"path":16,"title":17,"description":18,"category":10},"\u002Fdocs\u002Fguide\u002Fcomposing-effects","Composing effects","Stack components as layers and nest them to control which layers an effect touches.",{"path":20,"title":21,"description":22,"category":10},"\u002Fdocs\u002Fguide\u002Fblending-masking","Blending and masking","Control how a layer mixes with the layers below it, and reveal one layer through another.",{"path":24,"title":25,"description":26,"category":10},"\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":28,"title":29,"description":30,"category":10},"\u002Fdocs\u002Fguide\u002Fdynamic-props","Dynamic props","Drive any numeric or position prop from time, the cursor, or another layer, without writing animation code.",{"path":32,"title":33,"description":34,"category":10},"\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":36,"title":37,"description":38,"category":10},"\u002Fdocs\u002Fguide\u002Fsizing-and-units","Sizing and units","Size and place layers in CSS units (px, %, vw, rem, and canvas units) that stay correct as the canvas and window resize.",{"path":40,"title":41,"description":42,"category":10},"\u002Fdocs\u002Fguide\u002Ftransforms","Transforms","Position, size, and rotate any layer inside the canvas with a bounding box, in any CSS unit.",{"path":44,"title":45,"description":46,"category":10},"\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":48,"title":49,"description":50,"category":10},"\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":52,"title":53,"description":54,"category":10},"\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":56,"title":57,"description":58,"category":10},"\u002Fdocs\u002Fguide\u002Fperformance","Performance","Learn what makes an effect expensive on the GPU and how to keep it inside the frame budget.",{"path":60,"title":61,"description":62,"category":10},"\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":64,"title":65,"description":66,"category":10},"\u002Fdocs\u002Fguide\u002Ftelemetry","Telemetry","The `\u003CShader>` component occasionally sends an anonymous performance report to help us improve the engine over time.",{"path":68,"title":69,"description":70,"category":71},"\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":73,"title":74,"description":75,"category":71},"\u002Fdocs\u002Fguide\u002Fcli","Shaders CLI","Install your own shaders and Pro shaders into your codebase as component files, and keep them in sync with the design editor.",{"path":77,"title":78,"description":79,"category":71},"\u002Fdocs\u002Fguide\u002Fagent-skill","Agent skill","Give your coding agent a skill that teaches it to build with Shaders components, the CLI and Pro shaders.",{"path":81,"title":82,"description":83,"category":10},"\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":85,"title":86,"description":87,"category":10},"\u002Fdocs\u002Fguide\u002Fssr","Server rendering","Render Shaders in Next.js, Nuxt, SvelteKit, SolidStart and other SSR apps by keeping each shader on the client.",{"path":89,"title":90,"description":91,"category":92},"\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":94,"title":95,"description":96,"category":92},"\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":98,"title":99,"description":100,"category":92},"\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":102,"title":103,"description":104,"category":92},"\u002Fdocs\u002Fguide\u002Fmasking-and-blending","Masking and blending","How blend modes and masks combine components in the design editor.",{"path":106,"title":107,"description":108,"category":92},"\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":110,"title":111,"description":112,"category":92},"\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":114,"title":115,"description":116,"category":92},"\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":118,"title":119,"description":120,"category":92},"\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":122,"title":123,"description":124,"category":92},"\u002Fdocs\u002Fguide\u002Fglass-component-spotlight","Component spotlight: Glass","A short look at the Glass component and the liquid-glass look it creates.",{"path":126,"title":127,"description":128,"category":92},"\u002Fdocs\u002Fguide\u002Fdigital-looks-component-spotlight","Component spotlight: Digital looks","A look at the digital stylization components for glitchy, futuristic, or technical effects.",{"id":130,"title":131,"body":132,"category":438,"componentType":439,"description":142,"extension":440,"meta":441,"navigation":374,"path":442,"requiresChild":443,"seo":444,"sourceUrl":445,"stem":446,"__hash__":447},"components\u002Fdocs\u002Fcomponents\u002FSatin.md","Satin",{"type":133,"value":134,"toc":434},"minimark",[135,139,143,146,151,155,159,430],[136,137,131],"h1",{"id":138},"satin",[140,141,142],"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",[144,145],"shader-preview",{"component":131},[147,148,150],"h2",{"id":149},"props","Props",[152,153],"props-table",{":props":154},"[{\"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\"}]",[147,156,158],{"id":157},"usage","Usage",[160,161,163,227,269,309,349],"code-group",{":tabs":162},"[\"Vue\", \"React\", \"Svelte\", \"Solid\", \"JS\"]",[164,165,170],"pre",{"className":166,"code":167,"language":168,"meta":169,"style":169},"language-vue-html shiki shiki-themes github-dark","\u003CShader>\n  \u003CSatin\n    color=\"#c92c40\"\n  \u002F>\n\u003C\u002FShader>\n","vue-html","",[10,171,172,188,197,211,217],{"__ignoreMap":169},[173,174,177,181,185],"span",{"class":175,"line":176},"line",1,[173,178,180],{"class":179},"s95oV","\u003C",[173,182,184],{"class":183},"s4JwU","Shader",[173,186,187],{"class":179},">\n",[173,189,191,194],{"class":175,"line":190},2,[173,192,193],{"class":179},"  \u003C",[173,195,196],{"class":183},"Satin\n",[173,198,200,204,207],{"class":175,"line":199},3,[173,201,203],{"class":202},"svObZ","    color",[173,205,206],{"class":179},"=",[173,208,210],{"class":209},"sU2Wk","\"#c92c40\"\n",[173,212,214],{"class":175,"line":213},4,[173,215,216],{"class":179},"  \u002F>\n",[173,218,220,223,225],{"class":175,"line":219},5,[173,221,222],{"class":179},"\u003C\u002F",[173,224,184],{"class":183},[173,226,187],{"class":179},[164,228,231],{"className":229,"code":167,"language":230,"meta":169,"style":169},"language-jsx shiki shiki-themes github-dark","jsx",[10,232,233,242,248,257,261],{"__ignoreMap":169},[173,234,235,237,240],{"class":175,"line":176},[173,236,180],{"class":179},[173,238,184],{"class":239},"sDLfK",[173,241,187],{"class":179},[173,243,244,246],{"class":175,"line":190},[173,245,193],{"class":179},[173,247,196],{"class":239},[173,249,250,252,255],{"class":175,"line":199},[173,251,203],{"class":202},[173,253,206],{"class":254},"snl16",[173,256,210],{"class":209},[173,258,259],{"class":175,"line":213},[173,260,216],{"class":179},[173,262,263,265,267],{"class":175,"line":219},[173,264,222],{"class":179},[173,266,184],{"class":239},[173,268,187],{"class":179},[164,270,273],{"className":271,"code":167,"language":272,"meta":169,"style":169},"language-svelte shiki shiki-themes github-dark","svelte",[10,274,275,283,289,297,301],{"__ignoreMap":169},[173,276,277,279,281],{"class":175,"line":176},[173,278,180],{"class":179},[173,280,184],{"class":239},[173,282,187],{"class":179},[173,284,285,287],{"class":175,"line":190},[173,286,193],{"class":179},[173,288,196],{"class":239},[173,290,291,293,295],{"class":175,"line":199},[173,292,203],{"class":202},[173,294,206],{"class":179},[173,296,210],{"class":209},[173,298,299],{"class":175,"line":213},[173,300,216],{"class":179},[173,302,303,305,307],{"class":175,"line":219},[173,304,222],{"class":179},[173,306,184],{"class":239},[173,308,187],{"class":179},[164,310,313],{"className":311,"code":167,"language":312,"meta":169,"style":169},"language-tsx shiki shiki-themes github-dark","tsx",[10,314,315,323,329,337,341],{"__ignoreMap":169},[173,316,317,319,321],{"class":175,"line":176},[173,318,180],{"class":179},[173,320,184],{"class":239},[173,322,187],{"class":179},[173,324,325,327],{"class":175,"line":190},[173,326,193],{"class":179},[173,328,196],{"class":239},[173,330,331,333,335],{"class":175,"line":199},[173,332,203],{"class":202},[173,334,206],{"class":254},[173,336,210],{"class":209},[173,338,339],{"class":175,"line":213},[173,340,216],{"class":179},[173,342,343,345,347],{"class":175,"line":219},[173,344,222],{"class":179},[173,346,184],{"class":239},[173,348,187],{"class":179},[164,350,354],{"className":351,"code":352,"language":353,"meta":169,"style":169},"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,355,356,370,376,396,401,418,424],{"__ignoreMap":169},[173,357,358,361,364,367],{"class":175,"line":176},[173,359,360],{"class":254},"import",[173,362,363],{"class":179}," { createShader } ",[173,365,366],{"class":254},"from",[173,368,369],{"class":209}," 'shaders\u002Fjs'\n",[173,371,372],{"class":175,"line":190},[173,373,375],{"emptyLinePlaceholder":374},true,"\n",[173,377,378,381,384,387,390,393],{"class":175,"line":199},[173,379,380],{"class":254},"const",[173,382,383],{"class":239}," shader",[173,385,386],{"class":254}," =",[173,388,389],{"class":254}," await",[173,391,392],{"class":202}," createShader",[173,394,395],{"class":179},"(canvas, {\n",[173,397,398],{"class":175,"line":213},[173,399,400],{"class":179},"  components: [\n",[173,402,403,406,409,412,415],{"class":175,"line":219},[173,404,405],{"class":179},"    { type: ",[173,407,408],{"class":209},"'Satin'",[173,410,411],{"class":179},", props: { color: ",[173,413,414],{"class":209},"'#c92c40'",[173,416,417],{"class":179}," } }\n",[173,419,421],{"class":175,"line":420},6,[173,422,423],{"class":179},"  ]\n",[173,425,427],{"class":175,"line":426},7,[173,428,429],{"class":179},"})\n",[431,432,433],"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":169,"searchDepth":190,"depth":190,"links":435},[436,437],{"id":149,"depth":190,"text":150},{"id":157,"depth":190,"text":158},"Textures","Generator","md",{},"\u002Fdocs\u002Fcomponents\u002Fsatin",false,{"title":131,"description":142},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fshaders\u002FSatin\u002Findex.ts","docs\u002Fcomponents\u002FSatin","IlwURr8Q-9p4M14GHG6XDAlNB2k8iKAp6Kx7OwOqUhg"]