Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDeviceAddressBindingCallbackDataEXT

extends Struct<VkDeviceAddressBindingCallbackDataEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying parameters returned to the callback.
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:

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)

Layout


struct VkDeviceAddressBindingCallbackDataEXT {
    VkStructureType sType;
    void * pNext;
    VkDeviceAddressBindingFlagsEXT flags;
    VkDeviceAddress baseAddress;
    VkDeviceSize size;
    VkDeviceAddressBindingTypeEXT bindingType;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BASEADDRESS

The struct member offsets.

public static final int
BINDINGTYPE

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkDeviceAddressBindingCallbackDataEXT(ByteBuffer container)

Creates a VkDeviceAddressBindingCallbackDataEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
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 the pObjects member of VkDebugUtilsMessengerCallbackDataEXT.

public VkDeviceAddressBindingCallbackDataEXT
baseAddress(long value)

Sets the specified value to the baseAddress field.

public int
bindingType()

a VkDeviceAddressBindingTypeEXT specifying the type of binding event that caused the callback to be called.

public VkDeviceAddressBindingCallbackDataEXT
bindingType(int value)

Sets the specified value to the bindingType field.

public static VkDeviceAddressBindingCallbackDataEXT
calloc()

Returns a new VkDeviceAddressBindingCallbackDataEXT instance allocated with memCalloc.

public static VkDeviceAddressBindingCallbackDataEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance allocated with memCalloc.

public static VkDeviceAddressBindingCallbackDataEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDeviceAddressBindingCallbackDataEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkDeviceAddressBindingCallbackDataEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected VkDeviceAddressBindingCallbackDataEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkDeviceAddressBindingCallbackDataEXT
create()

Returns a new VkDeviceAddressBindingCallbackDataEXT instance allocated with BufferUtils.

public static VkDeviceAddressBindingCallbackDataEXT
create(long address)

Returns a new VkDeviceAddressBindingCallbackDataEXT instance for the specified memory address.

public static VkDeviceAddressBindingCallbackDataEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance allocated with BufferUtils.

public static VkDeviceAddressBindingCallbackDataEXT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkDeviceAddressBindingCallbackDataEXT.Buffer instance at the specified memory.

public static VkDeviceAddressBindingCallbackDataEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkDeviceAddressBindingCallbackDataEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkDeviceAddressBindingFlagBitsEXT specifying additional information about the binding event that caused the callback to be called.

public VkDeviceAddressBindingCallbackDataEXT
flags(int value)

Sets the specified value to the flags field.

public static VkDeviceAddressBindingCallbackDataEXT
malloc()

Returns a new VkDeviceAddressBindingCallbackDataEXT instance allocated with memAlloc.

public static VkDeviceAddressBindingCallbackDataEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance allocated with memAlloc.

public static VkDeviceAddressBindingCallbackDataEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDeviceAddressBindingCallbackDataEXT instance allocated on the specified MemoryStack.

public static VkDeviceAddressBindingCallbackDataEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance allocated on the specified MemoryStack.

public static long
nbaseAddress(long struct)

Unsafe version of baseAddress.

public static void
nbaseAddress(long struct, long value)

Unsafe version of baseAddress.

public static int
nbindingType(long struct)

Unsafe version of bindingType.

public static void
nbindingType(long struct, int value)

Unsafe version of bindingType.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static long
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, long value)

Unsafe version of size.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDeviceAddressBindingCallbackDataEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkDeviceAddressBindingCallbackDataEXT
set(int sType, long pNext, int flags, long baseAddress, long size, int bindingType)

Initializes this struct with the specified values.

public VkDeviceAddressBindingCallbackDataEXT

Returns:

this struct
set
(VkDeviceAddressBindingCallbackDataEXT
the source struct
src
)

Copies the specified struct data to this struct.

public long
size()

the size in bytes of a region of GPU-accessible virtual address space.

public VkDeviceAddressBindingCallbackDataEXT
size(long value)

Sets the specified value to the size field.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkDeviceAddressBindingCallbackDataEXT
sType(int value)

Sets the specified value to the sType field.

