Interface IEnvironmentHelperOptions
backgroundYRotation: number;
cameraContrast: number;
cameraExposure: number;
createGround: boolean;
createSkybox: boolean;
enableGroundMirror: boolean;
enableGroundShadow: boolean;
environmentTexture: string | BaseTexture;
groundColor: Color3;
groundMirrorAmount: number;
groundMirrorBlurKernel: number;
groundMirrorFallOffDistance: number;
groundMirrorFresnelWeight: number;
groundMirrorSizeRatio: number;
groundMirrorTextureType: number;
groundOpacity: number;
groundShadowLevel: number;
groundSize: number;
groundTexture: string | BaseTexture;
groundYBias: number;
rootPosition: Vector3;
setupImageProcessing: boolean;
sizeAuto: boolean;
skyboxColor: Color3;
skyboxSize: number;
skyboxTexture: string | BaseTexture;
toneMappingEnabled: boolean;
}
Index
Properties
Properties
background Y Rotation
The background rotation around the Y axis of the scene. This helps aligning the key lights of your scene with the background. 0 by default.
camera Contrast
The value of the contrast to apply to the scene. 1.6 by default if setupImageProcessing is true.
camera Exposure
The value of the exposure to apply to the scene. 0.6 by default if setupImageProcessing is true.
create Ground
Specifies whether or not to create a ground. True by default.
create Skybox
Specifies whether or not to create a skybox. True by default.
enable Ground Mirror
Creates a mirror texture attach to the ground. false by default.
enable Ground Shadow
Enables the ground to receive shadows. True by default.
environment Texture
The texture used as your environment texture in the scene. Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
Remarks: Can be either a texture or a url.
ground Color
The color mixed in the ground texture by default. BabylonJS clearColor by default.
ground Mirror Amount
Specifies the ground mirror visibility amount. 1 by default
ground Mirror Blur Kernel
Specifies the ground mirror blur kernel size. 64 by default.
ground Mirror Fall Off Distance
Specifies the ground mirror Falloff distance. This can helps reducing the size of the reflection. 0 by Default.
ground Mirror Fresnel Weight
Specifies the ground mirror reflectance weight. This uses the standard weight of the background material to setup the fresnel effect of the mirror. 1 by default.
ground Mirror Size Ratio
Specifies the ground mirror size ratio. 0.3 by default as the default kernel is 64.
ground Mirror Texture Type
Specifies the ground mirror texture type. Unsigned Int by Default.
ground Opacity
Specifies the ground opacity. 1 by default.
ground Shadow Level
Helps preventing the shadow to be fully black on the ground. 0.5 by default.
ground Size
Specifies the ground size. 15 by default.
ground Texture
The texture used on the ground for the main color. Comes from the BabylonJS CDN by default.
Remarks: Can be either a texture or a url.
ground Y Bias
Specifies a bias applied to the ground vertical position to prevent z-fighting with the shown objects.
root Position
Default position of the rootMesh if autoSize is not true.
setup Image Processing
Sets up the image processing in the scene. true by default.
size Auto
Compute automatically the size of the elements to best fit with the scene.
skybox Color
The color mixed in the skybox texture by default. BabylonJS clearColor by default.
skybox Size
Specifies the skybox size. 20 by default.
skybox Texture
The texture used on the skybox for the main color. Comes from the BabylonJS CDN by default.
Remarks: Can be either a texture or a url.
tone Mapping Enabled
Specifies whether or not tonemapping should be enabled in the scene. true by default if setupImageProcessing is true.
Represents the different options available during the creation of a Environment helper.
This can control the default ground, skybox and image processing setup of your scene.