Struct GorgonMultisampleInfo

Values to define the number and quality of multisampling.

Implements

IEquatable<GorgonMultisampleInfo>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Gorgon.Graphics.Core

Assembly: Gorgon.Graphics.Core.dll

Syntax

public readonly struct GorgonMultisampleInfo : IEquatable<GorgonMultisampleInfo>

Remarks

Setting the Count and Quality values to 1 and 0 respectively, will disable multisampling.

If multisample anti-aliasing is being used, all bound render targets and depth buffers must have the same sample counts and quality levels.

Constructors

GorgonMultisampleInfo(int, int)

Initializes a new instance of the GorgonMultisampleInfo struct.

Declaration

public GorgonMultisampleInfo(int count, int quality)

Parameters

Type	Name	Description
int	count	The number of samples per pixel.
int	quality	Image quality.

Fields

CenteredMultisamplePatternQuality

A pattern where all of the samples are located at the pixel center.

Declaration

public static readonly int CenteredMultisamplePatternQuality

Field Value

Type	Description
int

Count

The number of samples per pixel.

Declaration

public readonly int Count

Field Value

Type	Description
int

NoMultiSampling

The default multisampling value.

Declaration

public static readonly GorgonMultisampleInfo NoMultiSampling

Field Value

Type	Description
GorgonMultisampleInfo

Quality

The quality for a sample.

Declaration

public readonly int Quality

Field Value

Type	Description
int

StandardMultisamplePatternQuality

A quality level for standard multisample quality.

Declaration

public static readonly int StandardMultisamplePatternQuality

Field Value

Type	Description
int

Methods

Equals(GorgonMultisampleInfo)

Function to determine if two instances are equal.

Declaration

public bool Equals(GorgonMultisampleInfo other)

Parameters

Type	Name	Description
GorgonMultisampleInfo	other	Other instance for the equality test.

Returns

Type	Description
bool	true if equal, false if not.

Equals(object)

Determines whether the specified object is equal to this instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with this instance.

Returns

Type	Description
bool	true if the specified object is equal to this instance; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

ValueType.GetHashCode()

ToString()

Returns a string that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents this instance.

Overrides

ValueType.ToString()

Operators

operator ==(GorgonMultisampleInfo, GorgonMultisampleInfo)

Equality operator.

Declaration

public static bool operator ==(GorgonMultisampleInfo left, GorgonMultisampleInfo right)

Parameters

Type	Name	Description
GorgonMultisampleInfo	left	The left.
GorgonMultisampleInfo	right	The right.

Returns

Type	Description
bool	true if equal, false if not equal.

operator !=(GorgonMultisampleInfo, GorgonMultisampleInfo)

Inequality operator.

Declaration

public static bool operator !=(GorgonMultisampleInfo left, GorgonMultisampleInfo right)

Parameters

Type	Name	Description
GorgonMultisampleInfo	left	The left.
GorgonMultisampleInfo	right	The right.

Returns

Type	Description
bool	true if not equal, false if equal.

Implements

IEquatable<T>

Extension Methods

GorgonNullExtensions.AsNullable<T>(object)

GorgonNullExtensions.IfNull<T>(object, T)

GorgonNullExtensions.IsNull(object)