C Specification

The XrSwapchainStateSamplerVulkanFB structure is defined as:

// Provided by XR_FB_swapchain_update_state_vulkan
typedef struct XrSwapchainStateSamplerVulkanFB {
    XrStructureType         type;
    void*                   next;
    VkFilter                minFilter;
    VkFilter                magFilter;
    VkSamplerMipmapMode     mipmapMode;
    VkSamplerAddressMode    wrapModeS;
    VkSamplerAddressMode    wrapModeT;
    VkComponentSwizzle      swizzleRed;
    VkComponentSwizzle      swizzleGreen;
    VkComponentSwizzle      swizzleBlue;
    VkComponentSwizzle      swizzleAlpha;
    float                   maxAnisotropy;
    XrColor4f               borderColor;
} XrSwapchainStateSamplerVulkanFB;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

  • minFilter is a valid Vulkan VkFilter.

  • magFilter is a valid Vulkan VkFilter.

  • mipmapMode is a valid Vulkan VkSamplerMipmapMode.

  • wrapModeS is a valid Vulkan VkSamplerAddressMode.

  • wrapModeT is a valid Vulkan VkSamplerAddressMode.

  • swizzleRed is a valid Vulkan VkComponentSwizzle.

  • swizzleGreen is a valid Vulkan VkComponentSwizzle.

  • swizzleBlue is a valid Vulkan VkComponentSwizzle.

  • swizzleAlpha is a valid Vulkan VkComponentSwizzle.

  • maxAnisotropy is a valid float used to represent max anisotropy.

  • borderColor is an RGBA color to be used as border texels.

Description

When XrSwapchainStateSamplerVulkanFB is specified in the call to xrUpdateSwapchainFB, texture sampler state for all images in the XrSwapchain will be updated for the compositor process. For most cases, the sampler state update is only required compositor-side, as that is where the swapchain images are sampled. If the application requires sampling of the swapchain images, the application will be responsible for updating the texture state using normal Vulkan mechanisms and synchronizing appropriately with application-side rendering.

When XrSwapchainStateSamplerVulkanFB is specified in the call to xrGetSwapchainStateFB, the sampler state will be populated with the current swapchain sampler state.

To use XrSwapchainStateSamplerVulkanFB, XR_USE_GRAPHICS_API_VULKAN must be defined before including openxr_platform.h.

Valid Usage (Implicit)

  • The XR_FB_swapchain_update_state_vulkan extension must be enabled prior to using XrSwapchainStateSamplerVulkanFB

  • type must be XR_TYPE_SWAPCHAIN_STATE_SAMPLER_VULKAN_FB

  • next must be NULL or a valid pointer to the next structure in a structure chain

  • minFilter must be a valid VkFilter value

  • magFilter must be a valid VkFilter value

  • mipmapMode must be a valid VkSamplerMipmapMode value

  • wrapModeS must be a valid VkSamplerAddressMode value

  • wrapModeT must be a valid VkSamplerAddressMode value

  • swizzleRed must be a valid VkComponentSwizzle value

  • swizzleGreen must be a valid VkComponentSwizzle value

  • swizzleBlue must be a valid VkComponentSwizzle value

  • swizzleAlpha must be a valid VkComponentSwizzle value

See Also

XR_FB_swapchain_update_state_vulkan, XrColor4f, XrStructureType, xrGetSwapchainStateFB, xrUpdateSwapchainFB

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2024, The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.