public Class EXTFullScreenExclusive

Extends VkResult.

The extension name.

The extension specification version.

VkFullScreenExclusiveEXT - Hint values an application can specify affecting full-screen transition behavior

Description

• FULL_SCREEN_EXCLUSIVE_DEFAULT_EXT indicates the implementation should determine the appropriate full-screen method by whatever means it deems appropriate.
• FULL_SCREEN_EXCLUSIVE_ALLOWED_EXT indicates the implementation may use full-screen exclusive mechanisms when available. Such mechanisms may result in better performance and/or the availability of different presentation capabilities, but may require a more disruptive transition during swapchain initialization, first presentation and/or destruction.
• FULL_SCREEN_EXCLUSIVE_DISALLOWED_EXT indicates the implementation should avoid using full-screen mechanisms which rely on disruptive transitions.
• FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT indicates the application will manage full-screen exclusive mode by using the AcquireFullScreenExclusiveModeEXT and ReleaseFullScreenExclusiveModeEXT commands.

See Also

VkSurfaceFullScreenExclusiveInfoEXT

VkFullScreenExclusiveEXT - Hint values an application can specify affecting full-screen transition behavior

Description

• FULL_SCREEN_EXCLUSIVE_DEFAULT_EXT indicates the implementation should determine the appropriate full-screen method by whatever means it deems appropriate.
• FULL_SCREEN_EXCLUSIVE_ALLOWED_EXT indicates the implementation may use full-screen exclusive mechanisms when available. Such mechanisms may result in better performance and/or the availability of different presentation capabilities, but may require a more disruptive transition during swapchain initialization, first presentation and/or destruction.
• FULL_SCREEN_EXCLUSIVE_DISALLOWED_EXT indicates the implementation should avoid using full-screen mechanisms which rely on disruptive transitions.
• FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT indicates the application will manage full-screen exclusive mode by using the AcquireFullScreenExclusiveModeEXT and ReleaseFullScreenExclusiveModeEXT commands.

See Also

VkSurfaceFullScreenExclusiveInfoEXT

VkFullScreenExclusiveEXT - Hint values an application can specify affecting full-screen transition behavior

Description

• FULL_SCREEN_EXCLUSIVE_DEFAULT_EXT indicates the implementation should determine the appropriate full-screen method by whatever means it deems appropriate.
• FULL_SCREEN_EXCLUSIVE_ALLOWED_EXT indicates the implementation may use full-screen exclusive mechanisms when available. Such mechanisms may result in better performance and/or the availability of different presentation capabilities, but may require a more disruptive transition during swapchain initialization, first presentation and/or destruction.
• FULL_SCREEN_EXCLUSIVE_DISALLOWED_EXT indicates the implementation should avoid using full-screen mechanisms which rely on disruptive transitions.
• FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT indicates the application will manage full-screen exclusive mode by using the AcquireFullScreenExclusiveModeEXT and ReleaseFullScreenExclusiveModeEXT commands.

See Also

VkSurfaceFullScreenExclusiveInfoEXT

VkFullScreenExclusiveEXT - Hint values an application can specify affecting full-screen transition behavior

Description

• FULL_SCREEN_EXCLUSIVE_DEFAULT_EXT indicates the implementation should determine the appropriate full-screen method by whatever means it deems appropriate.
• FULL_SCREEN_EXCLUSIVE_ALLOWED_EXT indicates the implementation may use full-screen exclusive mechanisms when available. Such mechanisms may result in better performance and/or the availability of different presentation capabilities, but may require a more disruptive transition during swapchain initialization, first presentation and/or destruction.
• FULL_SCREEN_EXCLUSIVE_DISALLOWED_EXT indicates the implementation should avoid using full-screen mechanisms which rely on disruptive transitions.
• FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT indicates the application will manage full-screen exclusive mode by using the AcquireFullScreenExclusiveModeEXT and ReleaseFullScreenExclusiveModeEXT commands.

See Also

VkSurfaceFullScreenExclusiveInfoEXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_SURFACE_FULL_SCREEN_EXCLUSIVE_INFO_EXT
• STRUCTURE_TYPE_SURFACE_CAPABILITIES_FULL_SCREEN_EXCLUSIVE_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_SURFACE_FULL_SCREEN_EXCLUSIVE_INFO_EXT
• STRUCTURE_TYPE_SURFACE_CAPABILITIES_FULL_SCREEN_EXCLUSIVE_EXT

Extends VkStructureType.

Unsafe version of: GetDeviceGroupSurfacePresentModes2EXT

Unsafe version of: GetPhysicalDeviceSurfacePresentModes2EXT

Parameters

pPresentModeCount:long

a pointer to an integer related to the number of presentation modes available or queried, as described below.

Acquire full-screen exclusive mode for a swapchain.

C Specification

To acquire exclusive full-screen access for a swapchain, call:

VkResult vkAcquireFullScreenExclusiveModeEXT(
    VkDevice                                    device,
    VkSwapchainKHR                              swapchain);

Valid Usage

• swapchain must not be in the retired state
• swapchain must be a swapchain created with a VkSurfaceFullScreenExclusiveInfoEXT structure, with fullScreenExclusive set to FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT
• swapchain must not currently have exclusive full-screen access

