[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fvoxels\u002Fvoxelsurface":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":189,"categorySlug":189,"categoryTitle":497,"curated":509,"description":510,"editUrl":9,"extension":511,"group":512,"groupTitle":513,"kind":514,"meta":515,"navigation":516,"path":517,"seo":518,"sourceUrl":519,"stem":520,"wordCount":9,"__hash__":521},"primitives\u002Fdocs\u002Fprimitives\u002F17.voxels\u002F1.voxelsurface.md","voxelSurface",{"type":149,"value":150,"toc":502},"minimark",[151,155,163,184,198,240,245,282,286,443,461,465,488,492,498],[152,153,147],"h1",{"id":154},"voxelsurface",[156,157,158,159,162],"p",{},"Rebuild the shape from blocks and shade each block with your ",[8,160,161],{},"surface",".",[164,165,170],"pre",{"className":166,"code":167,"language":168,"meta":169,"style":169},"language-ts shiki shiki-themes github-dark","voxelSurface(spec: VoxelSurfaceSpec): ShapedSurfaceEffect\n","ts","",[8,171,172],{"__ignoreMap":169},[173,174,177,180],"span",{"class":175,"line":176},"line",1,[173,178,147],{"class":179},"svObZ",[173,181,183],{"class":182},"s95oV","(spec: VoxelSurfaceSpec): ShapedSurfaceEffect\n",[156,185,186,187,190,191,194,195,162],{},"Import ",[8,188,189],{},"voxels"," from ",[8,192,193],{},"shaders\u002Fstd"," and use ",[8,196,197],{},"voxels.voxelSurface",[156,199,200,201,204,205,208,209,208,212,208,215,208,218,208,221,224,225,228,229,231,232,235,236,239],{},"Returns ",[8,202,203],{},"{extraFields, compute, gpu}"," to spread into a shape-effect definition. Your props must include the standard shape props (",[8,206,207],{},"center",", ",[8,210,211],{},"scale",[8,213,214],{},"rotation",[8,216,217],{},"shape",[8,219,220],{},"shapeSdfUrl",[8,222,223],{},"shapeType","), a ",[8,226,227],{},"shadows"," amount (0–1) and everything the spec names. Your ",[8,230,161],{}," gets a ",[8,233,234],{},"VoxelFrame"," per block and returns ",[8,237,238],{},"vec4(rgb, vox.coverage)",". Geometry props re-build the model when they change. Color and light props never do.",[241,242,244],"h2",{"id":243},"parameters","Parameters",[246,247,248,264],"table",{},[249,250,251],"thead",{},[252,253,254,258,261],"tr",{},[255,256,257],"th",{},"Name",[255,259,260],{},"Type",[255,262,263],{},"Notes",[265,266,267],"tbody",{},[252,268,269,275,280],{},[270,271,272],"td",{},[8,273,274],{},"spec",[270,276,277],{},[8,278,279],{},"VoxelSurfaceSpec",[270,281],{},[241,283,285],{"id":284},"example","Example",[164,287,289],{"className":166,"code":288,"language":168,"meta":169,"style":169},"...voxelSurface({style: p('voxelShape'), gridSpace: p('gridSpace'), voxelSize: p('voxelSize'), fill: p('fill'), voxelScale: p('voxelScale'), bevel: p('bevel'), shadowSoftness: p('shadowSoftness'), lightAngle: p('lightAngle'), lightElevation: p('lightElevation'), depth: p('depth'), surface: (vox, frame, params) => math.vec4(shade(vox), vox.coverage)})\n",[8,290,291],{"__ignoreMap":169},[173,292,293,297,299,302,304,307,311,314,316,318,321,324,326,328,331,334,336,338,341,344,346,348,351,354,356,358,361,364,366,368,371,374,376,378,381,384,386,388,391,394,396,398,401,404,406,409,413,415,418,420,423,426,429,432,435,437,440],{"class":175,"line":176},[173,294,296],{"class":295},"snl16","...",[173,298,147],{"class":179},[173,300,301],{"class":182},"({style: ",[173,303,156],{"class":179},[173,305,306],{"class":182},"(",[173,308,310],{"class":309},"sU2Wk","'voxelShape'",[173,312,313],{"class":182},"), gridSpace: ",[173,315,156],{"class":179},[173,317,306],{"class":182},[173,319,320],{"class":309},"'gridSpace'",[173,322,323],{"class":182},"), voxelSize: ",[173,325,156],{"class":179},[173,327,306],{"class":182},[173,329,330],{"class":309},"'voxelSize'",[173,332,333],{"class":182},"), fill: ",[173,335,156],{"class":179},[173,337,306],{"class":182},[173,339,340],{"class":309},"'fill'",[173,342,343],{"class":182},"), voxelScale: ",[173,345,156],{"class":179},[173,347,306],{"class":182},[173,349,350],{"class":309},"'voxelScale'",[173,352,353],{"class":182},"), bevel: ",[173,355,156],{"class":179},[173,357,306],{"class":182},[173,359,360],{"class":309},"'bevel'",[173,362,363],{"class":182},"), shadowSoftness: ",[173,365,156],{"class":179},[173,367,306],{"class":182},[173,369,370],{"class":309},"'shadowSoftness'",[173,372,373],{"class":182},"), lightAngle: ",[173,375,156],{"class":179},[173,377,306],{"class":182},[173,379,380],{"class":309},"'lightAngle'",[173,382,383],{"class":182},"), lightElevation: ",[173,385,156],{"class":179},[173,387,306],{"class":182},[173,389,390],{"class":309},"'lightElevation'",[173,392,393],{"class":182},"), depth: ",[173,395,156],{"class":179},[173,397,306],{"class":182},[173,399,400],{"class":309},"'depth'",[173,402,403],{"class":182},"), ",[173,405,161],{"class":179},[173,407,408],{"class":182},": (",[173,410,412],{"class":411},"s9osk","vox",[173,414,208],{"class":182},[173,416,417],{"class":411},"frame",[173,419,208],{"class":182},[173,421,422],{"class":411},"params",[173,424,425],{"class":182},") ",[173,427,428],{"class":295},"=>",[173,430,431],{"class":182}," math.",[173,433,434],{"class":179},"vec4",[173,436,306],{"class":182},[173,438,439],{"class":179},"shade",[173,441,442],{"class":182},"(vox), vox.coverage)})\n",[444,445,446],"blockquote",{},[156,447,448,452,453,456,457,460],{},[449,450,451],"strong",{},"Tip."," Light with ",[8,454,455],{},"materials.lambert(vox.normal, L, {wrap: 0.12})"," times ",[8,458,459],{},"1 − vox.shadow · shadows"," and the blocks read as solid.",[241,462,464],{"id":463},"see-also","See also",[466,467,468,479],"ul",{},[469,470,471,478],"li",{},[472,473,475],"a",{"href":474},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fshapedsurface",[8,476,477],{},"shapedSurface"," — Turns a shape prop into a surface your material shades.",[469,480,481,487],{},[472,482,484],{"href":483},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Flambert",[8,485,486],{},"lambert"," — How much a light falls on a surface: 0 facing away, 1 facing it.",[241,489,491],{"id":490},"used-by","Used by",[156,493,494],{},[472,495,497],{"href":496},"\u002Fdocs\u002Fcomponents\u002Fvoxels","Voxels",[499,500,501],"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 .snl16, html code.shiki .snl16{--shiki-default:#F97583}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}html pre.shiki code .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}",{"title":169,"searchDepth":503,"depth":503,"links":504},2,[505,506,507,508],{"id":243,"depth":503,"text":244},{"id":284,"depth":503,"text":285},{"id":463,"depth":503,"text":464},{"id":490,"depth":503,"text":491},false,"Rebuild the shape from blocks and shade each block with your `surface`.","md","light","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fvoxels\u002Fvoxelsurface",{"title":147,"description":510},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fvoxels.ts#L142","docs\u002Fprimitives\u002F17.voxels\u002F1.voxelsurface","0x_S_jngmWA-RQ566Z6AvB2_Wi5wu0b6u2tR4FuyA24"]