Vulkan.Extensions.VK_AMD_memory_overallocation_behavior

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

Extension and Version Dependencies

• Requires Vulkan 1.0

Contact

• Martin Dinkov https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_AMD_memory_overallocation_behavior:%20&body=@mdinkov%20

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

• AMD_MEMORY_OVERALLOCATION_BEHAVIOR_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_DEVICE_MEMORY_OVERALLOCATION_CREATE_INFO_AMD

Version History

• Revision 1, 2018-09-19 (Martin Dinkov)

  • Initial draft.

See Also

DeviceMemoryOverallocationCreateInfoAMD, MemoryOverallocationBehaviorAMD

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 DeviceMemoryOverallocationCreateInfoAMD

VkDeviceMemoryOverallocationCreateInfoAMD - Specify memory overallocation behavior for a Vulkan device

Valid Usage (Implicit)

See Also

MemoryOverallocationBehaviorAMD, StructureType

Constructors

DeviceMemoryOverallocationCreateInfoAMD

Fields

• overallocationBehavior :: MemoryOverallocationBehaviorAMD

  overallocationBehavior is the desired overallocation behavior.

  overallocationBehavior must be a valid MemoryOverallocationBehaviorAMD value

Instances

Eq DeviceMemoryOverallocationCreateInfoAMD

Defined in Vulkan.Extensions.VK_AMD_memory_overallocation_behavior

Methods

(==) :: DeviceMemoryOverallocationCreateInfoAMD -> DeviceMemoryOverallocationCreateInfoAMD -> Bool

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

Show DeviceMemoryOverallocationCreateInfoAMD

Defined in Vulkan.Extensions.VK_AMD_memory_overallocation_behavior

Methods

showsPrec :: Int -> DeviceMemoryOverallocationCreateInfoAMD -> ShowS

show :: DeviceMemoryOverallocationCreateInfoAMD -> String

showList :: [DeviceMemoryOverallocationCreateInfoAMD] -> ShowS

Storable DeviceMemoryOverallocationCreateInfoAMD

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 ()

FromCStruct DeviceMemoryOverallocationCreateInfoAMD

Defined in Vulkan.Extensions.VK_AMD_memory_overallocation_behavior

Methods

peekCStruct :: Ptr DeviceMemoryOverallocationCreateInfoAMD -> IO DeviceMemoryOverallocationCreateInfoAMD

ToCStruct DeviceMemoryOverallocationCreateInfoAMD

Defined in Vulkan.Extensions.VK_AMD_memory_overallocation_behavior

Methods

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

pokeCStruct :: Ptr DeviceMemoryOverallocationCreateInfoAMD -> DeviceMemoryOverallocationCreateInfoAMD -> IO b -> IO b

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

pokeZeroCStruct :: Ptr DeviceMemoryOverallocationCreateInfoAMD -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DeviceMemoryOverallocationCreateInfoAMD

Defined in Vulkan.Extensions.VK_AMD_memory_overallocation_behavior

Methods

zero :: DeviceMemoryOverallocationCreateInfoAMD

newtype MemoryOverallocationBehaviorAMD

VkMemoryOverallocationBehaviorAMD - Specify memory overallocation behavior

See Also

DeviceMemoryOverallocationCreateInfoAMD

Constructors

MemoryOverallocationBehaviorAMD Int32

Bundled Patterns

pattern MEMORY_OVERALLOCATION_BEHAVIOR_DEFAULT_AMD :: MemoryOverallocationBehaviorAMD

MEMORY_OVERALLOCATION_BEHAVIOR_DEFAULT_AMD lets the implementation decide if overallocation is allowed.

pattern MEMORY_OVERALLOCATION_BEHAVIOR_ALLOWED_AMD :: MemoryOverallocationBehaviorAMD

MEMORY_OVERALLOCATION_BEHAVIOR_ALLOWED_AMD specifies overallocation is allowed if platform permits.

pattern MEMORY_OVERALLOCATION_BEHAVIOR_DISALLOWED_AMD :: MemoryOverallocationBehaviorAMD

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.

Instances

Eq MemoryOverallocationBehaviorAMD

Defined in Vulkan.Extensions.VK_AMD_memory_overallocation_behavior

Methods

(==) :: MemoryOverallocationBehaviorAMD -> MemoryOverallocationBehaviorAMD -> Bool

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

Ord MemoryOverallocationBehaviorAMD

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

Read MemoryOverallocationBehaviorAMD

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

Defined in Vulkan.Extensions.VK_AMD_memory_overallocation_behavior

Methods

showsPrec :: Int -> MemoryOverallocationBehaviorAMD -> ShowS

show :: MemoryOverallocationBehaviorAMD -> String

showList :: [MemoryOverallocationBehaviorAMD] -> ShowS

Storable MemoryOverallocationBehaviorAMD

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 ()

Zero MemoryOverallocationBehaviorAMD

Defined in Vulkan.Extensions.VK_AMD_memory_overallocation_behavior

Methods

zero :: MemoryOverallocationBehaviorAMD

type AMD_MEMORY_OVERALLOCATION_BEHAVIOR_SPEC_VERSION = 1

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

type AMD_MEMORY_OVERALLOCATION_BEHAVIOR_EXTENSION_NAME = "VK_AMD_memory_overallocation_behavior"

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