Struct SamplerStateDescription
Describes a sampling state.
Namespace: Evergine.Common.Graphics
Assembly: Evergine.Common.dll
Syntax
public struct SamplerStateDescription
Fields
AddressU
Method used for resolving a u texture coordinate that is outside the 0 to 1 range.
Declaration
public TextureAddressMode AddressU
Field Value
| Type | Description |
|---|---|
| TextureAddressMode |
AddressV
Method used for resolving a v texture coordinate that is outside the 0 to 1 range.
Declaration
public TextureAddressMode AddressV
Field Value
| Type | Description |
|---|---|
| TextureAddressMode |
AddressW
Method used for resolving a w texture coordinate that is outside the 0 to 1 range.
Declaration
public TextureAddressMode AddressW
Field Value
| Type | Description |
|---|---|
| TextureAddressMode |
BorderColor
Border color of the SamplerBorderColor.
Declaration
public SamplerBorderColor BorderColor
Field Value
| Type | Description |
|---|---|
| SamplerBorderColor |
ComparisonFunc
A function that compares sampled data with existing sampled data.
Declaration
public ComparisonFunction ComparisonFunc
Field Value
| Type | Description |
|---|---|
| ComparisonFunction |
Filter
Filter method to use when sampling a texture.
Declaration
public TextureFilter Filter
Field Value
| Type | Description |
|---|---|
| TextureFilter |
MaxAnisotropy
Clamp value used if D3D11_FILTER_ANISOTROPIC or D3D11_FILTER_COMPARISON_ANISOTROPIC is specified in the filter. Valid values are between 1 and 16.
Declaration
public uint MaxAnisotropy
Field Value
| Type | Description |
|---|---|
| uint |
MaxLOD
Upper end of the mipmap range to clamp access to, where 0 is the largest and most detailed mipmap level, and any level higher than that is less detailed. This value must be greater than or equal to MinLOD.
Declaration
public float MaxLOD
Field Value
| Type | Description |
|---|---|
| float |
MinLOD
Lower end of the mipmap range to clamp access to, where 0 is the largest and most detailed mipmap level, and any level higher than that is less detailed.
Declaration
public float MinLOD
Field Value
| Type | Description |
|---|---|
| float |
MipLODBias
Offset from the calculated mipmap level. For example, if Direct3D calculates that a texture should be sampled at mipmap level 3 and MipLODBias is 2, the texture will be sampled at mipmap level 5.
Declaration
public float MipLODBias
Field Value
| Type | Description |
|---|---|
| float |
Properties
Default
Gets the default values for SamplerStateDescription.
Declaration
public static SamplerStateDescription Default { get; }
Property Value
| Type | Description |
|---|---|
| SamplerStateDescription |
Methods
Equals(SamplerStateDescription)
Returns a hash code for this instance.
Declaration
public bool Equals(SamplerStateDescription other)
Parameters
| Type | Name | Description |
|---|---|---|
| SamplerStateDescription | other | The object to compare. |
Returns
| Type | Description |
|---|---|
| bool | A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. |
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 |
|
Overrides
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 hash tables. |
Overrides
SetDefault()
Default SamplerStateDescription values.
Declaration
public void SetDefault()
Operators
operator ==(SamplerStateDescription, SamplerStateDescription)
Implements the operator ==.
Declaration
public static bool operator ==(SamplerStateDescription value1, SamplerStateDescription value2)
Parameters
| Type | Name | Description |
|---|---|---|
| SamplerStateDescription | value1 | The first value. |
| SamplerStateDescription | value2 | The second value. |
Returns
| Type | Description |
|---|---|
| bool | The result of the operation. |
operator !=(SamplerStateDescription, SamplerStateDescription)
Implements the operator ==.
Declaration
public static bool operator !=(SamplerStateDescription value1, SamplerStateDescription value2)
Parameters
| Type | Name | Description |
|---|---|---|
| SamplerStateDescription | value1 | The first value. |
| SamplerStateDescription | value2 | The second value. |
Returns
| Type | Description |
|---|---|
| bool | The result of the operator. |