[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fbrickcourses":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":245,"categorySlug":245,"categoryTitle":552,"curated":553,"description":158,"editUrl":9,"extension":554,"group":555,"groupTitle":556,"kind":557,"meta":558,"navigation":559,"path":560,"seo":561,"sourceUrl":562,"stem":563,"wordCount":9,"__hash__":564},"primitives\u002Fdocs\u002Fprimitives\u002F8.patterns\u002F13.brickcourses.md","brickCourses",{"type":149,"value":150,"toc":546},"minimark",[151,155,159,240,255,317,322,357,365,368,372,494,498,532,536,542],[152,153,147],"h1",{"id":154},"brickcourses",[156,157,158],"p",{},"A brick wall: staggered rows with mortar gaps, optional rotation and per-row drift.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","brickCourses(slots: {\n    cellsX: PropRef\n    cellsY: PropRef\n    mortar: PropRef\n    softness: PropRef\n    variation: PropRef\n    rotation: PropRef\n    offset: PropRef\n    speedVariance: PropRef\n    seed: PropRef\n}): {bricks: PatternPaint; shade: PatternPaint}\n","ts","",[8,167,168,180,186,192,198,204,210,216,222,228,234],{"__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: {\n",[169,181,183],{"class":171,"line":182},2,[169,184,185],{"class":178},"    cellsX: PropRef\n",[169,187,189],{"class":171,"line":188},3,[169,190,191],{"class":178},"    cellsY: PropRef\n",[169,193,195],{"class":171,"line":194},4,[169,196,197],{"class":178},"    mortar: PropRef\n",[169,199,201],{"class":171,"line":200},5,[169,202,203],{"class":178},"    softness: PropRef\n",[169,205,207],{"class":171,"line":206},6,[169,208,209],{"class":178},"    variation: PropRef\n",[169,211,213],{"class":171,"line":212},7,[169,214,215],{"class":178},"    rotation: PropRef\n",[169,217,219],{"class":171,"line":218},8,[169,220,221],{"class":178},"    offset: PropRef\n",[169,223,225],{"class":171,"line":224},9,[169,226,227],{"class":178},"    speedVariance: PropRef\n",[169,229,231],{"class":171,"line":230},10,[169,232,233],{"class":178},"    seed: PropRef\n",[169,235,237],{"class":171,"line":236},11,[169,238,239],{"class":178},"}): {bricks: PatternPaint; shade: PatternPaint}\n",[156,241,242,243,246,247,250,251,254],{},"Import ",[8,244,245],{},"patterns"," from ",[8,248,249],{},"shaders\u002Fstd"," and use ",[8,252,253],{},"patterns.brickCourses",".",[156,256,257,258,261,262,265,266,269,270,273,274,277,278,281,282,285,286,289,290,292,293,296,297,300,301,304,305,308,309,312,313,316],{},"Returns ",[8,259,260],{},"bricks"," (1 on a brick, 0 in the mortar) and ",[8,263,264],{},"shade"," (a brightness factor around 1 per brick for ",[8,267,268],{},"vary","). ",[8,271,272],{},"cellsX"," is bricks per row across the canvas width and ",[8,275,276],{},"cellsY"," the number of rows down its height. ",[8,279,280],{},"mortar"," 0–1 widens the gaps (1 is 30% of a brick), equal in pixels both ways. ",[8,283,284],{},"softness"," 0–1 blurs the edges. ",[8,287,288],{},"variation"," 0–1 sets how far ",[8,291,264],{}," strays from 1. ",[8,294,295],{},"rotation"," is in degrees. ",[8,298,299],{},"offset"," slides the rows; 1 is one brick. ",[8,302,303],{},"speedVariance"," 0–1 and ",[8,306,307],{},"seed"," randomise the per-row drift. Declare ",[8,310,311],{},"animatedTime: {speed: 'speed'}"," on the definition. It brings its own frame, so there is no ",[8,314,315],{},"frame"," slot.",[318,319,321],"h2",{"id":320},"parameters","Parameters",[323,324,325,341],"table",{},[326,327,328],"thead",{},[329,330,331,335,338],"tr",{},[332,333,334],"th",{},"Name",[332,336,337],{},"Type",[332,339,340],{},"Notes",[342,343,344],"tbody",{},[329,345,346,352,355],{},[347,348,349],"td",{},[8,350,351],{},"slots",[347,353,354],{},"`{",[347,356],{},[160,358,363],{"className":359,"code":361,"language":362},[360],"language-text","cellsX: PropRef\ncellsY: PropRef\nmortar: PropRef\nsoftness: PropRef\nvariation: PropRef\nrotation: PropRef\noffset: PropRef\nspeedVariance: PropRef\nseed: PropRef\n","text",[8,364,361],{"__ignoreMap":165},[156,366,367],{},"}` |  |",[318,369,371],{"id":370},"example","Example",[160,373,375],{"className":162,"code":374,"language":164,"meta":165,"style":165},"const field = brickCourses({cellsX: p('cellsX'), cellsY: p('cellsY'), mortar: p('mortar'), softness: p('softness'), variation: p('variation'), rotation: p('rotation'), offset: p('offset'), speedVariance: p('speedVariance'), seed: p('seed')})\n\u002F\u002F paint: strokeOver({fill: p('colorMortar'), stroke: vary(p('colorBrick'), field.shade), mask: field.bricks, space: p('colorSpace')})\n",[8,376,377,488],{"__ignoreMap":165},[169,378,379,383,387,390,393,396,398,401,405,408,410,412,415,418,420,422,425,428,430,432,435,438,440,442,445,448,450,452,455,458,460,462,465,468,470,472,475,478,480,482,485],{"class":171,"line":172},[169,380,382],{"class":381},"snl16","const",[169,384,386],{"class":385},"sDLfK"," field",[169,388,389],{"class":381}," =",[169,391,392],{"class":175}," brickCourses",[169,394,395],{"class":178},"({cellsX: ",[169,397,156],{"class":175},[169,399,400],{"class":178},"(",[169,402,404],{"class":403},"sU2Wk","'cellsX'",[169,406,407],{"class":178},"), cellsY: ",[169,409,156],{"class":175},[169,411,400],{"class":178},[169,413,414],{"class":403},"'cellsY'",[169,416,417],{"class":178},"), mortar: ",[169,419,156],{"class":175},[169,421,400],{"class":178},[169,423,424],{"class":403},"'mortar'",[169,426,427],{"class":178},"), softness: ",[169,429,156],{"class":175},[169,431,400],{"class":178},[169,433,434],{"class":403},"'softness'",[169,436,437],{"class":178},"), variation: ",[169,439,156],{"class":175},[169,441,400],{"class":178},[169,443,444],{"class":403},"'variation'",[169,446,447],{"class":178},"), rotation: ",[169,449,156],{"class":175},[169,451,400],{"class":178},[169,453,454],{"class":403},"'rotation'",[169,456,457],{"class":178},"), offset: ",[169,459,156],{"class":175},[169,461,400],{"class":178},[169,463,464],{"class":403},"'offset'",[169,466,467],{"class":178},"), speedVariance: ",[169,469,156],{"class":175},[169,471,400],{"class":178},[169,473,474],{"class":403},"'speedVariance'",[169,476,477],{"class":178},"), seed: ",[169,479,156],{"class":175},[169,481,400],{"class":178},[169,483,484],{"class":403},"'seed'",[169,486,487],{"class":178},")})\n",[169,489,490],{"class":171,"line":182},[169,491,493],{"class":492},"sAwPA","\u002F\u002F paint: strokeOver({fill: p('colorMortar'), stroke: vary(p('colorBrick'), field.shade), mask: field.bricks, space: p('colorSpace')})\n",[318,495,497],{"id":496},"see-also","See also",[499,500,501,516,524],"ul",{},[502,503,504,511,512,515],"li",{},[505,506,508],"a",{"href":507},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fgridlines",[8,509,510],{},"gridLines"," — Square grid lines drawn in a ",[8,513,514],{},"cellFrame",", plus a per-cell shade for the fill.",[502,517,518,523],{},[505,519,521],{"href":520},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fcellframe",[8,522,514],{}," — The shared coordinate system of a tiled pattern: how many cells fit down the canvas height and how far the whole lattice is rotated.",[502,525,526,531],{},[505,527,529],{"href":528},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fvary",[8,530,268],{}," — A color lightened or darkened per cell by a shade factor, alpha untouched.",[318,533,535],{"id":534},"used-by","Used by",[156,537,538],{},[505,539,541],{"href":540},"\u002Fdocs\u002Fcomponents\u002Fbrickpattern","BrickPattern",[543,544,545],"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}html pre.shiki code .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}",{"title":165,"searchDepth":182,"depth":182,"links":547},[548,549,550,551],{"id":320,"depth":182,"text":321},{"id":370,"depth":182,"text":371},{"id":496,"depth":182,"text":497},{"id":534,"depth":182,"text":535},"Patterns & tiling",false,"md","paint","Painting","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fbrickcourses",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fpatterns.ts#L694","docs\u002Fprimitives\u002F8.patterns\u002F13.brickcourses","Oyco2d-EVCYsSj4wey1E6NH2PgHT0BQQvNq8m3dcYDI"]