Struct GraphicsDeviceOptions

Namespace

NeoVeldrid

Assembly

NeoVeldrid.dll

A structure describing several common properties of a GraphicsDevice.

public struct GraphicsDeviceOptions

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

GraphicsDeviceOptions(bool)

Constructs a new GraphicsDeviceOptions for a device with no main Swapchain.

public GraphicsDeviceOptions(bool debug)

Parameters

debug bool

Indicates whether the GraphicsDevice will support debug features, provided they are supported by the host system.

GraphicsDeviceOptions(bool, PixelFormat?, bool)

Constructs a new GraphicsDeviceOptions for a device with a main Swapchain.

public GraphicsDeviceOptions(bool debug, PixelFormat? swapchainDepthFormat, bool syncToVerticalBlank)

Parameters

debug bool

Indicates whether the GraphicsDevice will enable debug features, provided they are supported by the host system.

swapchainDepthFormat PixelFormat?

An optional PixelFormat to be used for the depth buffer of the swapchain. If this value is null, then no depth buffer will be present on the swapchain.

syncToVerticalBlank bool

Indicates whether the main Swapchain will be synchronized to the window system's vertical refresh rate.

GraphicsDeviceOptions(bool, PixelFormat?, bool, ResourceBindingModel)

Constructs a new GraphicsDeviceOptions for a device with a main Swapchain.

public GraphicsDeviceOptions(bool debug, PixelFormat? swapchainDepthFormat, bool syncToVerticalBlank, ResourceBindingModel resourceBindingModel)

Parameters

debug bool

Indicates whether the GraphicsDevice will enable debug features, provided they are supported by the host system.

swapchainDepthFormat PixelFormat?

An optional PixelFormat to be used for the depth buffer of the swapchain. If this value is null, then no depth buffer will be present on the swapchain.

syncToVerticalBlank bool

Indicates whether the main Swapchain will be synchronized to the window system's vertical refresh rate.

resourceBindingModel ResourceBindingModel

Specifies which model the rendering backend should use for binding resources.

GraphicsDeviceOptions(bool, PixelFormat?, bool, ResourceBindingModel, bool)

Constructs a new GraphicsDeviceOptions for a device with a main Swapchain.

public GraphicsDeviceOptions(bool debug, PixelFormat? swapchainDepthFormat, bool syncToVerticalBlank, ResourceBindingModel resourceBindingModel, bool preferDepthRangeZeroToOne)

Parameters

debug bool

Indicates whether the GraphicsDevice will enable debug features, provided they are supported by the host system.

swapchainDepthFormat PixelFormat?

An optional PixelFormat to be used for the depth buffer of the swapchain. If this value is null, then no depth buffer will be present on the swapchain.

syncToVerticalBlank bool

Indicates whether the main Swapchain will be synchronized to the window system's vertical refresh rate.

resourceBindingModel ResourceBindingModel

Specifies which model the rendering backend should use for binding resources.

preferDepthRangeZeroToOne bool

Indicates whether a 0-to-1 depth range mapping is preferred. For OpenGL, this is not the default, and is not available on all systems.

GraphicsDeviceOptions(bool, PixelFormat?, bool, ResourceBindingModel, bool, bool)

Constructs a new GraphicsDeviceOptions for a device with a main Swapchain.

public GraphicsDeviceOptions(bool debug, PixelFormat? swapchainDepthFormat, bool syncToVerticalBlank, ResourceBindingModel resourceBindingModel, bool preferDepthRangeZeroToOne, bool preferStandardClipSpaceYDirection)

Parameters

debug bool

Indicates whether the GraphicsDevice will enable debug features, provided they are supported by the host system.

swapchainDepthFormat PixelFormat?

An optional PixelFormat to be used for the depth buffer of the swapchain. If this value is null, then no depth buffer will be present on the swapchain.

syncToVerticalBlank bool

Indicates whether the main Swapchain will be synchronized to the window system's vertical refresh rate.

