Skip to main content

Interface: VignettePipelineConfiguration

Properties​

blendMode?​

optional blendMode?: "Multiply" | "Opaque"

"Multiply" or "Opaque". "Multiply" will mix the vignette color with the scene color. "Opaque" will replace the scene color with the vignette color.


cameraFov?​

optional cameraFov?: number

The FOV of the camera. This is used to calculate the vignette size.


center?​

optional center?: object

The offset of the vignette center, in screen space.

x​

x: number

y​

y: number


colorHex?​

optional colorHex?: string

The color of the vignette, provided as a hex string.


colorRgba?​

optional colorRgba?: Color4Configuration

The color of the vignette, provided as an RGBA value.


enabled?​

optional enabled?: boolean


stretch?​

optional stretch?: number

Horizontal stretch of the vignette. Higher values will cause the vignette to be appear more like bars on the top and bottom of the screen.


weight?​

optional weight?: number

The strength/size of the vignette effect.