Package org.lwjgl.vulkan

Class EXTDeviceMemoryReport

java.lang.Object

org.lwjgl.vulkan.EXTDeviceMemoryReport

public final class EXTDeviceMemoryReport
extends Object

This device extension allows registration of device memory event callbacks upon device creation, so that applications or middleware can obtain detailed information about memory usage and how memory is associated with Vulkan objects. This extension exposes the actual underlying device memory usage, including allocations that are not normally visible to the application, such as memory consumed by CreateGraphicsPipelines. It is intended primarily for use by debug tooling rather than for production applications.

Name String

VK_EXT_device_memory_report

Extension Type

Device extension

Registered Extension Number

285

Revision

2

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Version 1.1

Special Use

• Developer tools

Contact

• Yiwei Zhang zhangyiwei

Other Extension Metadata

Last Modified Date

2021-01-06

IP Status

No known IP claims.

Contributors

• Yiwei Zhang, Google
• Jesse Hall, Google

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT	VkDeviceMemoryReportEventTypeEXT - Events that can occur on a device memory object
static final int	VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT	VkDeviceMemoryReportEventTypeEXT - Events that can occur on a device memory object
static final int	VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_FREE_EXT	VkDeviceMemoryReportEventTypeEXT - Events that can occur on a device memory object
static final int	VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXT	VkDeviceMemoryReportEventTypeEXT - Events that can occur on a device memory object
static final int	VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_UNIMPORT_EXT	VkDeviceMemoryReportEventTypeEXT - Events that can occur on a device memory object
static final String	VK_EXT_DEVICE_MEMORY_REPORT_EXTENSION_NAME	The extension name.
static final int	VK_EXT_DEVICE_MEMORY_REPORT_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_DEVICE_DEVICE_MEMORY_REPORT_CREATE_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_DEVICE_MEMORY_REPORT_CALLBACK_DATA_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_MEMORY_REPORT_FEATURES_EXT	Extends VkStructureType.

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_EXT_DEVICE_MEMORY_REPORT_SPEC_VERSION

public static final int VK_EXT_DEVICE_MEMORY_REPORT_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_EXT_DEVICE_MEMORY_REPORT_EXTENSION_NAME

public static final String VK_EXT_DEVICE_MEMORY_REPORT_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_MEMORY_REPORT_FEATURES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_MEMORY_REPORT_FEATURES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_MEMORY_REPORT_FEATURES_EXT
• STRUCTURE_TYPE_DEVICE_DEVICE_MEMORY_REPORT_CREATE_INFO_EXT
• STRUCTURE_TYPE_DEVICE_MEMORY_REPORT_CALLBACK_DATA_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_DEVICE_DEVICE_MEMORY_REPORT_CREATE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_DEVICE_DEVICE_MEMORY_REPORT_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_MEMORY_REPORT_FEATURES_EXT
• STRUCTURE_TYPE_DEVICE_DEVICE_MEMORY_REPORT_CREATE_INFO_EXT
• STRUCTURE_TYPE_DEVICE_MEMORY_REPORT_CALLBACK_DATA_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_DEVICE_MEMORY_REPORT_CALLBACK_DATA_EXT

public static final int VK_STRUCTURE_TYPE_DEVICE_MEMORY_REPORT_CALLBACK_DATA_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_MEMORY_REPORT_FEATURES_EXT
• STRUCTURE_TYPE_DEVICE_DEVICE_MEMORY_REPORT_CREATE_INFO_EXT
• STRUCTURE_TYPE_DEVICE_MEMORY_REPORT_CALLBACK_DATA_EXT

See Also:

• Constant Field Values

VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT

public static final int VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT

VkDeviceMemoryReportEventTypeEXT - Events that can occur on a device memory object

Description

• DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT specifies this event corresponds to the allocation of an internal device memory object or a VkDeviceMemory.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_FREE_EXT specifies this event corresponds to the deallocation of an internally-allocated device memory object or a VkDeviceMemory.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXT specifies this event corresponds to the import of an external memory object.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_UNIMPORT_EXT specifies this event is the release of an imported external memory object.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT specifies this event corresponds to the failed allocation of an internal device memory object or a VkDeviceMemory.

See Also

VkDeviceMemoryReportCallbackDataEXT

See Also:

• Constant Field Values

VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_FREE_EXT

public static final int VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_FREE_EXT

VkDeviceMemoryReportEventTypeEXT - Events that can occur on a device memory object

Description

• DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT specifies this event corresponds to the allocation of an internal device memory object or a VkDeviceMemory.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_FREE_EXT specifies this event corresponds to the deallocation of an internally-allocated device memory object or a VkDeviceMemory.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXT specifies this event corresponds to the import of an external memory object.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_UNIMPORT_EXT specifies this event is the release of an imported external memory object.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT specifies this event corresponds to the failed allocation of an internal device memory object or a VkDeviceMemory.

See Also

VkDeviceMemoryReportCallbackDataEXT

See Also:

• Constant Field Values

VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXT

public static final int VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXT

VkDeviceMemoryReportEventTypeEXT - Events that can occur on a device memory object

Description

• DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT specifies this event corresponds to the allocation of an internal device memory object or a VkDeviceMemory.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_FREE_EXT specifies this event corresponds to the deallocation of an internally-allocated device memory object or a VkDeviceMemory.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXT specifies this event corresponds to the import of an external memory object.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_UNIMPORT_EXT specifies this event is the release of an imported external memory object.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT specifies this event corresponds to the failed allocation of an internal device memory object or a VkDeviceMemory.

See Also

VkDeviceMemoryReportCallbackDataEXT

See Also:

• Constant Field Values

VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_UNIMPORT_EXT

public static final int VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_UNIMPORT_EXT

VkDeviceMemoryReportEventTypeEXT - Events that can occur on a device memory object

Description

• DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT specifies this event corresponds to the allocation of an internal device memory object or a VkDeviceMemory.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_FREE_EXT specifies this event corresponds to the deallocation of an internally-allocated device memory object or a VkDeviceMemory.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXT specifies this event corresponds to the import of an external memory object.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_UNIMPORT_EXT specifies this event is the release of an imported external memory object.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT specifies this event corresponds to the failed allocation of an internal device memory object or a VkDeviceMemory.

See Also

VkDeviceMemoryReportCallbackDataEXT

See Also:

• Constant Field Values

VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT

public static final int VK_DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT

VkDeviceMemoryReportEventTypeEXT - Events that can occur on a device memory object

Description

• DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT specifies this event corresponds to the allocation of an internal device memory object or a VkDeviceMemory.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_FREE_EXT specifies this event corresponds to the deallocation of an internally-allocated device memory object or a VkDeviceMemory.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXT specifies this event corresponds to the import of an external memory object.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_UNIMPORT_EXT specifies this event is the release of an imported external memory object.
• DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT specifies this event corresponds to the failed allocation of an internal device memory object or a VkDeviceMemory.

See Also

VkDeviceMemoryReportCallbackDataEXT

See Also:

• Constant Field Values