Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_AMD_anti_lag

Description

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

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or 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.

New Commands

antiLagUpdateAMD

New Structures

AntiLagDataAMD

AntiLagPresentationInfoAMD
Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceAntiLagFeaturesAMD

New Enums

AntiLagModeAMD

AntiLagStageAMD

New Enum Constants

AMD_ANTI_LAG_EXTENSION_NAME

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.

Synopsis

antiLagUpdateAMD :: MonadIO io => Device -> AntiLagDataAMD -> io ()
data PhysicalDeviceAntiLagFeaturesAMD = PhysicalDeviceAntiLagFeaturesAMD {
- antiLag :: Bool
}
data AntiLagDataAMD = AntiLagDataAMD {
- mode :: AntiLagModeAMD
- maxFPS :: Word32
- presentationInfo :: Maybe AntiLagPresentationInfoAMD
}
data AntiLagPresentationInfoAMD = AntiLagPresentationInfoAMD {
- stage :: AntiLagStageAMD
- frameIndex :: Word64
}
newtype AntiLagModeAMD where
- AntiLagModeAMD Int32
- pattern ANTI_LAG_MODE_DRIVER_CONTROL_AMD :: AntiLagModeAMD
- pattern ANTI_LAG_MODE_ON_AMD :: AntiLagModeAMD
- pattern ANTI_LAG_MODE_OFF_AMD :: AntiLagModeAMD
newtype AntiLagStageAMD where
- AntiLagStageAMD Int32
- pattern ANTI_LAG_STAGE_INPUT_AMD :: AntiLagStageAMD
- pattern ANTI_LAG_STAGE_PRESENT_AMD :: AntiLagStageAMD
type AMD_ANTI_LAG_SPEC_VERSION = 1
pattern AMD_ANTI_LAG_SPEC_VERSION :: Integral a => a
type AMD_ANTI_LAG_EXTENSION_NAME = "VK_AMD_anti_lag"
pattern AMD_ANTI_LAG_EXTENSION_NAME :: (Eq a, IsString a) => a

Documentation

antiLagUpdateAMD Source #

Arguments

:: 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.

Valid Usage (Implicit)

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

Description

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

Valid Usage (Implicit)

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.

Description

ANTI_LAG_STAGE_INPUT_AMD specifies the stage before processing input.

ANTI_LAG_STAGE_PRESENT_AMD specifies the stage before queuePresentKHR.

