[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fkeylightat":129},{"stars":4},5505,[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":188,"categorySlug":188,"categoryTitle":452,"curated":453,"description":454,"editUrl":455,"extension":456,"group":457,"groupTitle":458,"kind":459,"meta":460,"navigation":461,"path":462,"seo":463,"sourceUrl":464,"stem":465,"wordCount":455,"__hash__":466},"primitives\u002Fdocs\u002Fprimitives\u002F14.materials\u002F12.keylightat.md","keyLightAt",{"type":133,"value":134,"toc":445},"minimark",[135,139,151,183,198,230,235,302,306,344,354,358,410,414,441],[136,137,131],"h1",{"id":138},"keylightat",[140,141,142,143,146,147,150],"p",{},"A key light from an angle: the light direction ",[10,144,145],{},".L"," and the half vector ",[10,148,149],{},".H"," for highlights.",[152,153,158],"pre",{"className":154,"code":155,"language":156,"meta":157,"style":157},"language-ts shiki shiki-themes github-dark","keyLightAt(dir: Expr, elevation: number, hint: string = 'kl'): Expr\n","ts","",[10,159,160],{"__ignoreMap":157},[161,162,165,168,172,176,180],"span",{"class":163,"line":164},"line",1,[161,166,131],{"class":167},"svObZ",[161,169,171],{"class":170},"s95oV","(dir: Expr, elevation: number, hint: string ",[161,173,175],{"class":174},"snl16","=",[161,177,179],{"class":178},"sU2Wk"," 'kl'",[161,181,182],{"class":170},"): Expr\n",[140,184,185,186,189,190,193,194,197],{},"Import ",[10,187,188],{},"materials"," from ",[10,191,192],{},"shaders\u002Fstd"," and use ",[10,195,196],{},"materials.keyLightAt",".",[140,199,200,203,204,207,208,211,212,215,216,218,219,222,223,226,227,229],{},[10,201,202],{},"dir"," is a ",[10,205,206],{},"direction()"," vector (from ",[10,209,210],{},"frames","). ",[10,213,214],{},"elevation"," is how far the light sits toward the viewer: −0.6 raking, −0.9 frontal. Read ",[10,217,145],{}," with ",[10,220,221],{},"member('L')"," for ",[10,224,225],{},"lambert"," and ",[10,228,149],{}," for a glint.",[231,232,234],"h2",{"id":233},"parameters","Parameters",[236,237,238,254],"table",{},[239,240,241],"thead",{},[242,243,244,248,251],"tr",{},[245,246,247],"th",{},"Name",[245,249,250],{},"Type",[245,252,253],{},"Notes",[255,256,257,271,284],"tbody",{},[242,258,259,264,269],{},[260,261,262],"td",{},[10,263,202],{},[260,265,266],{},[10,267,268],{},"Expr",[260,270],{},[242,272,273,277,282],{},[260,274,275],{},[10,276,214],{},[260,278,279],{},[10,280,281],{},"number",[260,283],{},[242,285,286,291,296],{},[260,287,288],{},[10,289,290],{},"hint",[260,292,293],{},[10,294,295],{},"string",[260,297,298,299,197],{},"Optional. Default ",[10,300,301],{},"'kl'",[231,303,305],{"id":304},"example","Example",[152,307,309],{"className":154,"code":308,"language":156,"meta":157,"style":157},"const key = keyLightAt(direction(u.lightAngle), -0.7)\n",[10,310,311],{"__ignoreMap":157},[161,312,313,316,320,323,326,329,332,335,338,341],{"class":163,"line":164},[161,314,315],{"class":174},"const",[161,317,319],{"class":318},"sDLfK"," key",[161,321,322],{"class":174}," =",[161,324,325],{"class":167}," keyLightAt",[161,327,328],{"class":170},"(",[161,330,331],{"class":167},"direction",[161,333,334],{"class":170},"(u.lightAngle), ",[161,336,337],{"class":174},"-",[161,339,340],{"class":318},"0.7",[161,342,343],{"class":170},")\n",[345,346,347],"blockquote",{},[140,348,349,353],{},[350,351,352],"strong",{},"Tip."," Elevation is negative in this engine. A positive value lights the surface from behind.",[231,355,357],{"id":356},"see-also","See also",[359,360,361,372,384,392,401],"ul",{},[362,363,364,371],"li",{},[365,366,368],"a",{"href":367},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fkeylightxy",[10,369,370],{},"keyLightXY"," — A key light from explicit x and y components, for a second or a crossed light.",[362,373,374,380,381,383],{},[365,375,377],{"href":376},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Flightvec3",[10,378,379],{},"lightVec3"," — A 3D light direction from a ",[10,382,206],{}," vector and an elevation.",[362,385,386,391],{},[365,387,389],{"href":388},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Flambert",[10,390,225],{}," — How much a light falls on a surface: 0 facing away, 1 facing it.",[362,393,394,400],{},[365,395,397],{"href":396},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fduallobeglint",[10,398,399],{},"dualLobeGlint"," — A highlight with a tight hot core and a wide dim halo.",[362,402,403,409],{},[365,404,406],{"href":405},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fsharpglint",[10,407,408],{},"sharpGlint"," — A highlight whose tightness follows a sharpness slider.",[231,411,413],{"id":412},"used-by","Used by",[140,415,416,420,421,420,425,420,429,420,433,420,437],{},[365,417,419],{"href":418},"\u002Fdocs\u002Fcomponents\u002Ffrost","Frost",", ",[365,422,424],{"href":423},"\u002Fdocs\u002Fcomponents\u002Fgoo","Goo",[365,426,428],{"href":427},"\u002Fdocs\u002Fcomponents\u002Fliquidmetal","LiquidMetal",[365,430,432],{"href":431},"\u002Fdocs\u002Fcomponents\u002Fnebula","Nebula",[365,434,436],{"href":435},"\u002Fdocs\u002Fcomponents\u002Fplastic","Plastic",[365,438,440],{"href":439},"\u002Fdocs\u002Fcomponents\u002Fwater","Water",[442,443,444],"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":157,"searchDepth":446,"depth":446,"links":447},2,[448,449,450,451],{"id":233,"depth":446,"text":234},{"id":304,"depth":446,"text":305},{"id":356,"depth":446,"text":357},{"id":412,"depth":446,"text":413},"Materials & surfaces",false,"A key light from an angle: the light direction `.L` and the half vector `.H` for highlights.",null,"md","light","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fkeylightat",{"title":131,"description":454},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fmaterials.ts#L784","docs\u002Fprimitives\u002F14.materials\u002F12.keylightat","9dwcWVFVzBV0r4NiB9l1a7i62XCltRUHUmBP2pZ13BQ"]