resourceBindingModel ResourceBindingModel

Specifies which model the rendering backend should use for binding resources.

preferDepthRangeZeroToOne bool

Indicates whether a 0-to-1 depth range mapping is preferred. For OpenGL, this is not the default, and is not available on all systems.

preferStandardClipSpaceYDirection bool

Indicates whether a bottom-to-top-increasing clip space Y direction is preferred. For Vulkan, this is not the default, and is not available on all systems.

GraphicsDeviceOptions(bool, PixelFormat?, bool, ResourceBindingModel, bool, bool, bool)

Constructs a new GraphicsDeviceOptions for a device with a main Swapchain.

public GraphicsDeviceOptions(bool debug, PixelFormat? swapchainDepthFormat, bool syncToVerticalBlank, ResourceBindingModel resourceBindingModel, bool preferDepthRangeZeroToOne, bool preferStandardClipSpaceYDirection, bool swapchainSrgbFormat)

Parameters

debug bool

Indicates whether the GraphicsDevice will enable debug features, provided they are supported by the host system.

swapchainDepthFormat PixelFormat?

An optional PixelFormat to be used for the depth buffer of the swapchain. If this value is null, then no depth buffer will be present on the swapchain.

syncToVerticalBlank bool

Indicates whether the main Swapchain will be synchronized to the window system's vertical refresh rate.

resourceBindingModel ResourceBindingModel

Specifies which model the rendering backend should use for binding resources.

preferDepthRangeZeroToOne bool

Indicates whether a 0-to-1 depth range mapping is preferred. For OpenGL, this is not the default, and is not available on all systems.

preferStandardClipSpaceYDirection bool

Indicates whether a bottom-to-top-increasing clip space Y direction is preferred. For Vulkan, this is not the default, and is not available on all systems.

swapchainSrgbFormat bool

Indicates whether the main Swapchain should use an sRGB format. This value is only used in cases where the properties of the main SwapChain are not explicitly specified with a SwapchainDescription. If they are, then the value of ColorSrgb will supercede the value specified here.

Fields

Debug

Indicates whether the GraphicsDevice will support debug features, provided they are supported by the host system.

public bool Debug

Field Value

bool

HasMainSwapchain

Indicates whether the Graphicsdevice will include a "main" Swapchain. If this value is true, then the GraphicsDevice must be created with one of the overloads that provides Swapchain source information.

public bool HasMainSwapchain

Field Value

bool

PreferDepthRangeZeroToOne

Indicates whether a 0-to-1 depth range mapping is preferred. For OpenGL, this is not the default, and is not available on all systems.

public bool PreferDepthRangeZeroToOne

Field Value

bool

PreferStandardClipSpaceYDirection

Indicates whether a bottom-to-top-increasing clip space Y direction is preferred. For Vulkan, this is not the default, and may not be available on all systems.

public bool PreferStandardClipSpaceYDirection

Field Value

bool

ResourceBindingModel

Specifies which model the rendering backend should use for binding resources. This can be overridden per-pipeline by specifying a value in ResourceBindingModel.

public ResourceBindingModel ResourceBindingModel

Field Value

ResourceBindingModel

SwapchainDepthFormat

An optional PixelFormat to be used for the depth buffer of the swapchain. If this value is null, then no depth buffer will be present on the swapchain.

public PixelFormat? SwapchainDepthFormat

Field Value

PixelFormat?

SwapchainSrgbFormat

Indicates whether the main Swapchain should use an sRGB format. This value is only used in cases where the properties of the main SwapChain are not explicitly specified with a SwapchainDescription. If they are, then the value of ColorSrgb will supercede the value specified here.

public bool SwapchainSrgbFormat

Field Value

bool

SyncToVerticalBlank

Indicates whether the main Swapchain will be synchronized to the window system's vertical refresh rate.

public bool SyncToVerticalBlank

Field Value

bool