A return value of SUCCESS indicates that the swapchain successfully acquired exclusive full-screen access. The swapchain will retain this exclusivity until either the application releases exclusive full-screen access with ReleaseFullScreenExclusiveModeEXT, destroys the swapchain, or if any of the swapchain commands return ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT indicating that the mode was lost because of platform-specific changes.

If the swapchain was unable to acquire exclusive full-screen access to the display then ERROR_INITIALIZATION_FAILED is returned. An application can attempt to acquire exclusive full-screen access again for the same swapchain even if this command fails, or if ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT has been returned by a swapchain command.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• swapchain must be a valid VkSwapchainKHR handle
• swapchain must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED
• ERROR_SURFACE_LOST_KHR

Parameters

device:VkDevice

the device associated with swapchain.

swapchain:long

the swapchain to acquire exclusive full-screen access for.

Annotations

@NativeType:VkResult

Query device group present capabilities for a surface.

C Specification

Alternatively, to query the supported device group presentation modes for a surface combined with select other fixed swapchain creation parameters, call:

VkResult vkGetDeviceGroupSurfacePresentModes2EXT(
    VkDevice                                    device,
    const VkPhysicalDeviceSurfaceInfo2KHR*      pSurfaceInfo,
    VkDeviceGroupPresentModeFlagsKHR*           pModes);

Description

vkGetDeviceGroupSurfacePresentModes2EXT behaves similarly to GetDeviceGroupSurfacePresentModesKHR, with the ability to specify extended inputs via chained input structures.

Valid Usage

• pSurfaceInfo→surface must be supported by all physical devices associated with device, as reported by GetPhysicalDeviceSurfaceSupportKHR or an equivalent platform-specific mechanism

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pSurfaceInfo must be a valid pointer to a valid VkPhysicalDeviceSurfaceInfo2KHR structure
• pModes must be a valid pointer to a VkDeviceGroupPresentModeFlagsKHR value

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_SURFACE_LOST_KHR

See Also

VkPhysicalDeviceSurfaceInfo2KHR

Parameters

device:VkDevice

the logical device.

pSurfaceInfo:VkPhysicalDeviceSurfaceInfo2KHR

a pointer to a VkPhysicalDeviceSurfaceInfo2KHR structure describing the surface and other fixed parameters that would be consumed by CreateSwapchainKHR.

pModes:IntBuffer

a pointer to a VkDeviceGroupPresentModeFlagsKHR in which the supported device group present modes for the surface are returned.

Annotations

@NativeType:VkResult

Array version of: GetDeviceGroupSurfacePresentModes2EXT

Annotations

@NativeType:VkResult

Query supported presentation modes.

C Specification

Alternatively, to query the supported presentation modes for a surface combined with select other fixed swapchain creation parameters, call:

VkResult vkGetPhysicalDeviceSurfacePresentModes2EXT(
    VkPhysicalDevice                            physicalDevice,
    const VkPhysicalDeviceSurfaceInfo2KHR*      pSurfaceInfo,
    uint32_t*                                   pPresentModeCount,
    VkPresentModeKHR*                           pPresentModes);

Description

vkGetPhysicalDeviceSurfacePresentModes2EXT behaves similarly to GetPhysicalDeviceSurfacePresentModesKHR, with the ability to specify extended inputs via chained input structures.

Valid Usage

• If the VK_GOOGLE_surfaceless_query extension is not enabled, pSurfaceInfo→surface must be a valid VkSurfaceKHR handle
• If pSurfaceInfo→surface is not NULL_HANDLE, it must be supported by physicalDevice, as reported by GetPhysicalDeviceSurfaceSupportKHR or an equivalent platform-specific mechanism

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pSurfaceInfo must be a valid pointer to a valid VkPhysicalDeviceSurfaceInfo2KHR structure
• pPresentModeCount must be a valid pointer to a uint32_t value
• If the value referenced by pPresentModeCount is not 0, and pPresentModes is not NULL, pPresentModes must be a valid pointer to an array of pPresentModeCount VkPresentModeKHR values

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_SURFACE_LOST_KHR

See Also

VkPhysicalDeviceSurfaceInfo2KHR

Parameters

physicalDevice:VkPhysicalDevice

the physical device that will be associated with the swapchain to be created, as described for CreateSwapchainKHR.

pSurfaceInfo:VkPhysicalDeviceSurfaceInfo2KHR

a pointer to a VkPhysicalDeviceSurfaceInfo2KHR structure describing the surface and other fixed parameters that would be consumed by CreateSwapchainKHR.

pPresentModeCount:IntBuffer

a pointer to an integer related to the number of presentation modes available or queried, as described below.

pPresentModes:IntBuffer

either NULL or a pointer to an array of VkPresentModeKHR values, indicating the supported presentation modes.

Annotations

@NativeType:VkResult

Array version of: GetPhysicalDeviceSurfacePresentModes2EXT

Annotations

@NativeType:VkResult

Release full-screen exclusive mode from a swapchain.

C Specification

To release exclusive full-screen access from a swapchain, call:

VkResult vkReleaseFullScreenExclusiveModeEXT(
    VkDevice                                    device,
    VkSwapchainKHR                              swapchain);

Description

Valid Usage

• swapchain must not be in the retired state
• swapchain must be a swapchain created with a VkSurfaceFullScreenExclusiveInfoEXT structure, with fullScreenExclusive set to FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT

Parameters

device:VkDevice

the device associated with swapchain.

swapchain:long

the swapchain to release exclusive full-screen access from.

Annotations

@NativeType:VkResult