Class GPUSamplerDescription

A common description for all samplers.

System.Object
GPUSamplerDescription
System.IEquatable<GPUSamplerDescription>
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class GPUSamplerDescription : ValueType, IEquatable<GPUSamplerDescription>

Fields

AddressU

The addressing mode for outside [0..1] range for U coordinate.

Declaration
public GPUSamplerAddressMode AddressU
Field Value
GPUSamplerAddressMode

AddressV

The addressing mode for outside [0..1] range for V coordinate.

Declaration
public GPUSamplerAddressMode AddressV
Field Value
GPUSamplerAddressMode

AddressW

The addressing mode for outside [0..1] range for W coordinate.

Declaration
public GPUSamplerAddressMode AddressW
Field Value
GPUSamplerAddressMode

BorderColor

The border color to use if Border is specified for AddressU, AddressV, or AddressW.

Declaration
public GPUSamplerBorderColor BorderColor
Field Value
GPUSamplerBorderColor

ComparisonFunction

A function that compares sampled data against existing sampled data.

Declaration
public GPUSamplerCompareFunction ComparisonFunction
Field Value
GPUSamplerCompareFunction

Filter

The filtering method to use when sampling a texture.

Declaration
public GPUSamplerFilter Filter
Field Value
GPUSamplerFilter

MaxAnisotropy

The maximum number of samples that can be used to improve the quality of sample footprints that are anisotropic.

Declaration
public int MaxAnisotropy
Field Value
System.Int32

MaxMipLevel

The maximum mip map level that will be used, where 0 is the highest resolution mip level. To have no upper limit on LOD set this to a large value such as MAX_float.

Declaration
public float MaxMipLevel
Field Value
System.Single

MinMipLevel

The minimum mip map level that will be used, where 0 is the highest resolution mip level.

Declaration
public float MinMipLevel
Field Value
System.Single

MipBias

The mip bias to be added to mipmap LOD calculation.

Declaration
public float MipBias
Field Value
System.Single

Properties

Default

The default GPUSamplerDescription.

Declaration
public static GPUSamplerDescription Default { get; }
Property Value
GPUSamplerDescription

Methods

Clear()

Clears description.

Declaration
public void Clear()

Equals(GPUSamplerDescription)

Declaration
public bool Equals(GPUSamplerDescription other)
Parameters
GPUSamplerDescription other

Returns
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

New(GPUSamplerFilter, GPUSamplerAddressMode)

Creates a new GPUSamplerDescription with default settings.

Declaration
public static GPUSamplerDescription New(GPUSamplerFilter filter, GPUSamplerAddressMode addressMode)
Parameters
GPUSamplerFilter filter

The filtering method.
GPUSamplerAddressMode addressMode

The addressing mode.
Returns
GPUSamplerDescription

A new instance of GPUSamplerDescription class.

Extension Methods