[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Feffects-overlay\u002Fdetectionoverlay":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":581,"categorySlug":582,"categoryTitle":583,"curated":584,"description":158,"editUrl":9,"extension":585,"group":210,"groupTitle":586,"kind":587,"meta":588,"navigation":589,"path":590,"seo":591,"sourceUrl":592,"stem":593,"wordCount":9,"__hash__":594},"primitives\u002Fdocs\u002Fprimitives\u002F34.effects-overlay\u002F1.detectionoverlay.md","detectionOverlay",{"type":149,"value":150,"toc":574},"minimark",[151,155,159,205,220,250,255,291,295,521,542,546,560,564,570],[152,153,147],"h1",{"id":154},"detectionoverlay",[156,157,158],"p",{},"Draw computer-vision style detection boxes over whatever the child contains.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","detectionOverlay(slots: DetectionOverlaySlots): (params: GpuFragmentParams) => ExprT\n","ts","",[8,167,168],{"__ignoreMap":165},[169,170,173,176,180,184,187,191,193,196,199,202],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(slots: DetectionOverlaySlots)",[169,181,183],{"class":182},"snl16",":",[169,185,186],{"class":178}," (",[169,188,190],{"class":189},"s9osk","params",[169,192,183],{"class":182},[169,194,195],{"class":175}," GpuFragmentParams",[169,197,198],{"class":178},") ",[169,200,201],{"class":182},"=>",[169,203,204],{"class":178}," ExprT\n",[156,206,207,208,211,212,215,216,219],{},"Import ",[8,209,210],{},"effects"," from ",[8,213,214],{},"shaders\u002Fstd"," and use ",[8,217,218],{},"effects.overlay.detectionOverlay",".",[156,221,222,223,226,227,230,231,230,234,237,238,241,242,245,246,249],{},"A whole fragment for a ",[8,224,225],{},"gpu:"," definition. The canvas is cut into cells (",[8,228,229],{},"layout",", ",[8,232,233],{},"cellSize",[8,235,236],{},"maxDepth","); each cell that holds content of the chosen kind (",[8,239,240],{},"detectionMode"," above ",[8,243,244],{},"threshold",") gets a box drawn tight around that content, with an optional label showing its size or coverage. The child shows through underneath. Every slot is a prop ref; the field list on ",[8,247,248],{},"DetectionOverlaySlots"," gives units and options.",[251,252,254],"h2",{"id":253},"parameters","Parameters",[256,257,258,274],"table",{},[259,260,261],"thead",{},[262,263,264,268,271],"tr",{},[265,266,267],"th",{},"Name",[265,269,270],{},"Type",[265,272,273],{},"Notes",[275,276,277],"tbody",{},[262,278,279,285,289],{},[280,281,282],"td",{},[8,283,284],{},"slots",[280,286,287],{},[8,288,248],{},[280,290],{},[251,292,294],{"id":293},"example","Example",[160,296,298],{"className":162,"code":297,"language":164,"meta":165,"style":165},"gpu: {fragment: detectionOverlay({detectionMode: p('detectionMode'), threshold: p('threshold'), layout: p('layout'), cellSize: p('cellSize'), maxDepth: p('maxDepth'), boxStyle: p('boxStyle'), lineWidth: p('lineWidth'), cornerRadius: p('cornerRadius'), strokeColor: p('strokeColor'), fillColor: p('fillColor'), labelColor: p('labelColor'), labelBackgroundColor: p('labelBackgroundColor'), labelMode: p('labelMode'), labelPosition: p('labelPosition'), labelInset: p('labelInset'), labelRadius: p('labelRadius'), fontFamily: p('fontFamily'), fontWeight: p('fontWeight'), fontSize: p('fontSize'), letterSpacing: p('letterSpacing')})}\n",[8,299,300],{"__ignoreMap":165},[169,301,302,305,308,311,314,316,319,321,324,328,331,333,335,338,341,343,345,348,351,353,355,358,361,363,365,368,371,373,375,378,381,383,385,388,391,393,395,398,401,403,405,408,411,413,415,418,421,423,425,428,431,433,435,438,441,443,445,448,451,453,455,458,461,463,465,468,471,473,475,478,481,483,485,488,491,493,495,498,501,503,505,508,511,513,515,518],{"class":171,"line":172},[169,303,304],{"class":175},"gpu",[169,306,307],{"class":178},": {",[169,309,310],{"class":175},"fragment",[169,312,313],{"class":178},": ",[169,315,147],{"class":175},[169,317,318],{"class":178},"({detectionMode: ",[169,320,156],{"class":175},[169,322,323],{"class":178},"(",[169,325,327],{"class":326},"sU2Wk","'detectionMode'",[169,329,330],{"class":178},"), threshold: ",[169,332,156],{"class":175},[169,334,323],{"class":178},[169,336,337],{"class":326},"'threshold'",[169,339,340],{"class":178},"), layout: ",[169,342,156],{"class":175},[169,344,323],{"class":178},[169,346,347],{"class":326},"'layout'",[169,349,350],{"class":178},"), cellSize: ",[169,352,156],{"class":175},[169,354,323],{"class":178},[169,356,357],{"class":326},"'cellSize'",[169,359,360],{"class":178},"), maxDepth: ",[169,362,156],{"class":175},[169,364,323],{"class":178},[169,366,367],{"class":326},"'maxDepth'",[169,369,370],{"class":178},"), boxStyle: ",[169,372,156],{"class":175},[169,374,323],{"class":178},[169,376,377],{"class":326},"'boxStyle'",[169,379,380],{"class":178},"), lineWidth: ",[169,382,156],{"class":175},[169,384,323],{"class":178},[169,386,387],{"class":326},"'lineWidth'",[169,389,390],{"class":178},"), cornerRadius: ",[169,392,156],{"class":175},[169,394,323],{"class":178},[169,396,397],{"class":326},"'cornerRadius'",[169,399,400],{"class":178},"), strokeColor: ",[169,402,156],{"class":175},[169,404,323],{"class":178},[169,406,407],{"class":326},"'strokeColor'",[169,409,410],{"class":178},"), fillColor: ",[169,412,156],{"class":175},[169,414,323],{"class":178},[169,416,417],{"class":326},"'fillColor'",[169,419,420],{"class":178},"), labelColor: ",[169,422,156],{"class":175},[169,424,323],{"class":178},[169,426,427],{"class":326},"'labelColor'",[169,429,430],{"class":178},"), labelBackgroundColor: ",[169,432,156],{"class":175},[169,434,323],{"class":178},[169,436,437],{"class":326},"'labelBackgroundColor'",[169,439,440],{"class":178},"), labelMode: ",[169,442,156],{"class":175},[169,444,323],{"class":178},[169,446,447],{"class":326},"'labelMode'",[169,449,450],{"class":178},"), labelPosition: ",[169,452,156],{"class":175},[169,454,323],{"class":178},[169,456,457],{"class":326},"'labelPosition'",[169,459,460],{"class":178},"), labelInset: ",[169,462,156],{"class":175},[169,464,323],{"class":178},[169,466,467],{"class":326},"'labelInset'",[169,469,470],{"class":178},"), labelRadius: ",[169,472,156],{"class":175},[169,474,323],{"class":178},[169,476,477],{"class":326},"'labelRadius'",[169,479,480],{"class":178},"), fontFamily: ",[169,482,156],{"class":175},[169,484,323],{"class":178},[169,486,487],{"class":326},"'fontFamily'",[169,489,490],{"class":178},"), fontWeight: ",[169,492,156],{"class":175},[169,494,323],{"class":178},[169,496,497],{"class":326},"'fontWeight'",[169,499,500],{"class":178},"), fontSize: ",[169,502,156],{"class":175},[169,504,323],{"class":178},[169,506,507],{"class":326},"'fontSize'",[169,509,510],{"class":178},"), letterSpacing: ",[169,512,156],{"class":175},[169,514,323],{"class":178},[169,516,517],{"class":326},"'letterSpacing'",[169,519,520],{"class":178},")})}\n",[522,523,524],"blockquote",{},[156,525,526,530,531,533,534,537,538,541],{},[527,528,529],"strong",{},"Tip."," Cost grows with ",[8,532,236],{},"; 2 is plenty for most layouts. Set ",[8,535,536],{},"labelMode"," to ",[8,539,540],{},"'none'"," to skip the text pass entirely.",[251,543,545],{"id":544},"see-also","See also",[547,548,549],"ul",{},[550,551,552,559],"li",{},[553,554,556],"a",{"href":555},"\u002Fdocs\u002Fprimitives\u002Feffects-overlay\u002Fmotiontrackerhud",[8,557,558],{},"motionTrackerHud"," — Draw motion-tracker gizmos that chase content across the child, leaving keyframe trails.",[251,561,563],{"id":562},"used-by","Used by",[156,565,566],{},[553,567,569],{"href":568},"\u002Fdocs\u002Fcomponents\u002Fobjecttracker","ObjectTracker",[571,572,573],"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 pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}html pre.shiki code .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}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":575,"depth":575,"links":576},2,[577,578,579,580],{"id":253,"depth":575,"text":254},{"id":293,"depth":575,"text":294},{"id":544,"depth":575,"text":545},{"id":562,"depth":575,"text":563},"effects.overlay","effects-overlay","Overlays",false,"md","Filters & effects","function",{},true,"\u002Fdocs\u002Fprimitives\u002Feffects-overlay\u002Fdetectionoverlay",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Feffects\u002Foverlay.ts#L91","docs\u002Fprimitives\u002F34.effects-overlay\u002F1.detectionoverlay","aYgaG9hI2mAMtzyoVJZpvJaYLNAnfuYR_7ZQnNqpmeI"]