TextureFilter.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using SiliconStudio.Core;

namespace SiliconStudio.Paradox.Graphics
{
    /// <summary>   
    /// Filtering options during texture sampling.  
    /// </summary>  
    /// <remarks>   
    /// During texture sampling, one or more texels are read and combined (this is calling filtering) to produce a single value. Point sampling reads a single texel while linear sampling reads two texels (endpoints) and linearly interpolates a third value between the endpoints. HLSL texture-sampling functions also support comparison filtering during texture sampling. Comparison filtering compares each sampled texel against a comparison value. The boolean result is blended the same way that normal texture filtering is blended. You can use HLSL intrinsic texture-sampling functions that implement texture filtering only or companion functions that use texture filtering with comparison filtering.  Texture Sampling FunctionTexture Sampling Function with Comparison Filtering samplesamplecmp or samplecmplevelzero  ? Comparison filters only work with textures that have the following DXGI formats: R32_FLOAT_X8X24_TYPELESS, R32_FLOAT, R24_UNORM_X8_TYPELESS, R16_UNORM.     
    /// </remarks>
    [DataContract("TextureFilter")]
    public enum TextureFilter
    {
        /// <summary>   
        /// Use point sampling for minification, magnification, and mip-level sampling.     
        /// </summary>  
        Point = 0,

        /// <summary>   
        /// Use point sampling for minification and magnification; use linear interpolation for mip-level sampling.     
        /// </summary>  
        MinMagPointMipLinear = 1,

        /// <summary>   
        /// Use point sampling for minification; use linear interpolation for magnification; use point sampling for mip-level sampling.     
        /// </summary>  
        MinPointMagLinearMipPoint = 4,

        /// <summary>   
        /// Use point sampling for minification; use linear interpolation for magnification and mip-level sampling.     
        /// </summary>  
        MinPointMagMipLinear = 5,

        /// <summary>   
        /// Use linear interpolation for minification; use point sampling for magnification and mip-level sampling.     
        /// </summary>  
        MinLinearMagMipPoint = 16,

        /// <summary>   
        /// Use linear interpolation for minification; use point sampling for magnification; use linear interpolation for mip-level sampling.   
        /// </summary>  
        MinLinearMagPointMipLinear = 17,

        /// <summary>   
        /// Use linear interpolation for minification and magnification; use point sampling for mip-level sampling.     
        /// </summary>  
        MinMagLinearMipPoint = 20,

        /// <summary>   
        /// Use linear interpolation for minification, magnification, and mip-level sampling.   
        /// </summary>  
        Linear = 21,

        /// <summary>   
        /// Use anisotropic interpolation for minification, magnification, and mip-level sampling.  
        /// </summary>  
        Anisotropic = 85,

        /// <summary>   
        /// Use point sampling for minification, magnification, and mip-level sampling. Compare the result to the comparison value.     
        /// </summary>  
        ComparisonPoint = 128,

        /// <summary>   
        /// Use point sampling for minification and magnification; use linear interpolation for mip-level sampling. Compare the result to the comparison value.     
        /// </summary>  
        ComparisonMinMagPointMipLinear = 129,

        /// <summary>   
        /// Use point sampling for minification; use linear interpolation for magnification; use point sampling for mip-level sampling. Compare the result to the comparison value.     
        /// </summary>  
        ComparisonMinPointMagLinearMipPoint = 132,

        /// <summary>   
        /// Use point sampling for minification; use linear interpolation for magnification and mip-level sampling. Compare the result to the comparison value.     
        /// </summary>  
        ComparisonMinPointMagMipLinear = 133,

        /// <summary>   
        /// Use linear interpolation for minification; use point sampling for magnification and mip-level sampling. Compare the result to the comparison value.     
        /// </summary>  
        ComparisonMinLinearMagMipPoint = 144,

        /// <summary>   
        /// Use linear interpolation for minification; use point sampling for magnification; use linear interpolation for mip-level sampling. Compare the result to the comparison value.   
        /// </summary>  
        ComparisonMinLinearMagPointMipLinear = 145,

        /// <summary>   
        /// Use linear interpolation for minification and magnification; use point sampling for mip-level sampling. Compare the result to the comparison value.     
        /// </summary>  
        ComparisonMinMagLinearMipPoint = 148,

        /// <summary>   
        /// Use linear interpolation for minification, magnification, and mip-level sampling. Compare the result to the comparison value.   
        /// </summary>  
        ComparisonLinear = 149,

        /// <summary>   
        /// Use anisotropic interpolation for minification, magnification, and mip-level sampling. Compare the result to the comparison value.  
        /// </summary>  
        ComparisonAnisotropic = 213,
    }
}