Package org.lwjgl.vulkan
Class VkDebugUtilsObjectNameInfoEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDebugUtilsObjectNameInfoEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkDebugUtilsObjectNameInfoEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Specify parameters of a name to give to an object.Description
Applications may change the name associated with an object simply by calling
vkSetDebugUtilsObjectNameEXT
again with a new string. IfpObjectName
is an empty string, then any previously set name is removed.Valid Usage
- If
objectType
isOBJECT_TYPE_UNKNOWN
,objectHandle
must not beNULL_HANDLE
- If
objectType
is notOBJECT_TYPE_UNKNOWN
,objectHandle
must beNULL_HANDLE
or a valid Vulkan handle of the type associated withobjectType
as defined in the VkObjectType and Vulkan Handle Relationship table
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT
pNext
must beNULL
objectType
must be a validVkObjectType
value- If
pObjectName
is notNULL
,pObjectName
must be a null-terminated UTF-8 string
See Also
VkDebugUtilsMessengerCallbackDataEXT
,SetDebugUtilsObjectNameEXT
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.objectType
– aVkObjectType
specifying the type of the object to be named.objectHandle
– the object to be named.pObjectName
– a null-terminated UTF-8 string specifying the name to apply toobjectHandle
.
Layout
struct VkDebugUtilsObjectNameInfoEXT { VkStructureType sType; void const * pNext; VkObjectType objectType; uint64_t objectHandle; char const * pObjectName; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDebugUtilsObjectNameInfoEXT.Buffer
An array ofVkDebugUtilsObjectNameInfoEXT
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
OBJECTHANDLE
OBJECTTYPE
PNEXT
POBJECTNAMEThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDebugUtilsObjectNameInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugUtilsObjectNameInfoEXT
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 VkDebugUtilsObjectNameInfoEXT
calloc()
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated withmemCalloc
.static VkDebugUtilsObjectNameInfoEXT.Buffer
calloc(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated withmemCalloc
.static VkDebugUtilsObjectNameInfoEXT
callocStack()
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugUtilsObjectNameInfoEXT.Buffer
callocStack(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugUtilsObjectNameInfoEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugUtilsObjectNameInfoEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugUtilsObjectNameInfoEXT
create()
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated withBufferUtils
.static VkDebugUtilsObjectNameInfoEXT.Buffer
create(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated withBufferUtils
.static VkDebugUtilsObjectNameInfoEXT
create(long address)
Returns a newVkDebugUtilsObjectNameInfoEXT
instance for the specified memory address.static VkDebugUtilsObjectNameInfoEXT.Buffer
create(long address, int capacity)
Create aVkDebugUtilsObjectNameInfoEXT.Buffer
instance at the specified memory.static VkDebugUtilsObjectNameInfoEXT
createSafe(long address)
static VkDebugUtilsObjectNameInfoEXT.Buffer
createSafe(long address, int capacity)
static VkDebugUtilsObjectNameInfoEXT
malloc()
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated withmemAlloc
.static VkDebugUtilsObjectNameInfoEXT.Buffer
malloc(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated withmemAlloc
.static VkDebugUtilsObjectNameInfoEXT
mallocStack()
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated on the thread-localMemoryStack
.static VkDebugUtilsObjectNameInfoEXT.Buffer
mallocStack(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkDebugUtilsObjectNameInfoEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkDebugUtilsObjectNameInfoEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated on the specifiedMemoryStack
.static long
nobjectHandle(long struct)
Unsafe version ofobjectHandle()
.static void
nobjectHandle(long struct, long value)
Unsafe version ofobjectHandle
.static int
nobjectType(long struct)
Unsafe version ofobjectType()
.static void
nobjectType(long struct, int value)
Unsafe version ofobjectType
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static java.nio.ByteBuffer
npObjectName(long struct)
Unsafe version ofpObjectName()
.static void
npObjectName(long struct, java.nio.ByteBuffer value)
Unsafe version ofpObjectName
.static java.lang.String
npObjectNameString(long struct)
Unsafe version ofpObjectNameString()
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.long
objectHandle()
Returns the value of theobjectHandle
field.VkDebugUtilsObjectNameInfoEXT
objectHandle(long value)
Sets the specified value to theobjectHandle
field.int
objectType()
Returns the value of theobjectType
field.VkDebugUtilsObjectNameInfoEXT
objectType(int value)
Sets the specified value to theobjectType
field.long
pNext()
Returns the value of thepNext
field.VkDebugUtilsObjectNameInfoEXT
pNext(long value)
Sets the specified value to thepNext
field.java.nio.ByteBuffer
pObjectName()
Returns aByteBuffer
view of the null-terminated string pointed to by thepObjectName
field.VkDebugUtilsObjectNameInfoEXT
pObjectName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thepObjectName
field.java.lang.String
pObjectNameString()
Decodes the null-terminated string pointed to by thepObjectName
field.VkDebugUtilsObjectNameInfoEXT
set(int sType, long pNext, int objectType, long objectHandle, java.nio.ByteBuffer pObjectName)
Initializes this struct with the specified values.VkDebugUtilsObjectNameInfoEXT
set(VkDebugUtilsObjectNameInfoEXT src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkDebugUtilsObjectNameInfoEXT
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkDebugUtilsObjectNameInfoEXT
public VkDebugUtilsObjectNameInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugUtilsObjectNameInfoEXT
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.
-
objectType
public int objectType()
Returns the value of theobjectType
field.
-
objectHandle
public long objectHandle()
Returns the value of theobjectHandle
field.
-
pObjectName
@Nullable public java.nio.ByteBuffer pObjectName()
Returns aByteBuffer
view of the null-terminated string pointed to by thepObjectName
field.
-
pObjectNameString
@Nullable public java.lang.String pObjectNameString()
Decodes the null-terminated string pointed to by thepObjectName
field.
-
sType
public VkDebugUtilsObjectNameInfoEXT sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDebugUtilsObjectNameInfoEXT pNext(long value)
Sets the specified value to thepNext
field.
-
objectType
public VkDebugUtilsObjectNameInfoEXT objectType(int value)
Sets the specified value to theobjectType
field.
-
objectHandle
public VkDebugUtilsObjectNameInfoEXT objectHandle(long value)
Sets the specified value to theobjectHandle
field.
-
pObjectName
public VkDebugUtilsObjectNameInfoEXT pObjectName(@Nullable java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thepObjectName
field.
-
set
public VkDebugUtilsObjectNameInfoEXT set(int sType, long pNext, int objectType, long objectHandle, @Nullable java.nio.ByteBuffer pObjectName)
Initializes this struct with the specified values.
-
set
public VkDebugUtilsObjectNameInfoEXT set(VkDebugUtilsObjectNameInfoEXT src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkDebugUtilsObjectNameInfoEXT malloc()
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDebugUtilsObjectNameInfoEXT calloc()
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDebugUtilsObjectNameInfoEXT create()
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated withBufferUtils
.
-
create
public static VkDebugUtilsObjectNameInfoEXT create(long address)
Returns a newVkDebugUtilsObjectNameInfoEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkDebugUtilsObjectNameInfoEXT createSafe(long address)
-
malloc
public static VkDebugUtilsObjectNameInfoEXT.Buffer malloc(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDebugUtilsObjectNameInfoEXT.Buffer calloc(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugUtilsObjectNameInfoEXT.Buffer create(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugUtilsObjectNameInfoEXT.Buffer create(long address, int capacity)
Create aVkDebugUtilsObjectNameInfoEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDebugUtilsObjectNameInfoEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDebugUtilsObjectNameInfoEXT mallocStack()
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDebugUtilsObjectNameInfoEXT callocStack()
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDebugUtilsObjectNameInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDebugUtilsObjectNameInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDebugUtilsObjectNameInfoEXT.Buffer mallocStack(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDebugUtilsObjectNameInfoEXT.Buffer callocStack(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDebugUtilsObjectNameInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDebugUtilsObjectNameInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXT.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()
.
-
nobjectType
public static int nobjectType(long struct)
Unsafe version ofobjectType()
.
-
nobjectHandle
public static long nobjectHandle(long struct)
Unsafe version ofobjectHandle()
.
-
npObjectName
@Nullable public static java.nio.ByteBuffer npObjectName(long struct)
Unsafe version ofpObjectName()
.
-
npObjectNameString
@Nullable public static java.lang.String npObjectNameString(long struct)
Unsafe version ofpObjectNameString()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nobjectType
public static void nobjectType(long struct, int value)
Unsafe version ofobjectType
.
-
nobjectHandle
public static void nobjectHandle(long struct, long value)
Unsafe version ofobjectHandle
.
-
npObjectName
public static void npObjectName(long struct, @Nullable java.nio.ByteBuffer value)
Unsafe version ofpObjectName
.
-
-