Editor API Reference - v1.1.24
    Preparing search index...

    Type Alias SceneSettingsProps

    Represents the settings for the currently loaded scene.

    type SceneSettingsProps = {
        physics?: { gravity?: [number, number, number] };
        render?: {
            exposure?: number;
            fog?: number;
            fog_color?: [number, number, number];
            fog_density?: number;
            fog_end?: number;
            fog_start?: number;
            gamma_correction?: number;
            global_ambient?: [number, number, number];
            lightmapMaxResolution?: number;
            lightmapMode?: number;
            lightmapSizeMultiplier?: number;
            skybox?: number;
            skyboxIntensity?: number;
            skyboxMip?: number;
            skyboxRotation?: [number, number, number];
            tonemapping?: number;
        };
    }
    Index

    Properties

    physics? render?

    Properties

    physics?: { gravity?: [number, number, number] }

    Physics related settings for the scene.

    Type declaration

    • Optionalgravity?: [number, number, number]

      An array of 3 numbers that represents the gravity force.

    render?: {
        exposure?: number;
        fog?: number;
        fog_color?: [number, number, number];
        fog_density?: number;
        fog_end?: number;
        fog_start?: number;
        gamma_correction?: number;
        global_ambient?: [number, number, number];
        lightmapMaxResolution?: number;
        lightmapMode?: number;
        lightmapSizeMultiplier?: number;
        skybox?: number;
        skyboxIntensity?: number;
        skyboxMip?: number;
        skyboxRotation?: [number, number, number];
        tonemapping?: number;
    }

    Render settings for the scene.

    Type declaration

    • Optionalexposure?: number

      The exposure value tweaks the overall brightness of the scene.

    • Optionalfog?: number

      The type of fog used in the scene. Can be one of pc.FOG_NONE, pc.FOG_LINEAR, pc.FOG_EXP, pc.FOG_EXP2.

    • Optionalfog_color?: [number, number, number]

      An array of 3 numbers representing the color of the fog.

    • Optionalfog_density?: number

      The density of the fog. This property is only valid if the fog property is set to pc.FOG_EXP or pc.FOG_EXP2.

    • Optionalfog_end?: number

      The distance from the viewpoint where linear fog reaches its maximum. This property is only valid if the fog property is set to pc.FOG_LINEAR.

    • Optionalfog_start?: number

      The distance from the viewpoint where linear fog begins. This property is only valid if the fog property is set to pc.FOG_LINEAR.

    • Optionalgamma_correction?: number

      The gamma correction to apply when rendering the scene. Can be one of pc.GAMMA_NONE, pc.GAMMA_SRGB.

    • Optionalglobal_ambient?: [number, number, number]

      An array of 3 numbers representing the color of the scene's ambient light.

    • OptionallightmapMaxResolution?: number

      The maximum lightmap resolution.

    • OptionallightmapMode?: number

      The lightmap baking mode. Can be one of pc.BAKE_COLOR, pc.BAKE_COLORDIR.

    • OptionallightmapSizeMultiplier?: number

      The lightmap resolution multiplier.

    • Optionalskybox?: number

      The id of the cubemap texture to be used as the scene's skybox.

    • OptionalskyboxIntensity?: number

      Multiplier for skybox intensity.

    • OptionalskyboxMip?: number

      The mip level of the skybox to be displayed. Only valid for prefiltered cubemap skyboxes.

    • OptionalskyboxRotation?: [number, number, number]

      An array of 3 numbers representing the rotation of the skybox.

    • Optionaltonemapping?: number

      The tonemapping transform to apply when writing fragments to the frame buffer. Can be: pc.TONEMAP_LINEAR, pc.TONEMAP_FILMIC, pc.TONEMAP_HEJL, pc.TONEMAP_ACES.

    Settings

    Member Visibility

    On This Page

    Properties