VKSAMPLERCREATEINFO(3)

NAME
VkSamplerCreateInfo - Stub page (not yet written)

C SPECIFICATION

    typedef struct VkSamplerCreateInfo {
        VkStructureType         sType;
        const void*             pNext;
        VkSamplerCreateFlags    flags;
        VkFilter                magFilter;
        VkFilter                minFilter;
        VkSamplerMipmapMode     mipmapMode;
        VkSamplerAddressMode    addressModeU;
        VkSamplerAddressMode    addressModeV;
        VkSamplerAddressMode    addressModeW;
        float                   mipLodBias;
        VkBool32                anisotropyEnable;
        float                   maxAnisotropy;
        VkBool32                compareEnable;
        VkCompareOp             compareOp;
        float                   minLod;
        float                   maxLod;
        VkBorderColor           borderColor;
        VkBool32                unnormalizedCoordinates;
    } VkSamplerCreateInfo;

This is a stub page. Content has not been filled in yet. Khronos is aware of the problem and working on it as time allows; please do not file Github issues bringing the missing content to our attention.

FIELDS

DESCRIPTION

VALID USAGE

    • sType must be VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO

    • pNext must be NULL

    • flags must be 0

    • magFilter must be a valid VkFilter value

    • minFilter must be a valid VkFilter value

    • mipmapMode must be a valid VkSamplerMipmapMode value

    • addressModeU must be a valid VkSamplerAddressMode value

    • addressModeV must be a valid VkSamplerAddressMode value

    • addressModeW must be a valid VkSamplerAddressMode value

    • The absolute value of mipLodBias must be less than or equal to VkPhysicalDeviceLimits::maxSamplerLodBias

    • If the anisotropic sampling feature is not enabled, anisotropyEnable must be VK_FALSE

    • If anisotropyEnable is VK_TRUE, maxAnisotropy must be between 1.0 and VkPhysicalDeviceLimits::maxSamplerAnisotropy, inclusive

    • If unnormalizedCoordinates is VK_TRUE, minFilter and magFilter must be equal

    • If unnormalizedCoordinates is VK_TRUE, mipmapMode must be VK_SAMPLER_MIPMAP_MODE_NEAREST

    • If unnormalizedCoordinates is VK_TRUE, minLod and maxLod must be zero

    • If unnormalizedCoordinates is VK_TRUE, addressModeU and addressModeV must each be either VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE or VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER

    • If unnormalizedCoordinates is VK_TRUE, anisotropyEnable must be VK_FALSE

    • If unnormalizedCoordinates is VK_TRUE, compareEnable must be VK_FALSE

    • If any of addressModeU, addressModeV or addressModeW are VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER, borderColor must be a valid VkBorderColor value

    • If the VK_KHR_mirror_clamp_to_edge extension is not enabled, addressModeU, addressModeV and addressModeW must not be VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE

    • If compareEnable is VK_TRUE, compareOp must be a valid VkCompareOp value

SEE ALSO

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.