(self.webpackChunkstardust_website=self.webpackChunkstardust_website||[]).push([[342],{3905:function(e,t,n){"use strict";n.d(t,{Zo:function(){return u},kt:function(){return m}});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=r.createContext({}),c=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},u=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,l=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),d=c(n),m=o,b=d["".concat(l,".").concat(m)]||d[m]||p[m]||i;return n?r.createElement(b,a(a({ref:t},u),{},{components:n})):r.createElement(b,a({ref:t},u))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:o,a[1]=s;for(var c=2;c<i;c++)a[c]=n[c];return r.createElement.apply(null,a)}return r.createElement.apply(null,n)}d.displayName="MDXCreateElement"},3960:function(e,t,n){"use strict";n.r(t),n.d(t,{frontMatter:function(){return s},contentTitle:function(){return l},metadata:function(){return c},toc:function(){return u},default:function(){return d}});var r=n(2122),o=n(9756),i=(n(7294),n(3905)),a=["components"],s={},l="/environment",c={unversionedId:"stardust-protocol/server/objects/environment",id:"stardust-protocol/server/objects/environment",isDocsHomePage:!1,title:"/environment",description:"Interface managing the skytex and skylight (equivalent of desktop background).",source:"@site/docs/stardust-protocol/server/objects/environment.md",sourceDirName:"stardust-protocol/server/objects",slug:"/stardust-protocol/server/objects/environment",permalink:"/docs/stardust-protocol/server/objects/environment",editUrl:"https://github.com/StardustXR/website/edit/main/docs/stardust-protocol/server/objects/environment.md",version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"PointerInput",permalink:"/docs/stardust-protocol/server/types/input/inputtypes/PointerInput"},next:{title:"/field",permalink:"/docs/stardust-protocol/server/objects/field"}},u=[{value:"Signals",id:"signals",children:[{value:"<code>visible(bool enable)</code>",id:"visiblebool-enable",children:[]},{value:"<code>setSkytex(string path)</code>",id:"setskytexstring-path",children:[]},{value:"<code>setLighting(string path)</code>",id:"setlightingstring-path",children:[]}]}],p={toc:u};function d(e){var t=e.components,n=(0,o.Z)(e,a);return(0,i.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"environment"},"/environment"),(0,i.kt)("p",null,"Interface managing the skytex and skylight (equivalent of desktop background)."),(0,i.kt)("h2",{id:"signals"},"Signals"),(0,i.kt)("h3",{id:"visiblebool-enable"},(0,i.kt)("inlineCode",{parentName:"h3"},"visible(bool enable)")),(0,i.kt)("p",null,"Enable or disables the skybox visibility (lighting remains active). This is not meant to be used for an additive AR mode as StereoKit will perform that when the OpenXR runtime indicates the layer's blend mode is additive."),(0,i.kt)("h3",{id:"setskytexstring-path"},(0,i.kt)("inlineCode",{parentName:"h3"},"setSkytex(string path)")),(0,i.kt)("p",null,"Sets the sky texture to be the image (HDR) at the absolute ",(0,i.kt)("inlineCode",{parentName:"p"},"path"),"."),(0,i.kt)("h3",{id:"setlightingstring-path"},(0,i.kt)("inlineCode",{parentName:"h3"},"setLighting(string path)")),(0,i.kt)("p",null,"Sets the ambient lighting (using spherical harmonics) to the HDR at the absolute ",(0,i.kt)("inlineCode",{parentName:"p"},"path"),"."))}d.isMDXComponent=!0}}]);