Class ShaderWindowSettings

Namespace

Bonsai.Shaders.Configuration

Assembly

Bonsai.Shaders.dll

Represents the configuration settings used to initialize a shader window.

[TypeConverter(typeof(SettingsConverter))]
public class ShaderWindowSettings

Inheritance

object

ShaderWindowSettings

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

ShaderWindowSettings()

Initializes a new instance of the ShaderWindowSettings class.

public ShaderWindowSettings()

Properties

ClearColor

Gets or sets the color used to clear the framebuffer before rendering.

public Color ClearColor { get; set; }

Property Value

Color

ClearColorHtml

Gets or sets an HTML representation of the clear color value for serialization.

[Browsable(false)]
public string ClearColorHtml { get; set; }

Property Value

string

ClearMask

Gets or sets a value specifying which buffers to clear before rendering.

public ClearBufferMask ClearMask { get; set; }

Property Value

ClearBufferMask

CursorVisible

Gets or sets a value specifying whether to hide or show the mouse cursor over the shader window.

public bool CursorVisible { get; set; }

Property Value

bool

DisplayDevice

Gets or sets a value specifying the display device index on which to create the shader window.

public DisplayIndex DisplayDevice { get; set; }

Property Value

DisplayIndex

GraphicsMode

Gets or sets a value specifying the graphics mode of the shader window.

[TypeConverter(typeof(ExpandableObjectConverter))]
public GraphicsModeConfiguration GraphicsMode { get; set; }

Property Value

GraphicsModeConfiguration

Height

Gets or sets the height of the shader window, in pixels.

public int Height { get; set; }

Property Value

int

Location

Gets or sets a value specifying the starting location of the shader window. If no value is specified, the window will be located at the center of the screen.

public Point? Location { get; set; }

Property Value

Point?

RenderState

Gets the collection of configuration objects specifying the initial render state of the shader window graphics context.

public StateConfigurationCollection RenderState { get; }

Property Value

StateConfigurationCollection

SwapSync

Gets or sets a value specifying whether to synchronize buffer swaps across application windows.

public bool SwapSync { get; set; }

Property Value

bool

TargetRenderFrequency

Gets or sets a value specifying the target render frequency. A value of zero indicates the maximum possible frequency will be used to generate render events.

public double TargetRenderFrequency { get; set; }

Property Value

double

TargetUpdateFrequency

Gets or sets a value specifying the target update frequency. If no value is specified, the value of the target render frequency will be used.

public double? TargetUpdateFrequency { get; set; }

Property Value

double?

Title

Gets or sets the title of the shader window.

public string Title { get; set; }

Property Value

string

VSync

Gets or sets a value specifying the V-Sync configuration for shader window buffer swaps.

public VSyncMode VSync { get; set; }

Property Value

VSyncMode

Width

Gets or sets the width of the shader window, in pixels.

public int Width { get; set; }

Property Value

int

WindowBorder

Gets or sets a value specifying the shader window border.

public WindowBorder WindowBorder { get; set; }

Property Value

WindowBorder

WindowState

Gets or sets a value specifying the starting state of the shader window.

public WindowState WindowState { get; set; }

Property Value

WindowState