class DirectX11ContextFactory in Tinman.AddOns.DirectX11

Factory for DirectX11Context.

sealed class

DirectX11ContextFactory

extends

GraphicsContextFactory

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<IGraphicsContextFactory>
value	[not-null]	The configurator object.

ToConfig

Returns the configuration value that describes this object.

public override method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
implements	GraphicsContextFactory.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.

Public / Attributes

CanCreateGraphicsContext

Can this factory create a graphics context in the current environment?

public override property	CanCreateGraphicsContext { get }
type	bool
value		true if the graphics context is available, false if not.
implements	GraphicsContextFactory.CanCreateGraphicsContext

Remarks:

The value of this property reflects the environment only, e.g. the availability of native libraries. It does not take into account the current application state, such as the presence of a primary window.

MultiSampling

The multisampling type to use.

public property	MultiSampling { get set }
type	MultiSampleType
value		The multisampling type.
inherited	GraphicsContextFactory.MultiSampling

Remarks:

The default value is None.

If the given multisampling type is not supported, the closest match will be used.

ShaderEffects

List of directory paths that contain shader effects.

public property	ShaderEffects { get }
type	IVectorConst<Path>
value	[not-null]	The list of shader effect directory paths.
inherited	GraphicsContextFactory.ShaderEffects

Remarks:

For each directory path in this list, the RegisterShaderEffects will be called during GetGraphicsContext. Additional shader effects can be registered after creation by calling RegisterShaderEffects.

VerticalSync

Enable vertical sync, if possible?

public property	VerticalSync { get set }
type	bool
value		true to enable vertical sync, false to disable it.
inherited	GraphicsContextFactory.VerticalSync

Remarks:

The default value is true.

Public / Methods

AddShaderEffects

Adds the given path to the list of shader effect directories.

public method	AddShaderEffects (Path path)
params	path	[not-null]	Path to a directory that holds shader files.
inherited	GraphicsContextFactory.AddShaderEffects

See also:

IGraphicsContextFactory.ShaderEffects

Equals

Compares this object with the given one.

[Pure]
public override method	Equals (IGraphicsContextFactory other)
type	bool
params	other		The object to compare to.
returns			true if this object is equal to other, false if not.
overrides	GraphicsContextFactory.Equals

GetGraphicsContext

Returns the graphics context for the current factory settings.

[OwnerReturn]
public method	GetGraphicsContext ()
type	IGraphicsContext
returns		[not-null]	The graphics context.
inherited	GraphicsContextFactory.GetGraphicsContext