ExtendedSceneEnvironment QML Type
SceneEnvironment containing commonly used rendering effects. More...
Import Statement: | import QtQuick3D.Helpers |
Inherits: |
Properties
- adjustmentBrightness : real
- adjustmentContrast : real
- adjustmentSaturation : real
- colorAdjustmentsEnabled : bool
- depthOfFieldBlurAmount : real
- depthOfFieldEnabled : bool
- depthOfFieldFocusDistance : real
- depthOfFieldFocusRange : real
- ditheringEnabled : bool
- exposure : real
- fxaaEnabled : bool
- glowBlendMode : int
- glowBloom : real
- glowEnabled : bool
- glowHDRMaximumValue : real
- glowHDRMinimumValue : real
- glowHDRScale : real
- glowIntensity : real
- glowLevel : int
- glowQualityHigh : bool
- glowStrength : real
- glowUseBicubicUpscale : bool
- lensFlareApplyDirtTexture : bool
- lensFlareApplyStarburstTexture : bool
- lensFlareBloomBias : real
- lensFlareBloomScale : real
- lensFlareBlurAmount : real
- lensFlareCameraDirection : vector3d
- lensFlareDistortion : real
- lensFlareEnabled : bool
- lensFlareGhostCount : int
- lensFlareGhostDispersal : real
- lensFlareHaloWidth : real
- lensFlareLensColorTexture : Texture
- lensFlareLensDirtTexture : Texture
- lensFlareLensStarburstTexture : Texture
- lensFlareStretchToAspect : real
- lutEnabled : bool
- lutFilterAlpha : real
- lutSize : real
- lutTextureSource : Texture
- sharpnessAmount : real
- vignetteColor : color
- vignetteEnabled : bool
- vignetteRadius : real
- vignetteStrength : real
- whitePoint : real
Detailed Description
The ExtendedSceneEnvironment
is an extension of QtQuick3D's SceneEnvironment type that comes with a collection of commonly used effects built-in. The effects are exposed through a set of properties that are prefixed with the name of the effect they control.
Note: If additional effects are added to the SceneEnvironment, then those effects will be applied before the effects provided by the ExtendedSceneEnvironment type.
Property Documentation
[default: 1] adjustmentBrightness : real |
The global brightness adjustment of the output color.
Note: Requires that colorAdjustmentsEnabled is set to true
.
[default: 1] adjustmentContrast : real |
The global contrast adjustment.
Note: Requires that colorAdjustmentsEnabled is set to true
.
[default: 1] adjustmentSaturation : real |
The global adjustment of the saturation of the output.
Note: Requires that colorAdjustmentsEnabled is set to true
.
[default: false] colorAdjustmentsEnabled : bool |
See also colorAdjustmentsEnabled.
[default: 4.0] depthOfFieldBlurAmount : real |
The strength of blur when out of focus. Sensible values are in the range 1 to 10.
[default: false] depthOfFieldEnabled : bool |
Enables the depth of field blur effect.
[default: 600] depthOfFieldFocusDistance : real |
The distance from the camera where the content is in perfect focus.
[default: 100] depthOfFieldFocusRange : real |
The distance around the depthOfFieldFocusDistance where items are fully in focus. The focus then fades away to fully blurred by the same distance on both the near and far sides.
[default: false] ditheringEnabled : bool |
Enables dithering.
[default: 1.0] exposure : real |
Exposure level used by the tonemapper.
[default: false] fxaaEnabled : bool |
Enables fast approximate anti-aliasing (FXAA).
[default: ExtendedSceneEnvironment::GlowBlendMode::SoftLight] glowBlendMode : int |
Blending mode for the glow effect.
Available modes are:
- Additive
- Screen
- SoftLight
- Replace
Usage:
glowBlendMode = ExtendedSceneEnvironment.GlowBlendMode.SoftLight
See also ExtendedSceneEnvironment::GlowBlendMode.
[default: 0] glowBloom : real |
The intensity of the bloom. Values from 0 to 1 are expected.
[default: false] glowEnabled : bool |
Enables the glow effect.
[default: 12.0] glowHDRMaximumValue : real |
The maximum value for the HDR glow. Value range is from 0 to 256.
[default: 1.0] glowHDRMinimumValue : real |
The minimum value for the HDR glow. Expected values are in the range 0 to 4.
[default: 2.0] glowHDRScale : real |
The bleed scale of the HDR glow. Expected values are in the range 0 to 8.
[default: 0.8] glowIntensity : real |
Glow intensity. Expected values are in the range 0 to 8.
[default: 1] glowLevel : int |
The glow level. There are a total of 7 levels available.
For exanmple, to enable Glow Level One and Six we just OR the two enums together:
glowLevel = (ExtendedSceneEnvironment.GlowLevel.One | ExtendedSceneEnvironment.GlowLevel.Six)
See also glowEnabled.
[default: false] glowQualityHigh : bool |
Increases the samples used for the glow when down-sampling to improve the quality of the glow effect.
Note: Enabling this is a trade off between rendering quality and performance. Consider if dithering can be used instead.
See also ditheringEnabled.
[default: 1] glowStrength : real |
Glow strength. Acceptable values are from 0 to 2.
[default: false] glowUseBicubicUpscale : bool |
Note: Using bi-cubic up-scaling will come at the cost of performance. Consider if dithering can be used instead.
See also ditheringEnabled.
[default: false] lensFlareApplyDirtTexture : bool |
Enables the lens dirt effect.
See also lensFlareLensDirtTexture.
[default: false] lensFlareApplyStarburstTexture : bool |
Enables the star burst effect.
See also lensFlareLensStarburstTexture.
[default: 0.95] lensFlareBloomBias : real |
Bloom bias.
[default: 10] lensFlareBloomScale : real |
The scale of the bloom. Expected scale value ranges from 0 to 20.
[default: 3] lensFlareBlurAmount : real |
Flare blur amount. Ranges from 0 to 5
[default: Qt.vector3d(0, 0, -1)] lensFlareCameraDirection : vector3d |
[default: 5] lensFlareDistortion : real |
Distortion of the lens flare. Expected values ranges from 0 to 20
[default: false] lensFlareEnabled : bool |
Enables the lens flare effect.
[default: 4] lensFlareGhostCount : int |
Rendered ghost count. Expected values are from 0 to 20.
[default: 0.5] lensFlareGhostDispersal : real |
Ghost dispersal. Expected values are between 0 and 5.
[default: 0.25] lensFlareHaloWidth : real |
Width of the flare halo, ranges from 0 to 1.
lensFlareLensColorTexture : Texture |
The texture used to color the lens flare.
lensFlareLensDirtTexture : Texture |
The texture used for simulating lens dirt.
See also ExtendedSceneEnvironment::lensFlareApplyDirtTexture.
lensFlareLensStarburstTexture : Texture |
The texture used for simulating the starburst effect.
See also lensFlareApplyStarburstTexture.
[default: 0.5 [0, 1]] lensFlareStretchToAspect : real |
[default: false] lutEnabled : bool |
Enables color grading with look-up-tables (LUTs).
[default: 1] lutFilterAlpha : real |
Alpha filter value. Values from 0 to 1 are expected.
[default: 16] lutSize : real |
Size of the look-up texture. The look-up textures are 3D textures, so:
width = lutSize * lutSize
and height = lutSize
lutTextureSource : Texture |
Source of look-up texture. If no texture is set a built-in identity table is used.
[default: 0.0] sharpnessAmount : real |
Set the sharpening amount. Valid values are from 0.0
(off) to 1.0
(full).
[default: "gray"] vignetteColor : color |
Sets the color to use for the vignetting.
[default: false] vignetteEnabled : bool |
Enable the vignette effect.
[default: 0.35] vignetteRadius : real |
Specifies the size of the vignetting. Ranges from 0 to 5.
[default: 15] vignetteStrength : real |
Specifies the strength of the vignetting. Ranges from 0 to 15.
[default: 1] whitePoint : real |
Reference value for white when tonemapping is enabled.
Note: This value is ignored when using TonemapModeLinear