s&box docs
API ReferenceSandbox

Vignetteclass

Applies a vignette to the camera

object→BasePostProcess<T>→Vignette
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.Vignette : Sandbox.BasePostProcess<T>

Constructors1

Showing 1 constructors

Methods1

Showing 1 methods

public virtual void Render()PUBLICVIRTUAL

Returns:void—

Properties5

Showing 5 properties

public Vector2 Sandbox.Vignette.Center { get; set; }PUBLICGETSET

The center of the vignette in relation to UV space. This means a value of {0.5, 0.5} is the center of the screen

Returns:Vector2—

public Color Sandbox.Vignette.Color { get; set; }PUBLICGETSET

The color of the vignette or the "border"

Returns:Color—

public float Sandbox.Vignette.Intensity { get; set; }PUBLICGETSET

How strong the vignette is. This is a value between 0 -> 1

Returns:float—

public float Sandbox.Vignette.Roundness { get; set; }PUBLICGETSET

How circular or round the vignette is

Returns:float—

public float Sandbox.Vignette.Smoothness { get; set; }PUBLICGETSET

How much fall off or how blurry the vignette is

Returns:float—

FinishAsync()

Previous Page

Center

Next Page

On this page

Constructorspublic Vignette()Methodspublic virtual System.Void Render()Propertiespublic Vector2 Sandbox.Vignette.Center { get; set; }public Color Sandbox.Vignette.Color { get; set; }public System.Single Sandbox.Vignette.Intensity { get; set; }public System.Single Sandbox.Vignette.Roundness { get; set; }public System.Single Sandbox.Vignette.Smoothness { get; set; }Metadata