TSdlGpuSamplerCreateInfo
A record specifying the parameters of a sampler.
Note that MipLodBias is a no-op for the Metal driver. For Metal, LOD bias must be applied via shader instead.
Definition
Unit: Neslib.Sdl3.Gpu
See Also
Properties
| Name | Description |
|---|---|
| AddressModeU | The addressing mode for U coordinates outside [0, 1). |
| AddressModeV | The addressing mode for V coordinates outside [0, 1). |
| AddressModeW | The addressing mode for W coordinates outside [0, 1). |
| AnisotropyEnabled | True to enable anisotropic filtering. |
| CompareEnabled | True to enable comparison against a reference value during lookups. |
| CompareOp | The comparison operator to apply to fetched data before filtering. |
| MagFilter | The magnification filter to apply to lookups. |
| MaxAnisotropy | The anisotropy value clamp used by the sampler. If enable_anisotropy is false, this is ignored. |
| MaxLod | Clamps the maximum of the computed LOD value. |
| MinFilter | The minification filter to apply to lookups. |
| MinLod | Clamps the minimum of the computed LOD value. |
| MipLodBias | The bias to be added to mipmap LOD calculation. Note that this is a no-op for the Metal driver. For Metal, LOD bias must be applied via shader instead. |
| MipmapMode | The mipmap filter to apply to lookups. |
| Props | A properties ID for extensions. Should be 0 if no extensions are needed. |
Methods
| Name | Description |
|---|---|
| Create | Create with default values. |
| Init | Init with default values. |
Property Descriptions
AddressModeU
The addressing mode for U coordinates outside [0, 1).
property AddressModeU: TSdlGpuSamplerAddressMode read GetAddressModeU write SetAddressModeU
Type: TSdlGpuSamplerAddressMode
AddressModeV
The addressing mode for V coordinates outside [0, 1).
property AddressModeV: TSdlGpuSamplerAddressMode read GetAddressModeV write SetAddressModeV
Type: TSdlGpuSamplerAddressMode
AddressModeW
The addressing mode for W coordinates outside [0, 1).
property AddressModeW: TSdlGpuSamplerAddressMode read GetAddressModeW write SetAddressModeW
Type: TSdlGpuSamplerAddressMode
AnisotropyEnabled
True to enable anisotropic filtering.
property AnisotropyEnabled: Boolean read FHandle.enable_anisotropy write FHandle.enable_anisotropy
Type: Boolean
CompareEnabled
True to enable comparison against a reference value during lookups.
property CompareEnabled: Boolean read FHandle.enable_compare write FHandle.enable_compare
Type: Boolean
CompareOp
The comparison operator to apply to fetched data before filtering.
property CompareOp: TSdlGpuCompareOp read GetCompareOp write SetCompareOp
Type: TSdlGpuCompareOp
MagFilter
The magnification filter to apply to lookups.
property MagFilter: TSdlGpuFilter read GetMagFilter write SetMagFilter
Type: TSdlGpuFilter
MaxAnisotropy
The anisotropy value clamp used by the sampler. If enable_anisotropy is false, this is ignored.
property MaxAnisotropy: Single read FHandle.max_anisotropy write FHandle.max_anisotropy
Type: Single
MaxLod
Clamps the maximum of the computed LOD value.
property MaxLod: Single read FHandle.max_lod write FHandle.max_lod
Type: Single
MinFilter
The minification filter to apply to lookups.
property MinFilter: TSdlGpuFilter read GetMinFilter write SetMinFilter
Type: TSdlGpuFilter
MinLod
Clamps the minimum of the computed LOD value.
property MinLod: Single read FHandle.min_lod write FHandle.min_lod
Type: Single
MipLodBias
The bias to be added to mipmap LOD calculation. Note that this is a no-op for the Metal driver. For Metal, LOD bias must be applied via shader instead.
property MipLodBias: Single read FHandle.mip_lod_bias write FHandle.mip_lod_bias
Type: Single
MipmapMode
The mipmap filter to apply to lookups.
property MipmapMode: TSdlGpuSamplerMipmapMode read GetMipmapMode write SetMipmapMode
Type: TSdlGpuSamplerMipmapMode
Props
A properties ID for extensions. Should be 0 if no extensions are needed.
property Props: TSdlProperties read GetProps write SetProps
Type: TSdlProperties
Method Descriptions
Create
Create with default values.
class function Create: TSdlGpuSamplerCreateInfo; inline; static
Returns
Init
Init with default values.
procedure Init; inline