Eq PhysicalDeviceAntiLagFeaturesAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods (==) :: PhysicalDeviceAntiLagFeaturesAMD -> PhysicalDeviceAntiLagFeaturesAMD -> Bool # (/=) :: PhysicalDeviceAntiLagFeaturesAMD -> PhysicalDeviceAntiLagFeaturesAMD -> Bool #
Storable PhysicalDeviceAntiLagFeaturesAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods sizeOf :: PhysicalDeviceAntiLagFeaturesAMD -> Int # alignment :: PhysicalDeviceAntiLagFeaturesAMD -> Int # peekElemOff :: Ptr PhysicalDeviceAntiLagFeaturesAMD -> Int -> IO PhysicalDeviceAntiLagFeaturesAMD # pokeElemOff :: Ptr PhysicalDeviceAntiLagFeaturesAMD -> Int -> PhysicalDeviceAntiLagFeaturesAMD -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceAntiLagFeaturesAMD # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceAntiLagFeaturesAMD -> IO () # peek :: Ptr PhysicalDeviceAntiLagFeaturesAMD -> IO PhysicalDeviceAntiLagFeaturesAMD # poke :: Ptr PhysicalDeviceAntiLagFeaturesAMD -> PhysicalDeviceAntiLagFeaturesAMD -> IO () #
Show PhysicalDeviceAntiLagFeaturesAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods showsPrec :: Int -> PhysicalDeviceAntiLagFeaturesAMD -> ShowS # show :: PhysicalDeviceAntiLagFeaturesAMD -> String # showList :: [PhysicalDeviceAntiLagFeaturesAMD] -> ShowS #
FromCStruct PhysicalDeviceAntiLagFeaturesAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods peekCStruct :: Ptr PhysicalDeviceAntiLagFeaturesAMD -> IO PhysicalDeviceAntiLagFeaturesAMD Source #
ToCStruct PhysicalDeviceAntiLagFeaturesAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods withCStruct :: PhysicalDeviceAntiLagFeaturesAMD -> (Ptr PhysicalDeviceAntiLagFeaturesAMD -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceAntiLagFeaturesAMD -> PhysicalDeviceAntiLagFeaturesAMD -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceAntiLagFeaturesAMD -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceAntiLagFeaturesAMD -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceAntiLagFeaturesAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods zero :: PhysicalDeviceAntiLagFeaturesAMD Source #

Show AntiLagDataAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods showsPrec :: Int -> AntiLagDataAMD -> ShowS # show :: AntiLagDataAMD -> String # showList :: [AntiLagDataAMD] -> ShowS #
FromCStruct AntiLagDataAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods peekCStruct :: Ptr AntiLagDataAMD -> IO AntiLagDataAMD Source #
ToCStruct AntiLagDataAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods withCStruct :: AntiLagDataAMD -> (Ptr AntiLagDataAMD -> IO b) -> IO b Source # pokeCStruct :: Ptr AntiLagDataAMD -> AntiLagDataAMD -> IO b -> IO b Source # withZeroCStruct :: (Ptr AntiLagDataAMD -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr AntiLagDataAMD -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero AntiLagDataAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods zero :: AntiLagDataAMD Source #

Eq AntiLagPresentationInfoAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods (==) :: AntiLagPresentationInfoAMD -> AntiLagPresentationInfoAMD -> Bool # (/=) :: AntiLagPresentationInfoAMD -> AntiLagPresentationInfoAMD -> Bool #
Storable AntiLagPresentationInfoAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods sizeOf :: AntiLagPresentationInfoAMD -> Int # alignment :: AntiLagPresentationInfoAMD -> Int # peekElemOff :: Ptr AntiLagPresentationInfoAMD -> Int -> IO AntiLagPresentationInfoAMD # pokeElemOff :: Ptr AntiLagPresentationInfoAMD -> Int -> AntiLagPresentationInfoAMD -> IO () # peekByteOff :: Ptr b -> Int -> IO AntiLagPresentationInfoAMD # pokeByteOff :: Ptr b -> Int -> AntiLagPresentationInfoAMD -> IO () # peek :: Ptr AntiLagPresentationInfoAMD -> IO AntiLagPresentationInfoAMD # poke :: Ptr AntiLagPresentationInfoAMD -> AntiLagPresentationInfoAMD -> IO () #
Show AntiLagPresentationInfoAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods showsPrec :: Int -> AntiLagPresentationInfoAMD -> ShowS # show :: AntiLagPresentationInfoAMD -> String # showList :: [AntiLagPresentationInfoAMD] -> ShowS #
FromCStruct AntiLagPresentationInfoAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods peekCStruct :: Ptr AntiLagPresentationInfoAMD -> IO AntiLagPresentationInfoAMD Source #
ToCStruct AntiLagPresentationInfoAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods withCStruct :: AntiLagPresentationInfoAMD -> (Ptr AntiLagPresentationInfoAMD -> IO b) -> IO b Source # pokeCStruct :: Ptr AntiLagPresentationInfoAMD -> AntiLagPresentationInfoAMD -> IO b -> IO b Source # withZeroCStruct :: (Ptr AntiLagPresentationInfoAMD -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr AntiLagPresentationInfoAMD -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero AntiLagPresentationInfoAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods zero :: AntiLagPresentationInfoAMD Source #

Eq AntiLagModeAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods (==) :: AntiLagModeAMD -> AntiLagModeAMD -> Bool # (/=) :: AntiLagModeAMD -> AntiLagModeAMD -> Bool #
Ord AntiLagModeAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods compare :: AntiLagModeAMD -> AntiLagModeAMD -> Ordering # (<) :: AntiLagModeAMD -> AntiLagModeAMD -> Bool # (<=) :: AntiLagModeAMD -> AntiLagModeAMD -> Bool # (>) :: AntiLagModeAMD -> AntiLagModeAMD -> Bool # (>=) :: AntiLagModeAMD -> AntiLagModeAMD -> Bool # max :: AntiLagModeAMD -> AntiLagModeAMD -> AntiLagModeAMD # min :: AntiLagModeAMD -> AntiLagModeAMD -> AntiLagModeAMD #
Storable AntiLagModeAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods sizeOf :: AntiLagModeAMD -> Int # alignment :: AntiLagModeAMD -> Int # peekElemOff :: Ptr AntiLagModeAMD -> Int -> IO AntiLagModeAMD # pokeElemOff :: Ptr AntiLagModeAMD -> Int -> AntiLagModeAMD -> IO () # peekByteOff :: Ptr b -> Int -> IO AntiLagModeAMD # pokeByteOff :: Ptr b -> Int -> AntiLagModeAMD -> IO () # peek :: Ptr AntiLagModeAMD -> IO AntiLagModeAMD # poke :: Ptr AntiLagModeAMD -> AntiLagModeAMD -> IO () #
Read AntiLagModeAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods readsPrec :: Int -> ReadS AntiLagModeAMD # readList :: ReadS [AntiLagModeAMD] # readPrec :: ReadPrec AntiLagModeAMD # readListPrec :: ReadPrec [AntiLagModeAMD] #
Show AntiLagModeAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods showsPrec :: Int -> AntiLagModeAMD -> ShowS # show :: AntiLagModeAMD -> String # showList :: [AntiLagModeAMD] -> ShowS #
Zero AntiLagModeAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods zero :: AntiLagModeAMD Source #

Eq AntiLagStageAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods (==) :: AntiLagStageAMD -> AntiLagStageAMD -> Bool # (/=) :: AntiLagStageAMD -> AntiLagStageAMD -> Bool #
Ord AntiLagStageAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods compare :: AntiLagStageAMD -> AntiLagStageAMD -> Ordering # (<) :: AntiLagStageAMD -> AntiLagStageAMD -> Bool # (<=) :: AntiLagStageAMD -> AntiLagStageAMD -> Bool # (>) :: AntiLagStageAMD -> AntiLagStageAMD -> Bool # (>=) :: AntiLagStageAMD -> AntiLagStageAMD -> Bool # max :: AntiLagStageAMD -> AntiLagStageAMD -> AntiLagStageAMD # min :: AntiLagStageAMD -> AntiLagStageAMD -> AntiLagStageAMD #
Storable AntiLagStageAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods sizeOf :: AntiLagStageAMD -> Int # alignment :: AntiLagStageAMD -> Int # peekElemOff :: Ptr AntiLagStageAMD -> Int -> IO AntiLagStageAMD # pokeElemOff :: Ptr AntiLagStageAMD -> Int -> AntiLagStageAMD -> IO () # peekByteOff :: Ptr b -> Int -> IO AntiLagStageAMD # pokeByteOff :: Ptr b -> Int -> AntiLagStageAMD -> IO () # peek :: Ptr AntiLagStageAMD -> IO AntiLagStageAMD # poke :: Ptr AntiLagStageAMD -> AntiLagStageAMD -> IO () #
Read AntiLagStageAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods readsPrec :: Int -> ReadS AntiLagStageAMD # readList :: ReadS [AntiLagStageAMD] # readPrec :: ReadPrec AntiLagStageAMD # readListPrec :: ReadPrec [AntiLagStageAMD] #
Show AntiLagStageAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods showsPrec :: Int -> AntiLagStageAMD -> ShowS # show :: AntiLagStageAMD -> String # showList :: [AntiLagStageAMD] -> ShowS #
Zero AntiLagStageAMD Source #
Instance details Defined in Vulkan.Extensions.VK_AMD_anti_lag Methods zero :: AntiLagStageAMD Source #

Name

VK_AMD_anti_lag

Other Extension Metadata

Description

New Commands

New Structures

New Enums

New Enum Constants

Version History

See Also

Document Notes

Documentation

Description

Valid Usage

Valid Usage (Implicit)

See Also

Members

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Description

See Also

Instances

Description

See Also

Instances

PhysicalDeviceAntiLagFeaturesAMD
Fields 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.

pattern ANTI_LAG_MODE_DRIVER_CONTROL_AMD :: AntiLagModeAMD
pattern ANTI_LAG_MODE_ON_AMD :: AntiLagModeAMD
pattern ANTI_LAG_MODE_OFF_AMD :: AntiLagModeAMD

pattern ANTI_LAG_STAGE_INPUT_AMD :: AntiLagStageAMD
pattern ANTI_LAG_STAGE_PRESENT_AMD :: AntiLagStageAMD