Struct SamplerDescription

Namespace

NeoVeldrid

Assembly

NeoVeldrid.dll

Describes a Sampler, for creation using a ResourceFactory.

public struct SamplerDescription : IEquatable<SamplerDescription>

Implements

IEquatable<SamplerDescription>

Inherited Members

ValueType.Equals(object)

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SamplerDescription(SamplerAddressMode, SamplerAddressMode, SamplerAddressMode, SamplerFilter, ComparisonKind?, uint, uint, uint, int, SamplerBorderColor)

Constructs a new SamplerDescription.

public SamplerDescription(SamplerAddressMode addressModeU, SamplerAddressMode addressModeV, SamplerAddressMode addressModeW, SamplerFilter filter, ComparisonKind? comparisonKind, uint maximumAnisotropy, uint minimumLod, uint maximumLod, int lodBias, SamplerBorderColor borderColor)

Parameters

addressModeU SamplerAddressMode

The SamplerAddressMode mode to use for the U (or R) coordinate.

addressModeV SamplerAddressMode

The SamplerAddressMode mode to use for the V (or S) coordinate.

addressModeW SamplerAddressMode

The SamplerAddressMode mode to use for the W (or T) coordinate.

filter SamplerFilter

The filter used when sampling.

comparisonKind ComparisonKind?

An optional value controlling the kind of comparison to use when sampling. If null, comparison sampling is not used.

maximumAnisotropy uint

The maximum anisotropy of the filter, when Anisotropic is used, or otherwise ignored.

minimumLod uint

The minimum level of detail.

maximumLod uint

The maximum level of detail.

lodBias int

The level of detail bias.

borderColor SamplerBorderColor

The constant color that is sampled when Border is used, or otherwise ignored.

Fields

AddressModeU

The SamplerAddressMode mode to use for the U (or S) coordinate.

public SamplerAddressMode AddressModeU

Field Value

SamplerAddressMode

AddressModeV

The SamplerAddressMode mode to use for the V (or T) coordinate.

public SamplerAddressMode AddressModeV

Field Value

SamplerAddressMode

AddressModeW

The SamplerAddressMode mode to use for the W (or R) coordinate.

public SamplerAddressMode AddressModeW

Field Value

SamplerAddressMode

Aniso4x

Describes a common 4x-anisotropic-filter sampler, with wrapping address mode. Settings: AddressModeU = SamplerAddressMode.Wrap AddressModeV = SamplerAddressMode.Wrap AddressModeW = SamplerAddressMode.Wrap Filter = SamplerFilter.Anisotropic LodBias = 0 MinimumLod = 0 MaximumLod = uint.MaxValue MaximumAnisotropy = 4

public static readonly SamplerDescription Aniso4x

Field Value

SamplerDescription

BorderColor

The constant color that is sampled when Border is used, or otherwise ignored.

public SamplerBorderColor BorderColor

Field Value

SamplerBorderColor

ComparisonKind

An optional value controlling the kind of comparison to use when sampling. If null, comparison sampling is not used.

public ComparisonKind? ComparisonKind

Field Value

ComparisonKind?

Filter

The filter used when sampling.

public SamplerFilter Filter

Field Value

SamplerFilter

Linear

Describes a common linear-filter sampler, with wrapping address mode. Settings: AddressModeU = SamplerAddressMode.Wrap AddressModeV = SamplerAddressMode.Wrap AddressModeW = SamplerAddressMode.Wrap Filter = SamplerFilter.MinLinear_MagLinear_MipLinear LodBias = 0 MinimumLod = 0 MaximumLod = uint.MaxValue MaximumAnisotropy = 0

public static readonly SamplerDescription Linear

Field Value

SamplerDescription

LodBias

The level of detail bias.

public int LodBias

Field Value

int

MaximumAnisotropy

The maximum anisotropy of the filter, when Anisotropic is used, or otherwise ignored.

public uint MaximumAnisotropy

Field Value

uint

MaximumLod

The maximum level of detail.

public uint MaximumLod

Field Value

uint

MinimumLod

The minimum level of detail.

public uint MinimumLod

Field Value

uint

Point

Describes a common point-filter sampler, with wrapping address mode. Settings: AddressModeU = SamplerAddressMode.Wrap AddressModeV = SamplerAddressMode.Wrap AddressModeW = SamplerAddressMode.Wrap Filter = SamplerFilter.MinPoint_MagPoint_MipPoint LodBias = 0 MinimumLod = 0 MaximumLod = uint.MaxValue MaximumAnisotropy = 0

public static readonly SamplerDescription Point

Field Value

SamplerDescription

Methods

Equals(SamplerDescription)

Element-wise equality.

public bool Equals(SamplerDescription other)

Parameters

other SamplerDescription

The instance to compare to.

Returns

bool

True if all elements are equal; false otherswise.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.