Skip to content

@relu-interactives/spatial-ecs


@relu-interactives/spatial-ecs / components / EnvironmentSkyboxState

Type Alias: EnvironmentSkyboxState

ts
type EnvironmentSkyboxState = {
  type: EnvironmentSkyboxType;
  color: string;
  imageUrl?: string;
  gradient: {
     colors: string[];
     effect: EnvironmentGradientEffect;
  };
};

Defined in: components/Environment.ts:11

Skybox configuration. Only the fields relevant to type are read at render time.

Properties

PropertyTypeDescriptionDefined in
typeEnvironmentSkyboxTypeActive skybox mode.components/Environment.ts:13
colorstringSolid color used when type is "color". #rrggbb.components/Environment.ts:15
imageUrl?stringURL or localasset:// path of the equirectangular image used when type is "image".components/Environment.ts:17
gradient{ colors: string[]; effect: EnvironmentGradientEffect; }Gradient parameters used when type is "gradient".components/Environment.ts:19
gradient.colorsstring[]Ordered list of color stops as #rrggbb strings.components/Environment.ts:21
gradient.effectEnvironmentGradientEffectGradient distribution.components/Environment.ts:23