Vulkan.Extensions.VK_KHR_surface_protected_capabilities

Name

VK_KHR_surface_protected_capabilities - instance extension

VK_KHR_surface_protected_capabilities

Name String

VK_KHR_surface_protected_capabilities

Extension Type

Instance extension

Registered Extension Number

240

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.1
• Requires VK_KHR_get_surface_capabilities2

Contact

• Sandeep Shinde @sashinde%0A<<Here describe the issue or question you have about the VK_KHR_surface_protected_capabilities extension> >

Other Extension Metadata

Last Modified Date

2018-12-18

IP Status

No known IP claims.

Contributors

• Sandeep Shinde, NVIDIA
• James Jones, NVIDIA
• Daniel Koch, NVIDIA

Description

This extension extends SurfaceCapabilities2KHR, providing applications a way to query whether swapchains can be created with the SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag set.

Vulkan 1.1 added (optional) support for protect memory and protected resources including buffers (BUFFER_CREATE_PROTECTED_BIT), images (IMAGE_CREATE_PROTECTED_BIT), and swapchains (SWAPCHAIN_CREATE_PROTECTED_BIT_KHR). However, on implementations which support multiple windowing systems, not all window systems may be able to provide a protected display path.

This extension provides a way to query if a protected swapchain created for a surface (and thus a specific windowing system) can be displayed on screen. It extends the existing SurfaceCapabilities2KHR structure with a new SurfaceProtectedCapabilitiesKHR structure from which the application can obtain information about support for protected swapchain creation through getPhysicalDeviceSurfaceCapabilities2KHR.

New Structures

• Extending SurfaceCapabilities2KHR:

  • SurfaceProtectedCapabilitiesKHR

New Enum Constants

• KHR_SURFACE_PROTECTED_CAPABILITIES_EXTENSION_NAME

• KHR_SURFACE_PROTECTED_CAPABILITIES_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_SURFACE_PROTECTED_CAPABILITIES_KHR

Version History

• Revision 1, 2018-12-18 (Sandeep Shinde, Daniel Koch)

  • Internal revisions.

See Also

SurfaceProtectedCapabilitiesKHR

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

data SurfaceProtectedCapabilitiesKHR

VkSurfaceProtectedCapabilitiesKHR - Structure describing capability of a surface to be protected

Description

If the VK_GOOGLE_surfaceless_query extension is enabled, the value returned in supportsProtected will be identical for every valid surface created on this physical device, and so in the getPhysicalDeviceSurfaceCapabilities2KHR call, PhysicalDeviceSurfaceInfo2KHR::surface can be NULL_HANDLE. In that case, the contents of SurfaceCapabilities2KHR::surfaceCapabilities as well as any other struct chained to it will be undefined.

Valid Usage (Implicit)

See Also

VK_KHR_surface_protected_capabilities, Bool32, StructureType

Constructors

SurfaceProtectedCapabilitiesKHR

Fields

• supportsProtected :: Bool

  supportsProtected specifies whether a protected swapchain created from PhysicalDeviceSurfaceInfo2KHR::surface for a particular windowing system can be displayed on screen or not. If supportsProtected is TRUE, then creation of swapchains with the SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag set must be supported for surface.

Instances

Eq SurfaceProtectedCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_surface_protected_capabilities

Methods

(==) :: SurfaceProtectedCapabilitiesKHR -> SurfaceProtectedCapabilitiesKHR -> Bool

(/=) :: SurfaceProtectedCapabilitiesKHR -> SurfaceProtectedCapabilitiesKHR -> Bool

Show SurfaceProtectedCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_surface_protected_capabilities

Methods

showsPrec :: Int -> SurfaceProtectedCapabilitiesKHR -> ShowS

show :: SurfaceProtectedCapabilitiesKHR -> String

showList :: [SurfaceProtectedCapabilitiesKHR] -> ShowS

Storable SurfaceProtectedCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_surface_protected_capabilities

Methods

sizeOf :: SurfaceProtectedCapabilitiesKHR -> Int

alignment :: SurfaceProtectedCapabilitiesKHR -> Int

peekElemOff :: Ptr SurfaceProtectedCapabilitiesKHR -> Int -> IO SurfaceProtectedCapabilitiesKHR

pokeElemOff :: Ptr SurfaceProtectedCapabilitiesKHR -> Int -> SurfaceProtectedCapabilitiesKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO SurfaceProtectedCapabilitiesKHR

pokeByteOff :: Ptr b -> Int -> SurfaceProtectedCapabilitiesKHR -> IO ()

peek :: Ptr SurfaceProtectedCapabilitiesKHR -> IO SurfaceProtectedCapabilitiesKHR

poke :: Ptr SurfaceProtectedCapabilitiesKHR -> SurfaceProtectedCapabilitiesKHR -> IO ()

FromCStruct SurfaceProtectedCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_surface_protected_capabilities

Methods

peekCStruct :: Ptr SurfaceProtectedCapabilitiesKHR -> IO SurfaceProtectedCapabilitiesKHR

ToCStruct SurfaceProtectedCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_surface_protected_capabilities

Methods

withCStruct :: SurfaceProtectedCapabilitiesKHR -> (Ptr SurfaceProtectedCapabilitiesKHR -> IO b) -> IO b

pokeCStruct :: Ptr SurfaceProtectedCapabilitiesKHR -> SurfaceProtectedCapabilitiesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr SurfaceProtectedCapabilitiesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr SurfaceProtectedCapabilitiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SurfaceProtectedCapabilitiesKHR

Defined in Vulkan.Extensions.VK_KHR_surface_protected_capabilities

Methods

zero :: SurfaceProtectedCapabilitiesKHR

type KHR_SURFACE_PROTECTED_CAPABILITIES_SPEC_VERSION = 1

pattern KHR_SURFACE_PROTECTED_CAPABILITIES_SPEC_VERSION :: forall a. Integral a => a

type KHR_SURFACE_PROTECTED_CAPABILITIES_EXTENSION_NAME = "VK_KHR_surface_protected_capabilities"

pattern KHR_SURFACE_PROTECTED_CAPABILITIES_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a