Struct GPUSamplerDescription

A common description for all samplers.

Assembly: FlaxEngine.dll

File: Engine/Graphics/Textures/GPUSamplerDescription.h

Syntax

public struct 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 int32 MaxAnisotropy

Field Value

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

float

MinMipLevel

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

Declaration

public float MinMipLevel

Field Value

float

MipBias

The mip bias to be added to mipmap LOD calculation.

Declaration

public float MipBias

Field Value

float

Methods

Clear()

Declaration

public void Clear()

Equals(const GPUSamplerDescription& other)

Declaration

public bool Equals(const GPUSamplerDescription& other) const

Parameters

GPUSamplerDescription other

Returns

bool

New(GPUSamplerFilter filter=GPUSamplerFilter::Point, GPUSamplerAddressMode addressMode=GPUSamplerAddressMode::Wrap)

Creates a new GPUSamplerDescription with default settings.

Declaration

public static GPUSamplerDescription New(GPUSamplerFilter filter=GPUSamplerFilter::Point, GPUSamplerAddressMode addressMode=GPUSamplerAddressMode::Wrap)

Parameters

GPUSamplerFilter filter The filtering method.

GPUSamplerAddressMode addressMode The addressing mode.

Returns

GPUSamplerDescription A new instance of GPUSamplerDescription class.

operator!=(const GPUSamplerDescription& other)

Declaration

public bool operator!=(const GPUSamplerDescription& other) const

Parameters

GPUSamplerDescription other

Returns

bool

operator==(const GPUSamplerDescription& other)

Declaration

public bool operator==(const GPUSamplerDescription& other) const

Parameters

GPUSamplerDescription other

Returns

bool

ToString()

Declaration

public String ToString() const

Returns

String