[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fmedia\u002Fvideomedia":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":321,"categorySlug":321,"categoryTitle":518,"curated":519,"description":158,"editUrl":9,"extension":520,"group":521,"groupTitle":522,"kind":523,"meta":524,"navigation":525,"path":526,"seo":527,"sourceUrl":528,"stem":529,"wordCount":9,"__hash__":530},"primitives\u002Fdocs\u002Fprimitives\u002F11.media\u002F2.videomedia.md","videoMedia",{"type":149,"value":150,"toc":512},"minimark",[151,155,159,316,331,358,363,398,406,409,413,471,475,498,502,508],[152,153,147],"h1",{"id":154},"videomedia",[156,157,158],"p",{},"A video from a URL prop, playing in the layer.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","videoMedia(opts: MediaFitSlots & {\n    \u002F** The URL prop. *\u002F\n    src: PropRef\n    \u002F** The loop prop, synced to the video each frame. *\u002F\n    loop: PropRef\n    \u002F** Milliseconds to wait for the video's metadata before giving up. *\u002F\n    metadataTimeoutMs: number\n    onError?: (\n  error: unknown,\n  info: {url: string | null; stage: 'acquire' | 'autoplay'},\n) => void\n}): MediaSurfaceHalf\n","ts","",[8,167,168,187,194,200,206,212,218,224,236,253,298,310],{"__ignoreMap":165},[169,170,173,176,180,184],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(opts: MediaFitSlots ",[169,181,183],{"class":182},"snl16","&",[169,185,186],{"class":178}," {\n",[169,188,190],{"class":171,"line":189},2,[169,191,193],{"class":192},"sAwPA","    \u002F** The URL prop. *\u002F\n",[169,195,197],{"class":171,"line":196},3,[169,198,199],{"class":178},"    src: PropRef\n",[169,201,203],{"class":171,"line":202},4,[169,204,205],{"class":192},"    \u002F** The loop prop, synced to the video each frame. *\u002F\n",[169,207,209],{"class":171,"line":208},5,[169,210,211],{"class":178},"    loop: PropRef\n",[169,213,215],{"class":171,"line":214},6,[169,216,217],{"class":192},"    \u002F** Milliseconds to wait for the video's metadata before giving up. *\u002F\n",[169,219,221],{"class":171,"line":220},7,[169,222,223],{"class":178},"    metadataTimeoutMs: number\n",[169,225,227,230,233],{"class":171,"line":226},8,[169,228,229],{"class":178},"    onError",[169,231,232],{"class":182},"?:",[169,234,235],{"class":178}," (\n",[169,237,239,243,246,250],{"class":171,"line":238},9,[169,240,242],{"class":241},"s9osk","  error",[169,244,245],{"class":182},":",[169,247,249],{"class":248},"sDLfK"," unknown",[169,251,252],{"class":178},",\n",[169,254,256,259,261,264,267,269,272,275,278,281,284,286,290,292,295],{"class":171,"line":255},10,[169,257,258],{"class":241},"  info",[169,260,245],{"class":182},[169,262,263],{"class":178}," {",[169,265,266],{"class":241},"url",[169,268,245],{"class":182},[169,270,271],{"class":248}," string",[169,273,274],{"class":182}," |",[169,276,277],{"class":248}," null",[169,279,280],{"class":178},"; ",[169,282,283],{"class":241},"stage",[169,285,245],{"class":182},[169,287,289],{"class":288},"sU2Wk"," 'acquire'",[169,291,274],{"class":182},[169,293,294],{"class":288}," 'autoplay'",[169,296,297],{"class":178},"},\n",[169,299,301,304,307],{"class":171,"line":300},11,[169,302,303],{"class":178},") ",[169,305,306],{"class":182},"=>",[169,308,309],{"class":182}," void\n",[169,311,313],{"class":171,"line":312},12,[169,314,315],{"class":178},"}): MediaSurfaceHalf\n",[156,317,318,319,322,323,326,327,330],{},"Import ",[8,320,321],{},"media"," from ",[8,324,325],{},"shaders\u002Fstd"," and use ",[8,328,329],{},"media.videoMedia",".",[156,332,333,334,337,338,341,342,345,346,349,350,353,354,357],{},"The video plays muted and inline. ",[8,335,336],{},"loop"," is a boolean prop. ",[8,339,340],{},"metadataTimeoutMs"," is how long to wait for the video's metadata before reporting a failure. Set ",[8,343,344],{},"naturalSizeKey: {fromProp: 'url'}"," on the definition. ",[8,347,348],{},"onError"," tells you whether loading (",[8,351,352],{},"'acquire'",") or playback (",[8,355,356],{},"'autoplay'",") failed.",[359,360,362],"h2",{"id":361},"parameters","Parameters",[364,365,366,382],"table",{},[367,368,369],"thead",{},[370,371,372,376,379],"tr",{},[373,374,375],"th",{},"Name",[373,377,378],{},"Type",[373,380,381],{},"Notes",[383,384,385],"tbody",{},[370,386,387,393,396],{},[388,389,390],"td",{},[8,391,392],{},"opts",[388,394,395],{},"`MediaFitSlots & {",[388,397],{},[160,399,404],{"className":400,"code":402,"language":403},[401],"language-text","\u002F** The URL prop. *\u002F\nsrc: PropRef\n\u002F** The loop prop, synced to the video each frame. *\u002F\nloop: PropRef\n\u002F** Milliseconds to wait for the video's metadata before giving up. *\u002F\nmetadataTimeoutMs: number\nonError?: (error: unknown, info: {url: string \\| null; stage: 'acquire' \\| 'autoplay'}) => void\n","text",[8,405,402],{"__ignoreMap":165},[156,407,408],{},"}` |  |",[359,410,412],{"id":411},"example","Example",[160,414,416],{"className":162,"code":415,"language":164,"meta":165,"style":165},"...videoMedia({src: p('url'), fit: p('objectFit'), loop: p('loop'), decode: 'srgb-linear-alpha-cut', metadataTimeoutMs: 10000})\n",[8,417,418],{"__ignoreMap":165},[169,419,420,423,425,428,430,433,436,439,441,443,446,449,451,453,456,459,462,465,468],{"class":171,"line":172},[169,421,422],{"class":182},"...",[169,424,147],{"class":175},[169,426,427],{"class":178},"({src: ",[169,429,156],{"class":175},[169,431,432],{"class":178},"(",[169,434,435],{"class":288},"'url'",[169,437,438],{"class":178},"), fit: ",[169,440,156],{"class":175},[169,442,432],{"class":178},[169,444,445],{"class":288},"'objectFit'",[169,447,448],{"class":178},"), loop: ",[169,450,156],{"class":175},[169,452,432],{"class":178},[169,454,455],{"class":288},"'loop'",[169,457,458],{"class":178},"), decode: ",[169,460,461],{"class":288},"'srgb-linear-alpha-cut'",[169,463,464],{"class":178},", metadataTimeoutMs: ",[169,466,467],{"class":248},"10000",[169,469,470],{"class":178},"})\n",[359,472,474],{"id":473},"see-also","See also",[476,477,478,489],"ul",{},[479,480,481,488],"li",{},[482,483,485],"a",{"href":484},"\u002Fdocs\u002Fprimitives\u002Fmedia\u002Fimagemedia",[8,486,487],{},"imageMedia"," — An image from a URL prop, fitted into the layer.",[479,490,491,497],{},[482,492,494],{"href":493},"\u002Fdocs\u002Fprimitives\u002Fmedia\u002Fwebcammedia",[8,495,496],{},"webcamMedia"," — The user's camera, live in the layer.",[359,499,501],{"id":500},"used-by","Used by",[156,503,504],{},[482,505,507],{"href":506},"\u002Fdocs\u002Fcomponents\u002Fvideotexture","VideoTexture",[509,510,511],"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 .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}html pre.shiki code .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}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 .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);}",{"title":165,"searchDepth":189,"depth":189,"links":513},[514,515,516,517],{"id":361,"depth":189,"text":362},{"id":411,"depth":189,"text":412},{"id":473,"depth":189,"text":474},{"id":500,"depth":189,"text":501},"Media",false,"md","paint","Painting","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fmedia\u002Fvideomedia",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fmedia.ts#L134","docs\u002Fprimitives\u002F11.media\u002F2.videomedia","xoQxS_CevCoemtJapuihzyhClH8ouz2VBUQeLjOXBlw"]