Class VkDeviceMemoryReportCallbackDataEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
memoryObjectId is used to avoid double-counting on the same memory object.
If an internally-allocated device memory object or a VkDeviceMemory cannot be exported, memoryObjectId must be unique in the VkDevice.
If an internally-allocated device memory object or a VkDeviceMemory supports being exported, memoryObjectId must be unique system wide.
If an internal device memory object or a VkDeviceMemory is backed by an imported external memory object, memoryObjectId must be unique system wide.
Note
This structure should only be considered valid during the lifetime of the triggered callback.
For DEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT and DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXT events, objectHandle usually will not yet exist when the application or tool receives the callback. objectHandle will only exist when the create or allocate call that triggered the event returns, and if the allocation or import ends up failing objectHandle will not ever exist.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DEVICE_MEMORY_REPORT_CALLBACK_DATA_EXTpNextmust beNULL
See Also
VkDeviceMemoryReportCallbackEXT
Layout
struct VkDeviceMemoryReportCallbackDataEXT {
VkStructureType sType();
void * pNext();
VkDeviceMemoryReportFlagsEXT flags();
VkDeviceMemoryReportEventTypeEXT type();
uint64_t memoryObjectId();
VkDeviceSize size();
VkObjectType objectType();
uint64_t objectHandle();
uint32_t heapIndex();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkDeviceMemoryReportCallbackDataEXTstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkDeviceMemoryReportCallbackDataEXT(ByteBuffer container) Creates aVkDeviceMemoryReportCallbackDataEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkDeviceMemoryReportCallbackDataEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkDeviceMemoryReportCallbackDataEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceMemoryReportCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceMemoryReportCallbackDataEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkDeviceMemoryReportCallbackDataEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkDeviceMemoryReportCallbackDataEXT.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkDeviceMemoryReportCallbackDataEXTinstance for the specified memory address.create(long address, int capacity) Create aVkDeviceMemoryReportCallbackDataEXT.Bufferinstance at the specified memory.static @Nullable VkDeviceMemoryReportCallbackDataEXTcreateSafe(long address) static @Nullable VkDeviceMemoryReportCallbackDataEXT.BuffercreateSafe(long address, int capacity) intflags()0 and reserved for future use.intdescribes which memory heap this device memory allocation is made from.malloc()Returns a newVkDeviceMemoryReportCallbackDataEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkDeviceMemoryReportCallbackDataEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceMemoryReportCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceMemoryReportCallbackDataEXTinstance allocated on the specifiedMemoryStack.longthe unique id for the underlying memory object as described below.static intnflags(long struct) Unsafe version offlags().static intnheapIndex(long struct) Unsafe version ofheapIndex().static longnmemoryObjectId(long struct) Unsafe version ofmemoryObjectId().static longnobjectHandle(long struct) Unsafe version ofobjectHandle().static intnobjectType(long struct) Unsafe version ofobjectType().static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static longnsize(long struct) Unsafe version ofsize().static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intntype(long struct) Unsafe version oftype().longthe object this device memory report event is attributed to.intaVkObjectTypevalue specifying the type of the object associated with this device memory report event.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext) Initializes this struct with the specified values.Copies the specified struct data to this struct.longsize()the size of the memory object in bytes.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_DEVICE_MEMORY_REPORT_CALLBACK_DATA_EXTvalue to thesType()field.inttype()aVkDeviceMemoryReportEventTypeEXTtype specifying the type of event reported in thisVkDeviceMemoryReportCallbackDataEXTstructure.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
TYPE
public static final int TYPEThe struct member offsets. -
MEMORYOBJECTID
public static final int MEMORYOBJECTIDThe struct member offsets. -
SIZE
public static final int SIZEThe struct member offsets. -
OBJECTTYPE
public static final int OBJECTTYPEThe struct member offsets. -
OBJECTHANDLE
public static final int OBJECTHANDLEThe struct member offsets. -
HEAPINDEX
public static final int HEAPINDEXThe struct member offsets.
-
-
Constructor Details
-
VkDeviceMemoryReportCallbackDataEXT
Creates aVkDeviceMemoryReportCallbackDataEXTinstance at the current position of the specifiedByteBuffercontainer. Changes to the buffer's content will be visible to the struct instance and vice versa.The created instance holds a strong reference to the container object.
-
-
Method Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkDeviceMemoryReportCallbackDataEXT>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()0 and reserved for future use. -
type
public int type()aVkDeviceMemoryReportEventTypeEXTtype specifying the type of event reported in thisVkDeviceMemoryReportCallbackDataEXTstructure. -
memoryObjectId
public long memoryObjectId()the unique id for the underlying memory object as described below. -
size
public long size()the size of the memory object in bytes. IftypeisDEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT,DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXTorDEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT,sizeis a validVkDeviceSizevalue. Otherwise,sizeis undefined. -
objectType
public int objectType()aVkObjectTypevalue specifying the type of the object associated with this device memory report event. IftypeisDEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT,DEVICE_MEMORY_REPORT_EVENT_TYPE_FREE_EXT,DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXT,DEVICE_MEMORY_REPORT_EVENT_TYPE_UNIMPORT_EXTorDEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT,objectTypeis a validVkObjectTypeenum. Otherwise,objectTypeis undefined. -
objectHandle
public long objectHandle()the object this device memory report event is attributed to. IftypeisDEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXT,DEVICE_MEMORY_REPORT_EVENT_TYPE_FREE_EXT,DEVICE_MEMORY_REPORT_EVENT_TYPE_IMPORT_EXTorDEVICE_MEMORY_REPORT_EVENT_TYPE_UNIMPORT_EXT,objectHandleis a valid Vulkan handle of the type associated withobjectTypeas defined in theVkObjectTypeand Vulkan Handle Relationship table. Otherwise,objectHandleis undefined. -
heapIndex
public int heapIndex()describes which memory heap this device memory allocation is made from. IftypeisDEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATE_EXTorDEVICE_MEMORY_REPORT_EVENT_TYPE_ALLOCATION_FAILED_EXT,heapIndexcorresponds to one of the valid heaps from theVkPhysicalDeviceMemoryPropertiesstructure. Otherwise,heapIndexis undefined. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_DEVICE_MEMORY_REPORT_CALLBACK_DATA_EXTvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkDeviceMemoryReportCallbackDataEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkDeviceMemoryReportCallbackDataEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkDeviceMemoryReportCallbackDataEXTinstance allocated withBufferUtils. -
create
Returns a newVkDeviceMemoryReportCallbackDataEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkDeviceMemoryReportCallbackDataEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkDeviceMemoryReportCallbackDataEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkDeviceMemoryReportCallbackDataEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkDeviceMemoryReportCallbackDataEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkDeviceMemoryReportCallbackDataEXT.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkDeviceMemoryReportCallbackDataEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkDeviceMemoryReportCallbackDataEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDeviceMemoryReportCallbackDataEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceMemoryReportCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkDeviceMemoryReportCallbackDataEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceMemoryReportCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
ntype
public static int ntype(long struct) Unsafe version oftype(). -
nmemoryObjectId
public static long nmemoryObjectId(long struct) Unsafe version ofmemoryObjectId(). -
nsize
public static long nsize(long struct) Unsafe version ofsize(). -
nobjectType
public static int nobjectType(long struct) Unsafe version ofobjectType(). -
nobjectHandle
public static long nobjectHandle(long struct) Unsafe version ofobjectHandle(). -
nheapIndex
public static int nheapIndex(long struct) Unsafe version ofheapIndex(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext.
-