[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fcellframe":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":185,"categorySlug":185,"categoryTitle":479,"curated":480,"description":158,"editUrl":9,"extension":481,"group":482,"groupTitle":483,"kind":484,"meta":485,"navigation":486,"path":487,"seo":488,"sourceUrl":489,"stem":490,"wordCount":9,"__hash__":491},"primitives\u002Fdocs\u002Fprimitives\u002F8.patterns\u002F9.cellframe.md","cellFrame",{"type":149,"value":150,"toc":472},"minimark",[151,155,159,180,195,229,234,271,275,362,372,376,438,442,468],[152,153,147],"h1",{"id":154},"cellframe",[156,157,158],"p",{},"The shared coordinate system of a tiled pattern: how many cells fit down the canvas height and how far the whole lattice is rotated.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","cellFrame(slots: {cells: PropRef; rotation: PropRef; convention: CellFrameConvention}): PatternPaint\n","ts","",[8,167,168],{"__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","(slots: {cells: PropRef; rotation: PropRef; convention: CellFrameConvention}): PatternPaint\n",[156,181,182,183,186,187,190,191,194],{},"Import ",[8,184,185],{},"patterns"," from ",[8,188,189],{},"shaders\u002Fstd"," and use ",[8,192,193],{},"patterns.cellFrame",".",[156,196,197,200,201,204,205,208,209,212,213,212,216,212,219,212,222,225,226,194],{},[8,198,199],{},"cells"," counts cells along the canvas height, so cells stay square as the canvas resizes. ",[8,202,203],{},"rotation"," is in degrees about the canvas centre. Pass the result as the ",[8,206,207],{},"frame"," of ",[8,210,211],{},"gridLines",", ",[8,214,215],{},"hexLines",[8,217,218],{},"triangleLines",[8,220,221],{},"truchetArcs",[8,223,224],{},"weaveThreads"," or ",[8,227,228],{},"isoCubeFaces",[230,231,233],"h2",{"id":232},"parameters","Parameters",[235,236,237,253],"table",{},[238,239,240],"thead",{},[241,242,243,247,250],"tr",{},[244,245,246],"th",{},"Name",[244,248,249],{},"Type",[244,251,252],{},"Notes",[254,255,256],"tbody",{},[241,257,258,264,269],{},[259,260,261],"td",{},[8,262,263],{},"slots",[259,265,266],{},[8,267,268],{},"{cells: PropRef; rotation: PropRef; convention: CellFrameConvention}",[259,270],{},[230,272,274],{"id":273},"example","Example",[160,276,278],{"className":162,"code":277,"language":164,"meta":165,"style":165},"const field = gridLines({frame: cellFrame({cells: p('cells'), rotation: p('rotation'), convention: 'flippedY'}), thickness: p('thickness'), softness: p('softness'), variation: p('variation')})\n",[8,279,280],{"__ignoreMap":165},[169,281,282,286,290,293,296,299,301,304,306,309,313,316,318,320,323,326,329,332,334,336,339,342,344,346,349,352,354,356,359],{"class":171,"line":172},[169,283,285],{"class":284},"snl16","const",[169,287,289],{"class":288},"sDLfK"," field",[169,291,292],{"class":284}," =",[169,294,295],{"class":175}," gridLines",[169,297,298],{"class":178},"({frame: ",[169,300,147],{"class":175},[169,302,303],{"class":178},"({cells: ",[169,305,156],{"class":175},[169,307,308],{"class":178},"(",[169,310,312],{"class":311},"sU2Wk","'cells'",[169,314,315],{"class":178},"), rotation: ",[169,317,156],{"class":175},[169,319,308],{"class":178},[169,321,322],{"class":311},"'rotation'",[169,324,325],{"class":178},"), convention: ",[169,327,328],{"class":311},"'flippedY'",[169,330,331],{"class":178},"}), thickness: ",[169,333,156],{"class":175},[169,335,308],{"class":178},[169,337,338],{"class":311},"'thickness'",[169,340,341],{"class":178},"), softness: ",[169,343,156],{"class":175},[169,345,308],{"class":178},[169,347,348],{"class":311},"'softness'",[169,350,351],{"class":178},"), variation: ",[169,353,156],{"class":175},[169,355,308],{"class":178},[169,357,358],{"class":311},"'variation'",[169,360,361],{"class":178},")})\n",[363,364,365],"blockquote",{},[156,366,367,371],{},[368,369,370],"strong",{},"Tip."," One frame can feed several line words. It is evaluated once however many read it.",[230,373,375],{"id":374},"see-also","See also",[377,378,379,392,403,414,422,430],"ul",{},[380,381,382,388,389,391],"li",{},[383,384,386],"a",{"href":385},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fgridlines",[8,387,211],{}," — Square grid lines drawn in a ",[8,390,147],{},", plus a per-cell shade for the fill.",[380,393,394,399,400,402],{},[383,395,397],{"href":396},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fhexlines",[8,398,215],{}," — Honeycomb lines (pointy-top hexagons) drawn in a ",[8,401,147],{},", plus a per-cell shade.",[380,404,405,410,411,413],{},[383,406,408],{"href":407},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Ftrianglelines",[8,409,218],{}," — A lattice of equilateral triangles drawn in a ",[8,412,147],{},", with rows that can drift.",[380,415,416,421],{},[383,417,419],{"href":418},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Ftruchetarcs",[8,420,221],{}," — A maze of quarter-circle arcs, two per tile, flipped at random so they join into flowing curves.",[380,423,424,429],{},[383,425,427],{"href":426},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fweavethreads",[8,428,224],{}," — Two sets of threads woven over and under each other, returned as a finished color.",[380,431,432,437],{},[383,433,435],{"href":434},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fisocubefaces",[8,436,228],{}," — Tumbling blocks: three shaded rhombus faces per hexagon that read as a field of 3D cubes.",[230,439,441],{"id":440},"used-by","Used by",[156,443,444,212,448,212,452,212,456,212,460,212,464],{},[383,445,447],{"href":446},"\u002Fdocs\u002Fcomponents\u002Fgrid","Grid",[383,449,451],{"href":450},"\u002Fdocs\u002Fcomponents\u002Fhexgrid","HexGrid",[383,453,455],{"href":454},"\u002Fdocs\u002Fcomponents\u002Fisometriccubes","IsometricCubes",[383,457,459],{"href":458},"\u002Fdocs\u002Fcomponents\u002Ftriangulargrid","TriangularGrid",[383,461,463],{"href":462},"\u002Fdocs\u002Fcomponents\u002Ftruchet","Truchet",[383,465,467],{"href":466},"\u002Fdocs\u002Fcomponents\u002Fweave","Weave",[469,470,471],"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 .snl16, html code.shiki .snl16{--shiki-default:#F97583}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":473,"depth":473,"links":474},2,[475,476,477,478],{"id":232,"depth":473,"text":233},{"id":273,"depth":473,"text":274},{"id":374,"depth":473,"text":375},{"id":440,"depth":473,"text":441},"Patterns & tiling",false,"md","paint","Painting","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fcellframe",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fpatterns.ts#L97","docs\u002Fprimitives\u002F8.patterns\u002F9.cellframe","9mkZ28MCtJ-dNGwbQFJuFMc9_QMkj6OrpJlTdlRZT5A"]