vkRegisterCustomBorderColorEXT

To register a custom border color, call:

VkResult vkRegisterCustomBorderColorEXT(
    VkDevice                                            device,
    const VkSamplerCustomBorderColorCreateInfoEXT*      pBorderColor,
    VkBool32                                            requestIndex,
    uint32_t*                                           pIndex);

pub fn register_custom_border_color_ext(
    device: vk::Device,
    p_border_color: *const vk::SamplerCustomBorderColorCreateInfoEXT,
    request_index: vk::Bool32,
    p_index: *mut u32,
) -> vk::Result;

• device is the logical device where the border color is registered.
• pBorderColor is a pointer to a VkSamplerCustomBorderColorCreateInfoEXT structure specifying the custom border color value to register.
• requestIndex is a Boolean value indicating if a specific index is requested or not.
• pIndex is a pointer to a uint32_t index value that will be written by the command upon success.

If requestIndex is VK_TRUE, the value present in pIndex when passed to the command is a requested index, and rather than returning a new index, the implementation will attempt to register that index, leaving the value intact. If the implementation is unable to register a requested index, VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS will be returned. If an index has not been registered (either explicitly or implicitly by creating a sampler object), or if it has been subsequently unregistered, the implementation must register that index successfully.

If requestIndex is VK_FALSE, the value stored in pIndex is ignored, and a new index will be returned if the implementation is able to register a new index. If the implementation is unable to register a new index, VK_ERROR_TOO_MANY_OBJECTS will be returned.

If an index is successfully registered, it can be used when writing a sampler descriptor or creating a sampler object to use with the custom border color, via VkSamplerCustomBorderColorIndexCreateInfoEXT.