Class VkDebugUtilsMessengerCreateInfoEXT
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
Description
For each VkDebugUtilsMessengerEXT
that is created the VkDebugUtilsMessengerCreateInfoEXT
::messageSeverity
and VkDebugUtilsMessengerCreateInfoEXT
::messageType
determine when that VkDebugUtilsMessengerCreateInfoEXT
::pfnUserCallback
is called. The process to determine if the user’s pfnUserCallback
is triggered when an event occurs is as follows:
- The implementation will perform a bitwise AND of the event’s
VkDebugUtilsMessageSeverityFlagBitsEXT
with themessageSeverity
provided during creation of theVkDebugUtilsMessengerEXT
object.- If the value is 0, the message is skipped.
- The implementation will perform bitwise AND of the event’s
VkDebugUtilsMessageTypeFlagBitsEXT
with themessageType
provided during the creation of theVkDebugUtilsMessengerEXT
object.- If the value is 0, the message is skipped.
- The callback will trigger a debug message for the current event
The callback will come directly from the component that detected the event, unless some other layer intercepts the calls for its own purposes (filter them in a different way, log to a system error log, etc.).
An application can receive multiple callbacks if multiple VkDebugUtilsMessengerEXT
objects are created. A callback will always be executed in the same thread as the originating Vulkan call.
A callback can be called from multiple threads simultaneously (if the application is making Vulkan calls from multiple threads).
Valid Usage
pfnUserCallback
must be a validVkDebugUtilsMessengerCallbackEXT
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT
flags
must be 0messageSeverity
must be a valid combination ofVkDebugUtilsMessageSeverityFlagBitsEXT
valuesmessageSeverity
must not be 0messageType
must be a valid combination ofVkDebugUtilsMessageTypeFlagBitsEXT
valuesmessageType
must not be 0pfnUserCallback
must be a validVkDebugUtilsMessengerCallbackEXT
value
See Also
VkDebugUtilsMessengerCallbackEXT
, CreateDebugUtilsMessengerEXT
Layout
struct VkDebugUtilsMessengerCreateInfoEXT {
VkStructureType sType()
;
void const * pNext()
;
VkDebugUtilsMessengerCreateFlagsEXT flags()
;
VkDebugUtilsMessageSeverityFlagsEXT messageSeverity()
;
VkDebugUtilsMessageTypeFlagsEXT messageType()
;
PFN_vkDebugUtilsMessengerCallbackEXT
pfnUserCallback()
;
void * pUserData()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkDebugUtilsMessengerCreateInfoEXT
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkDebugUtilsMessengerCreateInfoEXT
(ByteBuffer container) Creates aVkDebugUtilsMessengerCreateInfoEXT
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance for the specified memory address.create
(long address, int capacity) Create aVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
flags()
0 and is reserved for future use.flags
(int value) Sets the specified value to theflags()
field.malloc()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.int
a bitmask ofVkDebugUtilsMessageSeverityFlagBitsEXT
specifying which severity of event(s) will cause this callback to be called.messageSeverity
(int value) Sets the specified value to themessageSeverity()
field.int
a bitmask ofVkDebugUtilsMessageTypeFlagBitsEXT
specifying which type of event(s) will cause this callback to be called.messageType
(int value) Sets the specified value to themessageType()
field.static int
nflags
(long struct) Unsafe version offlags()
.static void
nflags
(long struct, int value) Unsafe version offlags
.static int
nmessageSeverity
(long struct) Unsafe version ofmessageSeverity()
.static void
nmessageSeverity
(long struct, int value) Unsafe version ofmessageSeverity
.static int
nmessageType
(long struct) Unsafe version ofmessageType()
.static void
nmessageType
(long struct, int value) Unsafe version ofmessageType
.npfnUserCallback
(long struct) Unsafe version ofpfnUserCallback()
.static void
npfnUserCallback
(long struct, VkDebugUtilsMessengerCallbackEXTI value) Unsafe version ofpfnUserCallback
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static long
npUserData
(long struct) Unsafe version ofpUserData()
.static void
npUserData
(long struct, long value) Unsafe version ofpUserData
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.the application callback function to call.Sets the specified value to thepfnUserCallback()
field.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.long
user data to be passed to the callback.pUserData
(long value) Sets the specified value to thepUserData()
field.set
(int sType, long pNext, int flags, int messageSeverity, int messageType, VkDebugUtilsMessengerCallbackEXTI pfnUserCallback, long pUserData) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT
value to thesType()
field.static void
validate
(long struct) Validates pointer members that should not beNULL
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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. -
MESSAGESEVERITY
public static final int MESSAGESEVERITYThe struct member offsets. -
MESSAGETYPE
public static final int MESSAGETYPEThe struct member offsets. -
PFNUSERCALLBACK
public static final int PFNUSERCALLBACKThe struct member offsets. -
PUSERDATA
public static final int PUSERDATAThe struct member offsets.
-
-
Constructor Details
-
VkDebugUtilsMessengerCreateInfoEXT
Creates aVkDebugUtilsMessengerCreateInfoEXT
instance at the current position of the specifiedByteBuffer
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkDebugUtilsMessengerCreateInfoEXT>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
flags
public int flags()0 and is reserved for future use. -
messageSeverity
public int messageSeverity()a bitmask ofVkDebugUtilsMessageSeverityFlagBitsEXT
specifying which severity of event(s) will cause this callback to be called. -
messageType
public int messageType()a bitmask ofVkDebugUtilsMessageTypeFlagBitsEXT
specifying which type of event(s) will cause this callback to be called. -
pfnUserCallback
the application callback function to call. -
pUserData
public long pUserData()user data to be passed to the callback. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
flags
Sets the specified value to theflags()
field. -
messageSeverity
Sets the specified value to themessageSeverity()
field. -
messageType
Sets the specified value to themessageType()
field. -
pfnUserCallback
Sets the specified value to thepfnUserCallback()
field. -
pUserData
Sets the specified value to thepUserData()
field. -
set
public VkDebugUtilsMessengerCreateInfoEXT set(int sType, long pNext, int flags, int messageSeverity, int messageType, VkDebugUtilsMessengerCallbackEXTI pfnUserCallback, long pUserData) 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 newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withBufferUtils
. -
create
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDebugUtilsMessengerCreateInfoEXT.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkDebugUtilsMessengerCreateInfoEXT.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkDebugUtilsMessengerCreateInfoEXT.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and 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()
. -
nmessageSeverity
public static int nmessageSeverity(long struct) Unsafe version ofmessageSeverity()
. -
nmessageType
public static int nmessageType(long struct) Unsafe version ofmessageType()
. -
npfnUserCallback
Unsafe version ofpfnUserCallback()
. -
npUserData
public static long npUserData(long struct) Unsafe version ofpUserData()
. -
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
. -
nmessageSeverity
public static void nmessageSeverity(long struct, int value) Unsafe version ofmessageSeverity
. -
nmessageType
public static void nmessageType(long struct, int value) Unsafe version ofmessageType
. -
npfnUserCallback
Unsafe version ofpfnUserCallback
. -
npUserData
public static void npUserData(long struct, long value) Unsafe version ofpUserData
. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-