Vulkan.Extensions.VK_EXT_memory_priority

Name

VK_EXT_memory_priority - device extension

VK_EXT_memory_priority

Name String

VK_EXT_memory_priority

Extension Type

Device extension

Registered Extension Number

239

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2

Contact

• Jeff Bolz https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_EXT_memory_priority:%20&body=@jeffbolznv%20

Other Extension Metadata

Last Modified Date

2018-10-08

Contributors

• Jeff Bolz, NVIDIA
• Jeff Juliano, NVIDIA

Description

This extension adds a priority value specified at memory allocation time. On some systems with both device-local and non-device-local memory heaps, the implementation may transparently move memory from one heap to another when a heap becomes full (for example, when the total memory used across all processes exceeds the size of the heap). In such a case, this priority value may be used to determine which allocations are more likely to remain in device-local memory.

New Structures

• Extending MemoryAllocateInfo:

  • MemoryPriorityAllocateInfoEXT

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceMemoryPriorityFeaturesEXT

New Enum Constants

• EXT_MEMORY_PRIORITY_EXTENSION_NAME

• EXT_MEMORY_PRIORITY_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_MEMORY_PRIORITY_ALLOCATE_INFO_EXT
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_MEMORY_PRIORITY_FEATURES_EXT

Version History

• Revision 1, 2018-10-08 (Jeff Bolz)

  • Initial revision

See Also

MemoryPriorityAllocateInfoEXT, PhysicalDeviceMemoryPriorityFeaturesEXT

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 PhysicalDeviceMemoryPriorityFeaturesEXT

VkPhysicalDeviceMemoryPriorityFeaturesEXT - Structure describing memory priority features that can be supported by an implementation

Members

This structure describes the following feature:

Description

If the PhysicalDeviceMemoryPriorityFeaturesEXT 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. PhysicalDeviceMemoryPriorityFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

Bool32, StructureType

Constructors

PhysicalDeviceMemoryPriorityFeaturesEXT

Fields

• memoryPriority :: Bool

  memoryPriority indicates that the implementation supports memory priorities specified at memory allocation time via MemoryPriorityAllocateInfoEXT.

Instances

Eq PhysicalDeviceMemoryPriorityFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

(==) :: PhysicalDeviceMemoryPriorityFeaturesEXT -> PhysicalDeviceMemoryPriorityFeaturesEXT -> Bool

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

Show PhysicalDeviceMemoryPriorityFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

showsPrec :: Int -> PhysicalDeviceMemoryPriorityFeaturesEXT -> ShowS

show :: PhysicalDeviceMemoryPriorityFeaturesEXT -> String

showList :: [PhysicalDeviceMemoryPriorityFeaturesEXT] -> ShowS

Storable PhysicalDeviceMemoryPriorityFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

sizeOf :: PhysicalDeviceMemoryPriorityFeaturesEXT -> Int

alignment :: PhysicalDeviceMemoryPriorityFeaturesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> Int -> IO PhysicalDeviceMemoryPriorityFeaturesEXT

pokeElemOff :: Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> Int -> PhysicalDeviceMemoryPriorityFeaturesEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceMemoryPriorityFeaturesEXT

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceMemoryPriorityFeaturesEXT -> IO ()

peek :: Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> IO PhysicalDeviceMemoryPriorityFeaturesEXT

poke :: Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> PhysicalDeviceMemoryPriorityFeaturesEXT -> IO ()

FromCStruct PhysicalDeviceMemoryPriorityFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

peekCStruct :: Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> IO PhysicalDeviceMemoryPriorityFeaturesEXT

ToCStruct PhysicalDeviceMemoryPriorityFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

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

pokeCStruct :: Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> PhysicalDeviceMemoryPriorityFeaturesEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceMemoryPriorityFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

zero :: PhysicalDeviceMemoryPriorityFeaturesEXT

data MemoryPriorityAllocateInfoEXT

VkMemoryPriorityAllocateInfoEXT - Specify a memory allocation priority

Description

Memory allocations with higher priority may be more likely to stay in device-local memory when the system is under memory pressure.

If this structure is not included, it is as if the priority value were 0.5.

Valid Usage (Implicit)

See Also

StructureType

Constructors

MemoryPriorityAllocateInfoEXT

Fields

• priority :: Float

  priority is a floating-point value between 0 and 1, indicating the priority of the allocation relative to other memory allocations. Larger values are higher priority. The granularity of the priorities is implementation-dependent.

  priority must be between 0 and 1, inclusive

Instances

Eq MemoryPriorityAllocateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

(==) :: MemoryPriorityAllocateInfoEXT -> MemoryPriorityAllocateInfoEXT -> Bool

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

Show MemoryPriorityAllocateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

showsPrec :: Int -> MemoryPriorityAllocateInfoEXT -> ShowS

show :: MemoryPriorityAllocateInfoEXT -> String

showList :: [MemoryPriorityAllocateInfoEXT] -> ShowS

Storable MemoryPriorityAllocateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

sizeOf :: MemoryPriorityAllocateInfoEXT -> Int

alignment :: MemoryPriorityAllocateInfoEXT -> Int

peekElemOff :: Ptr MemoryPriorityAllocateInfoEXT -> Int -> IO MemoryPriorityAllocateInfoEXT

pokeElemOff :: Ptr MemoryPriorityAllocateInfoEXT -> Int -> MemoryPriorityAllocateInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO MemoryPriorityAllocateInfoEXT

pokeByteOff :: Ptr b -> Int -> MemoryPriorityAllocateInfoEXT -> IO ()

peek :: Ptr MemoryPriorityAllocateInfoEXT -> IO MemoryPriorityAllocateInfoEXT

poke :: Ptr MemoryPriorityAllocateInfoEXT -> MemoryPriorityAllocateInfoEXT -> IO ()

FromCStruct MemoryPriorityAllocateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

peekCStruct :: Ptr MemoryPriorityAllocateInfoEXT -> IO MemoryPriorityAllocateInfoEXT

ToCStruct MemoryPriorityAllocateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

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

pokeCStruct :: Ptr MemoryPriorityAllocateInfoEXT -> MemoryPriorityAllocateInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MemoryPriorityAllocateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MemoryPriorityAllocateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_memory_priority

Methods

zero :: MemoryPriorityAllocateInfoEXT

type EXT_MEMORY_PRIORITY_SPEC_VERSION = 1

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

type EXT_MEMORY_PRIORITY_EXTENSION_NAME = "VK_EXT_memory_priority"

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