Modulevulkan-3.27GHC2021

Vulkan.Extensions.VK_AMD_anti_lag

Name

VK_AMD_anti_lag - device extension

VK_AMD_anti_lag

Name String: VK_AMD_anti_lag

Extension Type

Device extension

Registered Extension Number

477

Revision

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2

Vulkan Version 1.1

Contact

Stu Smith

Extension Proposal

VK_AMD_anti_lag

Other Extension Metadata

Last Modified Date: 2024-06-06

IP Status

No known IP claims.

Contributors

Tobias Hector, AMD
Stuart Smith, AMD
Arkadiusz Sarwa, AMD

Description

This extension automatically paces the CPU to make sure it does not get too far ahead of the GPU, reducing the latency between inputs received and updates on the screen. Additionally, Anti-Lag+ offers applications the ability to inform the driver when input processing begins, in order to align the timing of display updates, enabling even lower latency between receiving input and displaying on the screen.

Version History

Revision 1, 2024-06-06 (Arkadiusz Sarw)
- Initial version

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.

7 types
1 value

Packagevulkan-3.27
Exports15
LanguageGHC2021
LicenceBSD-3-Clause
SourceVK_AMD_anti_lag.hs

valueantiLagUpdateAMD

:: MonadIO io
=> Device
device is the logical device
-> AntiLagDataAMD
pData is a pointer to a AntiLagDataAMD structure containing latency reduction parameters.
-> io ()

vkAntiLagUpdateAMD - Provide information to reduce latency

Description

This command should be executed immediately before the application processes user input. If pData is not NULL and AntiLagDataAMD::pPresentationInfo is not NULL, this command should be executed again before queuePresentKHR, with pPresentationInfo set to matching values.

Valid Usage

The antiLag feature must be enabled

Valid Usage (Implicit)

device must be a valid Device handle

pData must be a valid pointer to a valid AntiLagDataAMD structure

Members

This structure describes the following feature:

Description

If the PhysicalDeviceAntiLagFeaturesAMD structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceAntiLagFeaturesAMD, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

Constructors

PhysicalDeviceAntiLagFeaturesAMD
- antiLag :: Bool
  antiLag indicates whether the implementation supports AMD Radeon™ Anti-Lag functionality. The antiLag feature only supports a single GPU and must not be enabled if DeviceGroupDeviceCreateInfo::physicalDeviceCount is greater than 1.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq PhysicalDeviceAntiLagFeaturesAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Show PhysicalDeviceAntiLagFeaturesAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Storable PhysicalDeviceAntiLagFeaturesAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
FromCStruct PhysicalDeviceAntiLagFeaturesAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
ToCStruct PhysicalDeviceAntiLagFeaturesAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Zero PhysicalDeviceAntiLagFeaturesAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag

datadata AntiLagDataAMD

VkAntiLagDataAMD - Structure specifying the parameters for vkAntiLagUpdateAMD

Description

This structure specifies anti-lag parameters.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_ANTI_LAG_DATA_AMD

mode must be a valid AntiLagModeAMD value
If pPresentationInfo is not NULL, pPresentationInfo must be a valid pointer to a valid AntiLagPresentationInfoAMD structure

Constructors

AntiLagDataAMD
- mode :: AntiLagModeAMD
  mode is a AntiLagModeAMD value specifying the anti-lag status.
- maxFPS :: Word32
  maxFPS is the framerate limit, in frames per second, used by the application. This limit will be imposed if anti-lag is enabled. If the application tries to render faster, the framerate will be reduced to match this limit. A value of 0 will disable the limit.
- presentationInfo :: Maybe AntiLagPresentationInfoAMD
  pPresentationInfo is a pointer to a AntiLagPresentationInfoAMD structure containing information about the application stage.

Instances4Show, FromCStruct, ToCStruct, Zero

Show AntiLagDataAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
FromCStruct AntiLagDataAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
ToCStruct AntiLagDataAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Zero AntiLagDataAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag

datadata AntiLagPresentationInfoAMD

VkAntiLagPresentationInfoAMD - Structure specifying information about stage

Description

This structure specifies information about the presentation stage for which anti-lag parameters are being set.

Valid Usage (Implicit)

Constructors

AntiLagPresentationInfoAMD
- stage :: AntiLagStageAMD
  stage is a AntiLagStageAMD value specifying the current application stage.
  stage must be a valid AntiLagStageAMD value
- frameIndex :: Word64
  frameIndex is set just before the application processes input data (ANTI_LAG_STAGE_INPUT_AMD). The same frameIndex value should be set before the frame with current input data will be presented by queuePresentKHR (ANTI_LAG_STAGE_PRESENT_AMD). This should be done for each frame.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq AntiLagPresentationInfoAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Show AntiLagPresentationInfoAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Storable AntiLagPresentationInfoAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
FromCStruct AntiLagPresentationInfoAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
ToCStruct AntiLagPresentationInfoAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Zero AntiLagPresentationInfoAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag

newtypenewtype AntiLagModeAMD

VkAntiLagModeAMD - Set the status of the anti-lag feature

Description

ANTI_LAG_MODE_DRIVER_CONTROL_AMD specifies that anti-lag will be enabled or disabled depending on driver settings.

ANTI_LAG_MODE_ON_AMD specifies that anti-lag will be enabled.
ANTI_LAG_MODE_OFF_AMD specifies that anti-lag will be disabled.

Constructors

AntiLagModeAMD Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq AntiLagModeAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Ord AntiLagModeAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Read AntiLagModeAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Show AntiLagModeAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Storable AntiLagModeAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Zero AntiLagModeAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag

patternpattern ANTI_LAG_MODE_DRIVER_CONTROL_AMD :: AntiLagModeAMD

patternpattern ANTI_LAG_MODE_ON_AMD :: AntiLagModeAMD

patternpattern ANTI_LAG_MODE_OFF_AMD :: AntiLagModeAMD

newtypenewtype AntiLagStageAMD

VkAntiLagStageAMD - Report the application stage

Description

ANTI_LAG_STAGE_INPUT_AMD specifies the stage before processing input.

ANTI_LAG_STAGE_PRESENT_AMD specifies the stage before queuePresentKHR.

Constructors

AntiLagStageAMD Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq AntiLagStageAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Ord AntiLagStageAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Read AntiLagStageAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Show AntiLagStageAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Storable AntiLagStageAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag
Zero AntiLagStageAMDDefined in vulkan-3.27 · Vulkan.Extensions.VK_AMD_anti_lag

patternpattern ANTI_LAG_STAGE_INPUT_AMD :: AntiLagStageAMD

patternpattern ANTI_LAG_STAGE_PRESENT_AMD :: AntiLagStageAMD

typetype AMD_ANTI_LAG_SPEC_VERSION = 1

patternpattern AMD_ANTI_LAG_SPEC_VERSION :: Integral a => a

typetype AMD_ANTI_LAG_EXTENSION_NAME = "VK_AMD_anti_lag"

patternpattern AMD_ANTI_LAG_EXTENSION_NAME :: (Eq a, IsString a) => a

Vulkan.Extensions.VK_AMD_anti_lag

Name

VK_AMD_anti_lag

Other Extension Metadata

Description

New Commands

New Structures

New Enums

New Enum Constants

Version History

See Also

Document Notes

Description

Valid Usage

Valid Usage (Implicit)

See Also

Members

Description

Structure Chaining

See Also

Constructors

Description

Valid Usage (Implicit)

See Also

Constructors

Description

Valid Usage (Implicit)

See Also

Constructors

Description

See Also

Constructors

Description

See Also

Constructors