Enum

VkSamplerAddressMode

Specify behavior of sampling with texture coordinates outside an image

Possible values of the VkSamplerCreateInfo::addressMode* parameters, corresponding to different wrapping operations used during sampling, are:

typedef enum VkSamplerAddressMode {
    VK_SAMPLER_ADDRESS_MODE_REPEAT = 0,
    VK_SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT = 1,
    VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE = 2,
    VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER = 3,
    // 
                value="4" reserved for VK_KHR_sampler_mirror_clamp_to_edge
                enum VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE; do not
                alias!
            
    // Provided by extensions
    VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE = 4,
    VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE_KHR = VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE,
} VkSamplerAddressMode;

pub struct SamplerAddressMode(u32);
impl SamplerAddressMode {
    pub const REPEAT: Self = 0;
    pub const MIRRORED_REPEAT: Self = 1;
    pub const CLAMP_TO_EDGE: Self = 2;
    pub const CLAMP_TO_BORDER: Self = 3;
    pub const MIRROR_CLAMP_TO_EDGE: Self = 4;
}

VK_SAMPLER_ADDRESS_MODE_REPEAT specifies that the repeat wrap mode will be used.
VK_SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT specifies that the mirrored repeat wrap mode will be used.
VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE specifies that the clamp to edge wrap mode will be used.
VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER specifies that the clamp to border wrap mode will be used.
VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE specifies that the mirror clamp to edge wrap mode will be used. This is only valid if the samplerMirrorClampToEdge feature is enabled, or if the VK_KHR_sampler_mirror_clamp_to_edge extension is enabled.

Parent

VK_VERSION_1_0

Type

Enum