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