[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Feffects-stylize\u002Fchalksketch":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":471,"categorySlug":472,"categoryTitle":473,"curated":474,"description":158,"editUrl":9,"extension":475,"group":233,"groupTitle":476,"kind":477,"meta":478,"navigation":479,"path":480,"seo":481,"sourceUrl":482,"stem":483,"wordCount":9,"__hash__":484},"primitives\u002Fdocs\u002Fprimitives\u002F28.effects-stylize\u002F5.chalksketch.md","chalkSketch",{"type":149,"value":150,"toc":465},"minimark",[151,155,159,228,243,274,279,314,322,325,329,425,429,451,455,461],[152,153,147],"h1",{"id":154},"chalksketch",[156,157,158],"p",{},"The chalk-drawing look: edges become chalk strokes and dark areas fill with cross-hatching.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","chalkSketch(slots: {\n    edges: SobelRing\n    sensitivity: PropRef\n    hatchScale: PropRef\n    shading: PropRef\n    grain: PropRef\n    board: PropRef\n    chalk: PropRef\n}): GatherEffect\n","ts","",[8,167,168,180,186,192,198,204,210,216,222],{"__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},"    edges: SobelRing\n",[169,187,189],{"class":171,"line":188},3,[169,190,191],{"class":178},"    sensitivity: PropRef\n",[169,193,195],{"class":171,"line":194},4,[169,196,197],{"class":178},"    hatchScale: PropRef\n",[169,199,201],{"class":171,"line":200},5,[169,202,203],{"class":178},"    shading: PropRef\n",[169,205,207],{"class":171,"line":206},6,[169,208,209],{"class":178},"    grain: PropRef\n",[169,211,213],{"class":171,"line":212},7,[169,214,215],{"class":178},"    board: PropRef\n",[169,217,219],{"class":171,"line":218},8,[169,220,221],{"class":178},"    chalk: PropRef\n",[169,223,225],{"class":171,"line":224},9,[169,226,227],{"class":178},"}): GatherEffect\n",[156,229,230,231,234,235,238,239,242],{},"Import ",[8,232,233],{},"effects"," from ",[8,236,237],{},"shaders\u002Fstd"," and use ",[8,240,241],{},"effects.stylize.chalkSketch",".",[156,244,245,246,249,250,253,254,257,258,261,262,265,266,269,270,273],{},"Closes the recipe and returns the effect for ",[8,247,248],{},"effect:",". ",[8,251,252],{},"sensitivity"," (0 to 1) sets how faint an edge still draws. ",[8,255,256],{},"hatchScale"," is the hatch line spacing in device pixels. ",[8,259,260],{},"shading"," (0 to 1) is how much cross-hatch fills the dark regions and ",[8,263,264],{},"grain"," (0 to 1) how dusty the strokes are. ",[8,267,268],{},"board"," and ",[8,271,272],{},"chalk"," are colors. Alpha follows the layer inside.",[275,276,278],"h2",{"id":277},"parameters","Parameters",[280,281,282,298],"table",{},[283,284,285],"thead",{},[286,287,288,292,295],"tr",{},[289,290,291],"th",{},"Name",[289,293,294],{},"Type",[289,296,297],{},"Notes",[299,300,301],"tbody",{},[286,302,303,309,312],{},[304,305,306],"td",{},[8,307,308],{},"slots",[304,310,311],{},"`{",[304,313],{},[160,315,320],{"className":316,"code":318,"language":319},[317],"language-text","edges: SobelRing\nsensitivity: PropRef\nhatchScale: PropRef\nshading: PropRef\ngrain: PropRef\nboard: PropRef\nchalk: PropRef\n","text",[8,321,318],{"__ignoreMap":165},[156,323,324],{},"}` |  |",[275,326,328],{"id":327},"example","Example",[160,330,332],{"className":162,"code":331,"language":164,"meta":165,"style":165},"effect: chalkSketch({edges: sobelTaps({spacing: p('edgeThickness')}), sensitivity: p('edgeSensitivity'), hatchScale: p('hatchScale'), shading: p('shading'), grain: p('grain'), board: p('boardColor'), chalk: p('chalkColor')})\n",[8,333,334],{"__ignoreMap":165},[169,335,336,339,342,344,347,350,353,355,358,362,365,367,369,372,375,377,379,382,385,387,389,392,395,397,399,402,405,407,409,412,415,417,419,422],{"class":171,"line":172},[169,337,338],{"class":175},"effect",[169,340,341],{"class":178},": ",[169,343,147],{"class":175},[169,345,346],{"class":178},"({edges: ",[169,348,349],{"class":175},"sobelTaps",[169,351,352],{"class":178},"({spacing: ",[169,354,156],{"class":175},[169,356,357],{"class":178},"(",[169,359,361],{"class":360},"sU2Wk","'edgeThickness'",[169,363,364],{"class":178},")}), sensitivity: ",[169,366,156],{"class":175},[169,368,357],{"class":178},[169,370,371],{"class":360},"'edgeSensitivity'",[169,373,374],{"class":178},"), hatchScale: ",[169,376,156],{"class":175},[169,378,357],{"class":178},[169,380,381],{"class":360},"'hatchScale'",[169,383,384],{"class":178},"), shading: ",[169,386,156],{"class":175},[169,388,357],{"class":178},[169,390,391],{"class":360},"'shading'",[169,393,394],{"class":178},"), grain: ",[169,396,156],{"class":175},[169,398,357],{"class":178},[169,400,401],{"class":360},"'grain'",[169,403,404],{"class":178},"), board: ",[169,406,156],{"class":175},[169,408,357],{"class":178},[169,410,411],{"class":360},"'boardColor'",[169,413,414],{"class":178},"), chalk: ",[169,416,156],{"class":175},[169,418,357],{"class":178},[169,420,421],{"class":360},"'chalkColor'",[169,423,424],{"class":178},")})\n",[275,426,428],{"id":427},"see-also","See also",[430,431,432,442],"ul",{},[433,434,435,441],"li",{},[436,437,439],"a",{"href":438},"\u002Fdocs\u002Fprimitives\u002Feffects-stylize\u002Fsobeltaps",[8,440,349],{}," — Eight brightness samples in a ring around each pixel, for finding edges.",[433,443,444,450],{},[436,445,447],{"href":446},"\u002Fdocs\u002Fprimitives\u002Feffects-stylize\u002Flinework",[8,448,449],{},"linework"," — The engraving look: the layer inside redrawn as ink lines that swell where it is dark.",[275,452,454],{"id":453},"used-by","Used by",[156,456,457],{},[436,458,460],{"href":459},"\u002Fdocs\u002Fcomponents\u002Fchalkboard","Chalkboard",[462,463,464],"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 .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":165,"searchDepth":182,"depth":182,"links":466},[467,468,469,470],{"id":277,"depth":182,"text":278},{"id":327,"depth":182,"text":328},{"id":427,"depth":182,"text":428},{"id":453,"depth":182,"text":454},"effects.stylize","effects-stylize","Stylize",false,"md","Filters & effects","function",{},true,"\u002Fdocs\u002Fprimitives\u002Feffects-stylize\u002Fchalksketch",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Feffects\u002Fstylize.ts#L260","docs\u002Fprimitives\u002F28.effects-stylize\u002F5.chalksketch","RR4svIis-NyHe2c3ERYQ2b-MI_CQPvwMjz7x5D_wdUA"]