Class VkDebugUtilsMessengerCreateInfoEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDebugUtilsMessengerCreateInfoEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkDebugUtilsMessengerCreateInfoEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying parameters of a newly created debug messenger.Description
For each
VkDebugUtilsMessengerEXT
that is created theVkDebugUtilsMessengerCreateInfoEXT
::messageSeverity
andVkDebugUtilsMessengerCreateInfoEXT
::messageType
determine when thatVkDebugUtilsMessengerCreateInfoEXT
::pfnUserCallback
is called. The process to determine if the user'spfnUserCallback
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
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.flags
– 0 and reserved for future use.messageSeverity
– a bitmask ofVkDebugUtilsMessageSeverityFlagBitsEXT
specifying which severity of event(s) will cause this callback to be called.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
– user data to be passed to the callback.
Layout
struct VkDebugUtilsMessengerCreateInfoEXT { VkStructureType sType; void const * pNext; VkDebugUtilsMessengerCreateFlagsEXT flags; VkDebugUtilsMessageSeverityFlagsEXT messageSeverity; VkDebugUtilsMessageTypeFlagsEXT messageType;
PFN_vkDebugUtilsMessengerCallbackEXT
pfnUserCallback; void * pUserData; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDebugUtilsMessengerCreateInfoEXT.Buffer
An array ofVkDebugUtilsMessengerCreateInfoEXT
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
FLAGS
MESSAGESEVERITY
MESSAGETYPE
PFNUSERCALLBACK
PNEXT
PUSERDATAThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDebugUtilsMessengerCreateInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugUtilsMessengerCreateInfoEXT
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkDebugUtilsMessengerCreateInfoEXT
calloc()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withmemCalloc
.static VkDebugUtilsMessengerCreateInfoEXT.Buffer
calloc(int capacity)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withmemCalloc
.static VkDebugUtilsMessengerCreateInfoEXT
callocStack()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugUtilsMessengerCreateInfoEXT.Buffer
callocStack(int capacity)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugUtilsMessengerCreateInfoEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugUtilsMessengerCreateInfoEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugUtilsMessengerCreateInfoEXT
create()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withBufferUtils
.static VkDebugUtilsMessengerCreateInfoEXT.Buffer
create(int capacity)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withBufferUtils
.static VkDebugUtilsMessengerCreateInfoEXT
create(long address)
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance for the specified memory address.static VkDebugUtilsMessengerCreateInfoEXT.Buffer
create(long address, int capacity)
Create aVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance at the specified memory.static VkDebugUtilsMessengerCreateInfoEXT
createSafe(long address)
static VkDebugUtilsMessengerCreateInfoEXT.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkDebugUtilsMessengerCreateInfoEXT
flags(int value)
Sets the specified value to theflags
field.static VkDebugUtilsMessengerCreateInfoEXT
malloc()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withmemAlloc
.static VkDebugUtilsMessengerCreateInfoEXT.Buffer
malloc(int capacity)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withmemAlloc
.static VkDebugUtilsMessengerCreateInfoEXT
mallocStack()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the thread-localMemoryStack
.static VkDebugUtilsMessengerCreateInfoEXT.Buffer
mallocStack(int capacity)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkDebugUtilsMessengerCreateInfoEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkDebugUtilsMessengerCreateInfoEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the specifiedMemoryStack
.int
messageSeverity()
Returns the value of themessageSeverity
field.VkDebugUtilsMessengerCreateInfoEXT
messageSeverity(int value)
Sets the specified value to themessageSeverity
field.int
messageType()
Returns the value of themessageType
field.VkDebugUtilsMessengerCreateInfoEXT
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
.static VkDebugUtilsMessengerCallbackEXT
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
.VkDebugUtilsMessengerCallbackEXT
pfnUserCallback()
Returns the value of thepfnUserCallback
field.VkDebugUtilsMessengerCreateInfoEXT
pfnUserCallback(VkDebugUtilsMessengerCallbackEXTI value)
Sets the specified value to thepfnUserCallback
field.long
pNext()
Returns the value of thepNext
field.VkDebugUtilsMessengerCreateInfoEXT
pNext(long value)
Sets the specified value to thepNext
field.long
pUserData()
Returns the value of thepUserData
field.VkDebugUtilsMessengerCreateInfoEXT
pUserData(long value)
Sets the specified value to thepUserData
field.VkDebugUtilsMessengerCreateInfoEXT
set(int sType, long pNext, int flags, int messageSeverity, int messageType, VkDebugUtilsMessengerCallbackEXTI pfnUserCallback, long pUserData)
Initializes this struct with the specified values.VkDebugUtilsMessengerCreateInfoEXT
set(VkDebugUtilsMessengerCreateInfoEXT src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkDebugUtilsMessengerCreateInfoEXT
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkDebugUtilsMessengerCreateInfoEXT
public VkDebugUtilsMessengerCreateInfoEXT(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
messageSeverity
public int messageSeverity()
Returns the value of themessageSeverity
field.
-
messageType
public int messageType()
Returns the value of themessageType
field.
-
pfnUserCallback
public VkDebugUtilsMessengerCallbackEXT pfnUserCallback()
Returns the value of thepfnUserCallback
field.
-
pUserData
public long pUserData()
Returns the value of thepUserData
field.
-
sType
public VkDebugUtilsMessengerCreateInfoEXT sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDebugUtilsMessengerCreateInfoEXT pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkDebugUtilsMessengerCreateInfoEXT flags(int value)
Sets the specified value to theflags
field.
-
messageSeverity
public VkDebugUtilsMessengerCreateInfoEXT messageSeverity(int value)
Sets the specified value to themessageSeverity
field.
-
messageType
public VkDebugUtilsMessengerCreateInfoEXT messageType(int value)
Sets the specified value to themessageType
field.
-
pfnUserCallback
public VkDebugUtilsMessengerCreateInfoEXT pfnUserCallback(VkDebugUtilsMessengerCallbackEXTI value)
Sets the specified value to thepfnUserCallback
field.
-
pUserData
public VkDebugUtilsMessengerCreateInfoEXT pUserData(long value)
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
public VkDebugUtilsMessengerCreateInfoEXT set(VkDebugUtilsMessengerCreateInfoEXT src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkDebugUtilsMessengerCreateInfoEXT malloc()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDebugUtilsMessengerCreateInfoEXT calloc()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDebugUtilsMessengerCreateInfoEXT create()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated withBufferUtils
.
-
create
public static VkDebugUtilsMessengerCreateInfoEXT create(long address)
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkDebugUtilsMessengerCreateInfoEXT createSafe(long address)
-
malloc
public static VkDebugUtilsMessengerCreateInfoEXT.Buffer malloc(int capacity)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDebugUtilsMessengerCreateInfoEXT.Buffer calloc(int capacity)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugUtilsMessengerCreateInfoEXT.Buffer create(int capacity)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugUtilsMessengerCreateInfoEXT.Buffer create(long address, int capacity)
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
public static VkDebugUtilsMessengerCreateInfoEXT mallocStack()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDebugUtilsMessengerCreateInfoEXT callocStack()
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDebugUtilsMessengerCreateInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDebugUtilsMessengerCreateInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsMessengerCreateInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDebugUtilsMessengerCreateInfoEXT.Buffer mallocStack(int capacity)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDebugUtilsMessengerCreateInfoEXT.Buffer callocStack(int capacity)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDebugUtilsMessengerCreateInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDebugUtilsMessengerCreateInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsMessengerCreateInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
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
public static VkDebugUtilsMessengerCallbackEXT npfnUserCallback(long struct)
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
public static void npfnUserCallback(long struct, VkDebugUtilsMessengerCallbackEXTI value)
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
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-