public VkDeviceAddressBindingCallbackDataEXT
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BASEADDRESSback to summary
public static final int BASEADDRESS

The struct member offsets.

BINDINGTYPEback to summary
public static final int BINDINGTYPE

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkDeviceAddressBindingCallbackDataEXTback to summary
protected VkDeviceAddressBindingCallbackDataEXT(long address, ByteBuffer container)
VkDeviceAddressBindingCallbackDataEXTback to summary
public VkDeviceAddressBindingCallbackDataEXT(ByteBuffer container)

Creates a VkDeviceAddressBindingCallbackDataEXT instance at the current position of the specified ByteBuffer container. 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 Detail

baseAddressback to summary
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 the pObjects member of VkDebugUtilsMessengerCallbackDataEXT.

Annotations
@NativeType:VkDeviceAddress
baseAddressback to summary
public VkDeviceAddressBindingCallbackDataEXT baseAddress(long value)

Sets the specified value to the baseAddress field.

bindingTypeback to summary
public int bindingType()

a VkDeviceAddressBindingTypeEXT specifying the type of binding event that caused the callback to be called.

Annotations
@NativeType:VkDeviceAddressBindingTypeEXT
bindingTypeback to summary
public VkDeviceAddressBindingCallbackDataEXT bindingType(int value)

Sets the specified value to the bindingType field.

callocback to summary
public static VkDeviceAddressBindingCallbackDataEXT calloc()

Returns a new VkDeviceAddressBindingCallbackDataEXT instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkDeviceAddressBindingCallbackDataEXT.Buffer calloc(int capacity)

Returns a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDeviceAddressBindingCallbackDataEXT calloc(MemoryStack stack)

Returns a new VkDeviceAddressBindingCallbackDataEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkDeviceAddressBindingCallbackDataEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkDeviceAddressBindingCallbackDataEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkDeviceAddressBindingCallbackDataEXT create()

Returns a new VkDeviceAddressBindingCallbackDataEXT instance allocated with BufferUtils.

createback to summary
public static VkDeviceAddressBindingCallbackDataEXT create(long address)

Returns a new VkDeviceAddressBindingCallbackDataEXT instance for the specified memory address.

createback to summary
public static VkDeviceAddressBindingCallbackDataEXT.Buffer create(int capacity)

Returns a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkDeviceAddressBindingCallbackDataEXT.Buffer create(long address, int capacity)

Create a VkDeviceAddressBindingCallbackDataEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDeviceAddressBindingCallbackDataEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkDeviceAddressBindingCallbackDataEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

a bitmask of VkDeviceAddressBindingFlagBitsEXT specifying additional information about the binding event that caused the callback to be called.

Annotations
@NativeType:VkDeviceAddressBindingFlagsEXT
flagsback to summary
public VkDeviceAddressBindingCallbackDataEXT flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkDeviceAddressBindingCallbackDataEXT malloc()

Returns a new VkDeviceAddressBindingCallbackDataEXT instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkDeviceAddressBindingCallbackDataEXT.Buffer malloc(int capacity)

Returns a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDeviceAddressBindingCallbackDataEXT malloc(MemoryStack stack)

Returns a new VkDeviceAddressBindingCallbackDataEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkDeviceAddressBindingCallbackDataEXT.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbaseAddressback to summary
public static long nbaseAddress(long struct)

Unsafe version of baseAddress.

nbaseAddressback to summary
public static void nbaseAddress(long struct, long value)

Unsafe version of baseAddress.

nbindingTypeback to summary
public static int nbindingType(long struct)

Unsafe version of bindingType.

nbindingTypeback to summary
public static void nbindingType(long struct, int value)

Unsafe version of bindingType.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, long value)

Unsafe version of size.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkDeviceAddressBindingCallbackDataEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkDeviceAddressBindingCallbackDataEXT set(int sType, long pNext, int flags, long baseAddress, long size, int bindingType)

Initializes this struct with the specified values.

setback to summary
public VkDeviceAddressBindingCallbackDataEXT set(VkDeviceAddressBindingCallbackDataEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkDeviceAddressBindingCallbackDataEXT

the source struct

Returns:VkDeviceAddressBindingCallbackDataEXT

this struct

sizeback to summary
public long size()

the size in bytes of a region of GPU-accessible virtual address space.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VkDeviceAddressBindingCallbackDataEXT size(long value)

Sets the specified value to the size field.

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDeviceAddressBindingCallbackDataEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkDeviceAddressBindingCallbackDataEXT sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_ADDRESS_BINDING_CALLBACK_DATA_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDeviceAddressBindingCallbackDataEXT.Buffer

extends StructBuffer<VkDeviceAddressBindingCallbackDataEXT, VkDeviceAddressBindingCallbackDataEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDeviceAddressBindingCallbackDataEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkDeviceAddressBindingCallbackDataEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long
public VkDeviceAddressBindingCallbackDataEXT.Buffer
baseAddress(long value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#baseAddress field.

public int
public VkDeviceAddressBindingCallbackDataEXT.Buffer
bindingType(int value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#bindingType field.

public int

Returns:

the value of the VkDeviceAddressBindingCallbackDataEXT#flags field.
flags
()

public VkDeviceAddressBindingCallbackDataEXT.Buffer
flags(int value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#flags field.

protected VkDeviceAddressBindingCallbackDataEXT
public long

Returns:

the value of the VkDeviceAddressBindingCallbackDataEXT#pNext field.
pNext
()

public VkDeviceAddressBindingCallbackDataEXT.Buffer
pNext(long value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#pNext field.

protected VkDeviceAddressBindingCallbackDataEXT.Buffer
public long

Returns:

the value of the VkDeviceAddressBindingCallbackDataEXT#size field.
size
()

public VkDeviceAddressBindingCallbackDataEXT.Buffer
size(long value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#size field.

public int

Returns:

the value of the VkDeviceAddressBindingCallbackDataEXT#sType field.
sType
()

public VkDeviceAddressBindingCallbackDataEXT.Buffer
sType(int value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#sType field.

public VkDeviceAddressBindingCallbackDataEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDeviceAddressBindingCallbackDataEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDeviceAddressBindingCallbackDataEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkDeviceAddressBindingCallbackDataEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

baseAddressback to summary
public long baseAddress()
Returns:long

the value of the VkDeviceAddressBindingCallbackDataEXT#baseAddress field.

Annotations
@NativeType:VkDeviceAddress
baseAddressback to summary
public VkDeviceAddressBindingCallbackDataEXT.Buffer baseAddress(long value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#baseAddress field.

bindingTypeback to summary
public int bindingType()
Returns:int

the value of the VkDeviceAddressBindingCallbackDataEXT#bindingType field.

Annotations
@NativeType:VkDeviceAddressBindingTypeEXT
bindingTypeback to summary
public VkDeviceAddressBindingCallbackDataEXT.Buffer bindingType(int value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#bindingType field.

flagsback to summary
public int flags()
Returns:int

the value of the VkDeviceAddressBindingCallbackDataEXT#flags field.

Annotations
@NativeType:VkDeviceAddressBindingFlagsEXT
flagsback to summary
public VkDeviceAddressBindingCallbackDataEXT.Buffer flags(int value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#flags field.

getElementFactoryback to summary
protected VkDeviceAddressBindingCallbackDataEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkDeviceAddressBindingCallbackDataEXT#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkDeviceAddressBindingCallbackDataEXT.Buffer pNext(long value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#pNext field.

selfback to summary
protected VkDeviceAddressBindingCallbackDataEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sizeback to summary
public long size()
Returns:long

the value of the VkDeviceAddressBindingCallbackDataEXT#size field.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VkDeviceAddressBindingCallbackDataEXT.Buffer size(long value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#size field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkDeviceAddressBindingCallbackDataEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDeviceAddressBindingCallbackDataEXT.Buffer sType(int value)

Sets the specified value to the VkDeviceAddressBindingCallbackDataEXT#sType field.

sType$Defaultback to summary
public VkDeviceAddressBindingCallbackDataEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_ADDRESS_BINDING_CALLBACK_DATA_EXT value to the VkDeviceAddressBindingCallbackDataEXT#sType field.