Class VkDeviceAddressBindingCallbackDataEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
If the reportAddressBinding feature is enabled and the implementation binds or unbinds a region of virtual address space associated with a Vulkan object, the implementation must submit a debug message with the following properties:
messageSeverityequal toDEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXTmessageTypesequal toDEBUG_UTILS_MESSAGE_TYPE_DEVICE_ADDRESS_BINDING_BIT_EXTVkDebugUtilsMessengerCallbackDataEXT::pObjectsmust identify the associated Vulkan objectVkDeviceAddressBindingCallbackDataEXTmust be included in thepNextchain ofVkDebugUtilsMessengerCallbackDataEXT
These debug messages must be emitted both for GPU virtual address space regions that are explicitly bound to a Vulkan object via the vkBind*Memory/vkBind*Memory2 functions, and for those that are implicitly generated via memory allocation or importing external memory.
An implementation may report binding events associated with a Vulkan object via VkDebugUtilsMessengerEXT prior to the object becoming visible to an application via other Vulkan commands. For example, object creation functions may report binding events that occur during an objects creation. In such cases, VkDeviceAddressBindingCallbackDataEXT::flags must include DEVICE_ADDRESS_BINDING_INTERNAL_OBJECT_BIT_EXT.
Object handles reported in this manner are not valid object handles, and must not be used as an input parameter to any Vulkan command.
Any valid object handle returned by an object creation function must match the handle specified via any previously reported binding events associated with the object’s creation.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DEVICE_ADDRESS_BINDING_CALLBACK_DATA_EXTflagsmust be a valid combination ofVkDeviceAddressBindingFlagBitsEXTvaluesbindingTypemust be a validVkDeviceAddressBindingTypeEXTvalue
Layout
struct VkDeviceAddressBindingCallbackDataEXT {
VkStructureType sType();
void * pNext();
VkDeviceAddressBindingFlagsEXT flags();
VkDeviceAddress baseAddress();
VkDeviceSize size();
VkDeviceAddressBindingTypeEXT bindingType();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkDeviceAddressBindingCallbackDataEXTstructs.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 size in bytes.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
ConstructorsConstructorDescriptionVkDeviceAddressBindingCallbackDataEXT(ByteBuffer container) Creates aVkDeviceAddressBindingCallbackDataEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionlonga GPU-accessible virtual address identifying the start of a region of the virtual address space associated with a Vulkan object, as identified by thepObjectsmember ofVkDebugUtilsMessengerCallbackDataEXT.baseAddress(long value) Sets the specified value to thebaseAddress()field.intaVkDeviceAddressBindingTypeEXTspecifying the type of binding event that caused the callback to be called.bindingType(int value) Sets the specified value to thebindingType()field.calloc()Returns a newVkDeviceAddressBindingCallbackDataEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkDeviceAddressBindingCallbackDataEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceAddressBindingCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceAddressBindingCallbackDataEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkDeviceAddressBindingCallbackDataEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkDeviceAddressBindingCallbackDataEXT.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkDeviceAddressBindingCallbackDataEXTinstance for the specified memory address.create(long address, int capacity) Create aVkDeviceAddressBindingCallbackDataEXT.Bufferinstance at the specified memory.static @Nullable VkDeviceAddressBindingCallbackDataEXTcreateSafe(long address) static @Nullable VkDeviceAddressBindingCallbackDataEXT.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkDeviceAddressBindingFlagBitsEXTspecifying additional information about the binding event that caused the callback to be called.flags(int value) Sets the specified value to theflags()field.malloc()Returns a newVkDeviceAddressBindingCallbackDataEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkDeviceAddressBindingCallbackDataEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceAddressBindingCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceAddressBindingCallbackDataEXTinstance allocated on the specifiedMemoryStack.static longnbaseAddress(long struct) Unsafe version ofbaseAddress().static voidnbaseAddress(long struct, long value) Unsafe version ofbaseAddress.static intnbindingType(long struct) Unsafe version ofbindingType().static voidnbindingType(long struct, int value) Unsafe version ofbindingType.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static longnsize(long struct) Unsafe version ofsize().static voidnsize(long struct, long value) Unsafe version ofsize.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.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, int flags, long baseAddress, long size, int bindingType) Initializes this struct with the specified values.Copies the specified struct data to this struct.longsize()the size in bytes of a region of GPU-accessible virtual address space.size(long value) Sets the specified value to thesize()field.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_DEVICE_ADDRESS_BINDING_CALLBACK_DATA_EXTvalue to thesType()field.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. -
BASEADDRESS
public static final int BASEADDRESSThe struct member offsets. -
SIZE
public static final int SIZEThe struct member offsets. -
BINDINGTYPE
public static final int BINDINGTYPEThe struct member offsets.
-
-
Constructor Details
-
VkDeviceAddressBindingCallbackDataEXT
Creates aVkDeviceAddressBindingCallbackDataEXTinstance 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<VkDeviceAddressBindingCallbackDataEXT>
-
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()a bitmask ofVkDeviceAddressBindingFlagBitsEXTspecifying additional information about the binding event that caused the callback to be called. -
baseAddress
public long baseAddress()a GPU-accessible virtual address identifying the start of a region of the virtual address space associated with a Vulkan object, as identified by thepObjectsmember ofVkDebugUtilsMessengerCallbackDataEXT. -
size
public long size()the size in bytes of a region of GPU-accessible virtual address space. -
bindingType
public int bindingType()aVkDeviceAddressBindingTypeEXTspecifying the type of binding event that caused the callback to be called. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_DEVICE_ADDRESS_BINDING_CALLBACK_DATA_EXTvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
flags
Sets the specified value to theflags()field. -
baseAddress
Sets the specified value to thebaseAddress()field. -
size
Sets the specified value to thesize()field. -
bindingType
Sets the specified value to thebindingType()field. -
set
public VkDeviceAddressBindingCallbackDataEXT set(int sType, long pNext, int flags, long baseAddress, long size, int bindingType) 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 newVkDeviceAddressBindingCallbackDataEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkDeviceAddressBindingCallbackDataEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkDeviceAddressBindingCallbackDataEXTinstance allocated withBufferUtils. -
create
Returns a newVkDeviceAddressBindingCallbackDataEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkDeviceAddressBindingCallbackDataEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkDeviceAddressBindingCallbackDataEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkDeviceAddressBindingCallbackDataEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkDeviceAddressBindingCallbackDataEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkDeviceAddressBindingCallbackDataEXT.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkDeviceAddressBindingCallbackDataEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkDeviceAddressBindingCallbackDataEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDeviceAddressBindingCallbackDataEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceAddressBindingCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkDeviceAddressBindingCallbackDataEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceAddressBindingCallbackDataEXT.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(). -
nbaseAddress
public static long nbaseAddress(long struct) Unsafe version ofbaseAddress(). -
nsize
public static long nsize(long struct) Unsafe version ofsize(). -
nbindingType
public static int nbindingType(long struct) Unsafe version ofbindingType(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
nbaseAddress
public static void nbaseAddress(long struct, long value) Unsafe version ofbaseAddress. -
nsize
public static void nsize(long struct, long value) Unsafe version ofsize. -
nbindingType
public static void nbindingType(long struct, int value) Unsafe version ofbindingType.
-