Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDebugUtilsMessengerCallbackDataEXT

extends Struct<VkDebugUtilsMessengerCallbackDataEXT>
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
Note

This structure should only be considered valid during the lifetime of the triggered callback.

Since adding queue and command buffer labels behaves like pushing and popping onto a stack, the order of both pQueueLabels and pCmdBufLabels is based on the order the labels were defined. The result is that the first label in either pQueueLabels or pCmdBufLabels will be the first defined (and therefore the oldest) while the last label in each list will be the most recent.

Note

pQueueLabels will only be non-NULL if one of the objects in pObjects can be related directly to a defined VkQueue which has had one or more labels associated with it.

Likewise, pCmdBufLabels will only be non-NULL if one of the objects in pObjects can be related directly to a defined VkCommandBuffer which has had one or more labels associated with it. Additionally, while command buffer labels allow for beginning and ending across different command buffers, the debug messaging framework cannot guarantee that labels in pCmdBufLables will contain those defined outside of the associated command buffer. This is partially due to the fact that the association of one command buffer with another may not have been defined at the time the debug message is triggered.

Valid Usage (Implicit)
See Also

VkDebugUtilsLabelEXT, VkDebugUtilsObjectNameInfoEXT, SubmitDebugUtilsMessageEXT

Layout


struct VkDebugUtilsMessengerCallbackDataEXT {
    VkStructureType sType;
    void const * pNext;
    VkDebugUtilsMessengerCallbackDataFlagsEXT flags;
    char const * pMessageIdName;
    int32_t messageIdNumber;
    char const * pMessage;
    uint32_t queueLabelCount;
    VkDebugUtilsLabelEXT const * pQueueLabels;
    uint32_t cmdBufLabelCount;
    VkDebugUtilsLabelEXT const * pCmdBufLabels;
    uint32_t objectCount;
    VkDebugUtilsObjectNameInfoEXT const * pObjects;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkDebugUtilsMessengerCallbackDataEXT.Buffer

An array of VkDebugUtilsMessengerCallbackDataEXT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CMDBUFLABELCOUNT

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
MESSAGEIDNUMBER

The struct member offsets.

public static final int
OBJECTCOUNT

The struct member offsets.

public static final int
PCMDBUFLABELS

The struct member offsets.

public static final int
PMESSAGE

The struct member offsets.

public static final int
PMESSAGEIDNAME

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
POBJECTS

The struct member offsets.

public static final int
PQUEUELABELS

The struct member offsets.

public static final int
QUEUELABELCOUNT

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
VkDebugUtilsMessengerCallbackDataEXT(long address, ByteBuffer container)

public
VkDebugUtilsMessengerCallbackDataEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDebugUtilsMessengerCallbackDataEXT
calloc()

Returns a new VkDebugUtilsMessengerCallbackDataEXT instance allocated with memCalloc.

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

Returns a new VkDebugUtilsMessengerCallbackDataEXT.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDebugUtilsMessengerCallbackDataEXT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsMessengerCallbackDataEXT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsMessengerCallbackDataEXT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsMessengerCallbackDataEXT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
cmdBufLabelCount()

a count of items contained in the pCmdBufLabels array.

protected VkDebugUtilsMessengerCallbackDataEXT
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 VkDebugUtilsMessengerCallbackDataEXT
create()

Returns a new VkDebugUtilsMessengerCallbackDataEXT instance allocated with BufferUtils.

public static VkDebugUtilsMessengerCallbackDataEXT
create(long address)

Returns a new VkDebugUtilsMessengerCallbackDataEXT instance for the specified memory address.

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

Returns a new VkDebugUtilsMessengerCallbackDataEXT.Buffer instance allocated with BufferUtils.

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

Create a VkDebugUtilsMessengerCallbackDataEXT.Buffer instance at the specified memory.

public static VkDebugUtilsMessengerCallbackDataEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

0 and is reserved for future use.

public VkDebugUtilsMessengerCallbackDataEXT
flags(int value)

Sets the specified value to the flags field.

public static VkDebugUtilsMessengerCallbackDataEXT
malloc()

Returns a new VkDebugUtilsMessengerCallbackDataEXT instance allocated with memAlloc.

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

Returns a new VkDebugUtilsMessengerCallbackDataEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkDebugUtilsMessengerCallbackDataEXT instance allocated on the specified MemoryStack.

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

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

public static VkDebugUtilsMessengerCallbackDataEXT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsMessengerCallbackDataEXT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsMessengerCallbackDataEXT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsMessengerCallbackDataEXT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
messageIdNumber()

the ID number of the triggering message.

public VkDebugUtilsMessengerCallbackDataEXT
messageIdNumber(int value)

Sets the specified value to the messageIdNumber field.

public static int
ncmdBufLabelCount(long struct)

Unsafe version of cmdBufLabelCount.

public static void
ncmdBufLabelCount(long struct, int value)

Sets the specified value to the cmdBufLabelCount field of the specified struct.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static int
nmessageIdNumber(long struct)

Unsafe version of messageIdNumber.

public static void
nmessageIdNumber(long struct, int value)

Unsafe version of messageIdNumber.

public static int
nobjectCount(long struct)

Unsafe version of objectCount.

public static void
nobjectCount(long struct, int value)

Sets the specified value to the objectCount field of the specified struct.

public static VkDebugUtilsLabelEXT.Buffer
npCmdBufLabels(long struct)

Unsafe version of pCmdBufLabels.

public static void
npCmdBufLabels(long struct, VkDebugUtilsLabelEXT.Buffer value)

Unsafe version of pCmdBufLabels.

public static ByteBuffer
npMessage(long struct)

Unsafe version of pMessage.

public static void
npMessage(long struct, ByteBuffer value)

Unsafe version of pMessage.

public static ByteBuffer
npMessageIdName(long struct)

Unsafe version of pMessageIdName.

public static void
npMessageIdName(long struct, ByteBuffer value)

Unsafe version of pMessageIdName.

public static String
npMessageIdNameString(long struct)

Unsafe version of pMessageIdNameString.

public static String
npMessageString(long struct)

Unsafe version of pMessageString.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkDebugUtilsObjectNameInfoEXT.Buffer
npObjects(long struct)

Unsafe version of pObjects.

public static void
npObjects(long struct, VkDebugUtilsObjectNameInfoEXT.Buffer value)

Unsafe version of pObjects.

public static VkDebugUtilsLabelEXT.Buffer
npQueueLabels(long struct)

Unsafe version of pQueueLabels.

public static void
npQueueLabels(long struct, VkDebugUtilsLabelEXT.Buffer value)

Unsafe version of pQueueLabels.

public static int
nqueueLabelCount(long struct)

Unsafe version of queueLabelCount.

public static void
nqueueLabelCount(long struct, int value)

Sets the specified value to the queueLabelCount field of the specified struct.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public int
objectCount()

a count of items contained in the pObjects array.

public VkDebugUtilsLabelEXT.Buffer
pCmdBufLabels()

NULL or a pointer to an array of VkDebugUtilsLabelEXT active in the current VkCommandBuffer at the time the callback was triggered.

public VkDebugUtilsMessengerCallbackDataEXT
pCmdBufLabels(VkDebugUtilsLabelEXT.Buffer value)

Sets the address of the specified VkDebugUtilsLabelEXT.Buffer to the pCmdBufLabels field.

public ByteBuffer
pMessage()

a null-terminated string detailing the trigger conditions.

public VkDebugUtilsMessengerCallbackDataEXT
pMessage(ByteBuffer value)

Sets the address of the specified encoded string to the pMessage field.

public ByteBuffer
pMessageIdName()

a null-terminated string that identifies the particular message ID that is associated with the provided message.

public VkDebugUtilsMessengerCallbackDataEXT
pMessageIdName(ByteBuffer value)

Sets the address of the specified encoded string to the pMessageIdName field.

public String
pMessageIdNameString()

a null-terminated string that identifies the particular message ID that is associated with the provided message.

public String
pMessageString()

a null-terminated string detailing the trigger conditions.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDebugUtilsMessengerCallbackDataEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkDebugUtilsMessengerCallbackDataEXT
pNext(VkDeviceAddressBindingCallbackDataEXT value)

Prepends the specified VkDeviceAddressBindingCallbackDataEXT value to the pNext chain.

public VkDebugUtilsObjectNameInfoEXT.Buffer
pObjects()

a pointer to an array of VkDebugUtilsObjectNameInfoEXT objects related to the detected issue.

public VkDebugUtilsMessengerCallbackDataEXT
pObjects(VkDebugUtilsObjectNameInfoEXT.Buffer value)

Sets the address of the specified VkDebugUtilsObjectNameInfoEXT.Buffer to the pObjects field.

public VkDebugUtilsLabelEXT.Buffer
pQueueLabels()

NULL or a pointer to an array of VkDebugUtilsLabelEXT active in the current VkQueue at the time the callback was triggered.

public VkDebugUtilsMessengerCallbackDataEXT
pQueueLabels(VkDebugUtilsLabelEXT.Buffer value)

Sets the address of the specified VkDebugUtilsLabelEXT.Buffer to the pQueueLabels field.

public int
queueLabelCount()

a count of items contained in the pQueueLabels array.

public VkDebugUtilsMessengerCallbackDataEXT
set(int sType, long pNext, int flags, ByteBuffer pMessageIdName, int messageIdNumber, ByteBuffer pMessage, VkDebugUtilsLabelEXT.Buffer pQueueLabels, VkDebugUtilsLabelEXT.Buffer pCmdBufLabels, VkDebugUtilsObjectNameInfoEXT.Buffer pObjects)

Initializes this struct with the specified values.

public VkDebugUtilsMessengerCallbackDataEXT

Returns:

this struct
set(VkDebugUtilsMessengerCallbackDataEXT
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkDebugUtilsMessengerCallbackDataEXT
sType(int value)

Sets the specified value to the sType field.

public VkDebugUtilsMessengerCallbackDataEXT
sType$Default()

Sets the STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXT value to the sType field.

public static void
validate(long
the struct to validate
struct)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate