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