Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_memory_priority

Description

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

Version History

Revision 1, 2018-10-08 (Jeff Bolz)
- Initial revision

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 PhysicalDeviceMemoryPriorityFeaturesEXT = PhysicalDeviceMemoryPriorityFeaturesEXT {
- memoryPriority :: Bool
}
data MemoryPriorityAllocateInfoEXT = MemoryPriorityAllocateInfoEXT {
- priority :: Float
}
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

Documentation

data PhysicalDeviceMemoryPriorityFeaturesEXT Source #

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

Members

The members of the PhysicalDeviceMemoryPriorityFeaturesEXT structure describe the following features:

Description

If the PhysicalDeviceMemoryPriorityFeaturesEXT structure is included in the pNext chain of PhysicalDeviceFeatures2, it is filled with values indicating whether the feature is supported. PhysicalDeviceMemoryPriorityFeaturesEXT can also be included in the pNext chain of DeviceCreateInfo to enable features.

Valid Usage (Implicit)

Eq PhysicalDeviceMemoryPriorityFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_memory_priority Methods (==) :: PhysicalDeviceMemoryPriorityFeaturesEXT -> PhysicalDeviceMemoryPriorityFeaturesEXT -> Bool # (/=) :: PhysicalDeviceMemoryPriorityFeaturesEXT -> PhysicalDeviceMemoryPriorityFeaturesEXT -> Bool #
Show PhysicalDeviceMemoryPriorityFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_memory_priority Methods showsPrec :: Int -> PhysicalDeviceMemoryPriorityFeaturesEXT -> ShowS # show :: PhysicalDeviceMemoryPriorityFeaturesEXT -> String # showList :: [PhysicalDeviceMemoryPriorityFeaturesEXT] -> ShowS #
Storable PhysicalDeviceMemoryPriorityFeaturesEXT Source #
Instance details 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 Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_memory_priority Methods peekCStruct :: Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> IO PhysicalDeviceMemoryPriorityFeaturesEXT Source #
ToCStruct PhysicalDeviceMemoryPriorityFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_memory_priority Methods withCStruct :: PhysicalDeviceMemoryPriorityFeaturesEXT -> (Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> PhysicalDeviceMemoryPriorityFeaturesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceMemoryPriorityFeaturesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceMemoryPriorityFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_memory_priority Methods zero :: PhysicalDeviceMemoryPriorityFeaturesEXT Source #

data MemoryPriorityAllocateInfoEXT Source #

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)

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

Instances details

Eq MemoryPriorityAllocateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_memory_priority Methods (==) :: MemoryPriorityAllocateInfoEXT -> MemoryPriorityAllocateInfoEXT -> Bool # (/=) :: MemoryPriorityAllocateInfoEXT -> MemoryPriorityAllocateInfoEXT -> Bool #
Show MemoryPriorityAllocateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_memory_priority Methods showsPrec :: Int -> MemoryPriorityAllocateInfoEXT -> ShowS # show :: MemoryPriorityAllocateInfoEXT -> String # showList :: [MemoryPriorityAllocateInfoEXT] -> ShowS #
Storable MemoryPriorityAllocateInfoEXT Source #
Instance details 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 Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_memory_priority Methods peekCStruct :: Ptr MemoryPriorityAllocateInfoEXT -> IO MemoryPriorityAllocateInfoEXT Source #
ToCStruct MemoryPriorityAllocateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_memory_priority Methods withCStruct :: MemoryPriorityAllocateInfoEXT -> (Ptr MemoryPriorityAllocateInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr MemoryPriorityAllocateInfoEXT -> MemoryPriorityAllocateInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr MemoryPriorityAllocateInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr MemoryPriorityAllocateInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero MemoryPriorityAllocateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_memory_priority Methods zero :: MemoryPriorityAllocateInfoEXT Source #

type EXT_MEMORY_PRIORITY_SPEC_VERSION = 1 Source #

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

type EXT_MEMORY_PRIORITY_EXTENSION_NAME = "VK_EXT_memory_priority" Source #

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

Name

VK_EXT_memory_priority

Other Extension Metadata

Description

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Members

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

PhysicalDeviceMemoryPriorityFeaturesEXT
Fields memoryPriority :: Bool `memoryPriority` indicates that the implementation supports memory priorities specified at memory allocation time via `MemoryPriorityAllocateInfoEXT`.