Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_AMD_memory_overallocation_behavior

Description

Name

VK_AMD_memory_overallocation_behavior - device extension

VK_AMD_memory_overallocation_behavior

Name String: VK_AMD_memory_overallocation_behavior

Extension Type

Device extension

Registered Extension Number

190

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

None

Contact

Martin Dinkov @mdinkov%0A*Here describe the issue or question you have about the VK_AMD_memory_overallocation_behavior extension*

Other Extension Metadata

Last Modified Date: 2018-09-19

IP Status

No known IP claims.

Contributors

Martin Dinkov, AMD
Matthaeus Chajdas, AMD
Daniel Rakos, AMD
Jon Campbell, AMD

Description

This extension allows controlling whether explicit overallocation beyond the device memory heap sizes (reported by PhysicalDeviceMemoryProperties) is allowed or not. Overallocation may lead to performance loss and is not supported for all platforms.

New Structures

Extending DeviceCreateInfo:
- DeviceMemoryOverallocationCreateInfoAMD

New Enums

MemoryOverallocationBehaviorAMD

New Enum Constants

AMD_MEMORY_OVERALLOCATION_BEHAVIOR_EXTENSION_NAME

Version History

Revision 1, 2018-09-19 (Martin Dinkov)
- Initial draft.

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

data DeviceMemoryOverallocationCreateInfoAMD = DeviceMemoryOverallocationCreateInfoAMD {
- overallocationBehavior :: MemoryOverallocationBehaviorAMD
}
newtype MemoryOverallocationBehaviorAMD where
type AMD_MEMORY_OVERALLOCATION_BEHAVIOR_SPEC_VERSION = 1
pattern AMD_MEMORY_OVERALLOCATION_BEHAVIOR_SPEC_VERSION :: Integral a => a
type AMD_MEMORY_OVERALLOCATION_BEHAVIOR_EXTENSION_NAME = "VK_AMD_memory_overallocation_behavior"
pattern AMD_MEMORY_OVERALLOCATION_BEHAVIOR_EXTENSION_NAME :: (Eq a, IsString a) => a

Documentation

data DeviceMemoryOverallocationCreateInfoAMD Source #

VkDeviceMemoryOverallocationCreateInfoAMD - Specify memory overallocation behavior for a Vulkan device

Valid Usage (Implicit)

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

newtype MemoryOverallocationBehaviorAMD Source #

VkMemoryOverallocationBehaviorAMD - Specify memory overallocation behavior

Description

MEMORY_OVERALLOCATION_BEHAVIOR_DEFAULT_AMD lets the implementation decide if overallocation is allowed.

MEMORY_OVERALLOCATION_BEHAVIOR_ALLOWED_AMD specifies overallocation is allowed if platform permits.
MEMORY_OVERALLOCATION_BEHAVIOR_DISALLOWED_AMD specifies the application is not allowed to allocate device memory beyond the heap sizes reported by PhysicalDeviceMemoryProperties. Allocations that are not explicitly made by the application within the scope of the Vulkan instance are not accounted for.

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

type AMD_MEMORY_OVERALLOCATION_BEHAVIOR_SPEC_VERSION = 1 Source #

pattern AMD_MEMORY_OVERALLOCATION_BEHAVIOR_SPEC_VERSION :: Integral a => a Source #

type AMD_MEMORY_OVERALLOCATION_BEHAVIOR_EXTENSION_NAME = "VK_AMD_memory_overallocation_behavior" Source #

pattern AMD_MEMORY_OVERALLOCATION_BEHAVIOR_EXTENSION_NAME :: (Eq a, IsString a) => a Source #

Name

VK_AMD_memory_overallocation_behavior

Other Extension Metadata

Description

New Structures

New Enums

New Enum Constants

Version History

See Also

Document Notes

Documentation

Valid Usage (Implicit)

See Also

Instances

Description

See Also

Instances

DeviceMemoryOverallocationCreateInfoAMD
Fields overallocationBehavior :: MemoryOverallocationBehaviorAMD `overallocationBehavior` is the desired overallocation behavior. `overallocationBehavior` must be a valid `MemoryOverallocationBehaviorAMD` value

pattern MEMORY_OVERALLOCATION_BEHAVIOR_DEFAULT_AMD :: MemoryOverallocationBehaviorAMD
pattern MEMORY_OVERALLOCATION_BEHAVIOR_ALLOWED_AMD :: MemoryOverallocationBehaviorAMD
pattern MEMORY_OVERALLOCATION_BEHAVIOR_DISALLOWED_AMD :: MemoryOverallocationBehaviorAMD