[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhostfieldtexture":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":423,"categorySlug":424,"categoryTitle":425,"curated":426,"description":158,"editUrl":9,"extension":427,"group":428,"groupTitle":429,"kind":430,"meta":431,"navigation":432,"path":433,"seo":434,"sourceUrl":435,"stem":436,"wordCount":9,"__hash__":437},"primitives\u002Fdocs\u002Fprimitives\u002F37.sim-grids\u002F16.hostfieldtexture.md","hostFieldTexture",{"type":149,"value":150,"toc":417},"minimark",[151,155,159,230,245,260,266,271,322,326,361,377,381,398,402,413],[152,153,147],"h1",{"id":154},"hostfieldtexture",[156,157,158],"p",{},"The texture a JavaScript-stepped grid is read through.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","hostFieldTexture(\n  params: GpuFragmentParams,\n  opts: {size: number; label: string},\n): {texData: Uint16Array; texture: ReturnType\u003CGpuFragmentParams['registerMediaTexture']>; upload(): void}\n","ts","",[8,167,168,180,186,192],{"__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","(\n",[169,181,183],{"class":171,"line":182},2,[169,184,185],{"class":178},"  params: GpuFragmentParams,\n",[169,187,189],{"class":171,"line":188},3,[169,190,191],{"class":178},"  opts: {size: number; label: string},\n",[169,193,195,198,202,205,209,212,215,218,221,224,227],{"class":171,"line":194},4,[169,196,197],{"class":178},"): {texData: Uint16Array; texture: ReturnType",[169,199,201],{"class":200},"snl16","\u003C",[169,203,204],{"class":178},"GpuFragmentParams[",[169,206,208],{"class":207},"sU2Wk","'registerMediaTexture'",[169,210,211],{"class":178},"]",[169,213,214],{"class":200},">",[169,216,217],{"class":178},"; ",[169,219,220],{"class":175},"upload",[169,222,223],{"class":178},"(): ",[169,225,226],{"class":200},"void",[169,228,229],{"class":178},"}\n",[156,231,232,233,236,237,240,241,244],{},"Import ",[8,234,235],{},"sim"," from ",[8,238,239],{},"shaders\u002Fstd"," and use ",[8,242,243],{},"sim.grids.hostFieldTexture",".",[156,246,247,248,251,252,255,256,259],{},"Pack the cells into ",[8,249,250],{},"texData"," (four half-floats per cell, row by row), call ",[8,253,254],{},"upload()",", and sample ",[8,257,258],{},"texture"," in the fragment.",[156,261,262,265],{},[8,263,264],{},"size"," is the grid's side in cells. The texture filters smoothly, so a coarse grid reads as a continuous field.",[267,268,270],"h2",{"id":269},"parameters","Parameters",[272,273,274,290],"table",{},[275,276,277],"thead",{},[278,279,280,284,287],"tr",{},[281,282,283],"th",{},"Name",[281,285,286],{},"Type",[281,288,289],{},"Notes",[291,292,293,308],"tbody",{},[278,294,295,301,306],{},[296,297,298],"td",{},[8,299,300],{},"params",[296,302,303],{},[8,304,305],{},"GpuFragmentParams",[296,307],{},[278,309,310,315,320],{},[296,311,312],{},[8,313,314],{},"opts",[296,316,317],{},[8,318,319],{},"{size: number; label: string}",[296,321],{},[267,323,325],{"id":324},"example","Example",[160,327,329],{"className":162,"code":328,"language":164,"meta":165,"style":165},"const field = hostFieldTexture(params, {size: 32, label: 'flow'})\n",[8,330,331],{"__ignoreMap":165},[169,332,333,336,340,343,346,349,352,355,358],{"class":171,"line":172},[169,334,335],{"class":200},"const",[169,337,339],{"class":338},"sDLfK"," field",[169,341,342],{"class":200}," =",[169,344,345],{"class":175}," hostFieldTexture",[169,347,348],{"class":178},"(params, {size: ",[169,350,351],{"class":338},"32",[169,353,354],{"class":178},", label: ",[169,356,357],{"class":207},"'flow'",[169,359,360],{"class":178},"})\n",[362,363,364],"blockquote",{},[156,365,366,370,371,374,375,244],{},[367,368,369],"strong",{},"Tip."," Values go in as half-floats: convert each number with ",[8,372,373],{},"toHalfFloat"," before writing it into ",[8,376,250],{},[267,378,380],{"id":379},"see-also","See also",[382,383,384],"ul",{},[385,386,387,394,395,244],"li",{},[388,389,391],"a",{"href":390},"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhostgridprogram",[8,392,393],{},"hostGridProgram"," — A frame program for a small grid stepped in plain JavaScript: the steps run in order every frame until one returns ",[8,396,397],{},"'skip'",[267,399,401],{"id":400},"used-by","Used by",[156,403,404,408,409],{},[388,405,407],{"href":406},"\u002Fdocs\u002Fcomponents\u002Fchromaflow","ChromaFlow",", ",[388,410,412],{"href":411},"\u002Fdocs\u002Fcomponents\u002Fpixelthrow","PixelThrow",[414,415,416],"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 .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);}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}",{"title":165,"searchDepth":182,"depth":182,"links":418},[419,420,421,422],{"id":269,"depth":182,"text":270},{"id":324,"depth":182,"text":325},{"id":379,"depth":182,"text":380},{"id":400,"depth":182,"text":401},"sim.grids","sim-grids","Grid programs",false,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhostfieldtexture",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fgrids.ts#L491","docs\u002Fprimitives\u002F37.sim-grids\u002F16.hostfieldtexture","g39gF3pWCUGg67ES9LVvst3I4ns1jH-At4uWucwM_c4"]