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.NativeResourceSpecify parameters of a name to give to an object.Description
Applications may change the name associated with an object simply by calling
vkSetDebugUtilsObjectNameEXTagain with a new string. IfpObjectNameis eitherNULLor an empty string, then any previously set name is removed.Valid Usage
- If
objectTypeisOBJECT_TYPE_UNKNOWN,objectHandlemust not beNULL_HANDLE - If
objectTypeis notOBJECT_TYPE_UNKNOWN,objectHandlemust beNULL_HANDLEor a valid Vulkan handle of the type associated withobjectTypeas defined in theVkObjectTypeand Vulkan Handle Relationship table
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXTpNextmust beNULLobjectTypemust be a validVkObjectTypevalue- If
pObjectNameis notNULL,pObjectNamemust be a null-terminated UTF-8 string
See Also
VkDebugUtilsMessengerCallbackDataEXT,SetDebugUtilsObjectNameEXTLayout
struct VkDebugUtilsObjectNameInfoEXT { VkStructureTypesType(); void const *pNext(); VkObjectTypeobjectType(); uint64_tobjectHandle(); char const *pObjectName(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkDebugUtilsObjectNameInfoEXT.BufferAn array ofVkDebugUtilsObjectNameInfoEXTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intOBJECTHANDLE
OBJECTTYPE
PNEXT
POBJECTNAMEThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDebugUtilsObjectNameInfoEXT(java.nio.ByteBuffer container)Creates aVkDebugUtilsObjectNameInfoEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkDebugUtilsObjectNameInfoEXTcalloc()Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated withmemCalloc.static VkDebugUtilsObjectNameInfoEXT.Buffercalloc(int capacity)Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated withmemCalloc.static VkDebugUtilsObjectNameInfoEXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDebugUtilsObjectNameInfoEXTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDebugUtilsObjectNameInfoEXTcallocStack()Deprecated.static VkDebugUtilsObjectNameInfoEXT.BuffercallocStack(int capacity)Deprecated.static VkDebugUtilsObjectNameInfoEXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDebugUtilsObjectNameInfoEXTcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkDebugUtilsObjectNameInfoEXTcreate()Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated withBufferUtils.static VkDebugUtilsObjectNameInfoEXT.Buffercreate(int capacity)Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated withBufferUtils.static VkDebugUtilsObjectNameInfoEXTcreate(long address)Returns a newVkDebugUtilsObjectNameInfoEXTinstance for the specified memory address.static VkDebugUtilsObjectNameInfoEXT.Buffercreate(long address, int capacity)Create aVkDebugUtilsObjectNameInfoEXT.Bufferinstance at the specified memory.static VkDebugUtilsObjectNameInfoEXTcreateSafe(long address)static VkDebugUtilsObjectNameInfoEXT.BuffercreateSafe(long address, int capacity)static VkDebugUtilsObjectNameInfoEXTmalloc()Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated withmemAlloc.static VkDebugUtilsObjectNameInfoEXT.Buffermalloc(int capacity)Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated withmemAlloc.static VkDebugUtilsObjectNameInfoEXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkDebugUtilsObjectNameInfoEXTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the specifiedMemoryStack.static VkDebugUtilsObjectNameInfoEXTmallocStack()Deprecated.static VkDebugUtilsObjectNameInfoEXT.BuffermallocStack(int capacity)Deprecated.static VkDebugUtilsObjectNameInfoEXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDebugUtilsObjectNameInfoEXTmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static longnobjectHandle(long struct)Unsafe version ofobjectHandle().static voidnobjectHandle(long struct, long value)Unsafe version ofobjectHandle.static intnobjectType(long struct)Unsafe version ofobjectType().static voidnobjectType(long struct, int value)Unsafe version ofobjectType.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static java.nio.ByteBuffernpObjectName(long struct)Unsafe version ofpObjectName().static voidnpObjectName(long struct, java.nio.ByteBuffer value)Unsafe version ofpObjectName.static java.lang.StringnpObjectNameString(long struct)Unsafe version ofpObjectNameString().static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longobjectHandle()the object to be named.VkDebugUtilsObjectNameInfoEXTobjectHandle(long value)Sets the specified value to theobjectHandle()field.intobjectType()aVkObjectTypespecifying the type of the object to be named.VkDebugUtilsObjectNameInfoEXTobjectType(int value)Sets the specified value to theobjectType()field.longpNext()NULLor a pointer to a structure extending this structure.VkDebugUtilsObjectNameInfoEXTpNext(long value)Sets the specified value to thepNext()field.java.nio.ByteBufferpObjectName()eitherNULLor a null-terminated UTF-8 string specifying the name to apply toobjectHandle.VkDebugUtilsObjectNameInfoEXTpObjectName(java.nio.ByteBuffer value)Sets the address of the specified encoded string to thepObjectName()field.java.lang.StringpObjectNameString()eitherNULLor a null-terminated UTF-8 string specifying the name to apply toobjectHandle.VkDebugUtilsObjectNameInfoEXTset(int sType, long pNext, int objectType, long objectHandle, java.nio.ByteBuffer pObjectName)Initializes this struct with the specified values.VkDebugUtilsObjectNameInfoEXTset(VkDebugUtilsObjectNameInfoEXT src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkDebugUtilsObjectNameInfoEXTsType(int value)Sets the specified value to thesType()field.VkDebugUtilsObjectNameInfoEXTsType$Default()Sets theSTRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXTvalue to thesType()field.
-
-
-
Constructor Detail
-
VkDebugUtilsObjectNameInfoEXT
public VkDebugUtilsObjectNameInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugUtilsObjectNameInfoEXTinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
objectType
public int objectType()
aVkObjectTypespecifying the type of the object to be named.
-
objectHandle
public long objectHandle()
the object to be named.
-
pObjectName, pObjectNameString
@Nullable public java.nio.ByteBuffer pObjectName() @Nullable public java.lang.String pObjectNameString()
eitherNULLor a null-terminated UTF-8 string specifying the name to apply toobjectHandle.
-
sType
public VkDebugUtilsObjectNameInfoEXT sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkDebugUtilsObjectNameInfoEXT sType$Default()
Sets theSTRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXTvalue 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 newVkDebugUtilsObjectNameInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDebugUtilsObjectNameInfoEXT calloc()
Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDebugUtilsObjectNameInfoEXT create()
Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated withBufferUtils.
-
create
public static VkDebugUtilsObjectNameInfoEXT create(long address)
Returns a newVkDebugUtilsObjectNameInfoEXTinstance for the specified memory address.
-
createSafe
@Nullable public static VkDebugUtilsObjectNameInfoEXT createSafe(long address)
-
malloc
public static VkDebugUtilsObjectNameInfoEXT.Buffer malloc(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDebugUtilsObjectNameInfoEXT.Buffer calloc(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDebugUtilsObjectNameInfoEXT.Buffer create(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDebugUtilsObjectNameInfoEXT.Buffer create(long address, int capacity)
Create aVkDebugUtilsObjectNameInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkDebugUtilsObjectNameInfoEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkDebugUtilsObjectNameInfoEXT mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDebugUtilsObjectNameInfoEXT callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDebugUtilsObjectNameInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDebugUtilsObjectNameInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDebugUtilsObjectNameInfoEXT.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkDebugUtilsObjectNameInfoEXT.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDebugUtilsObjectNameInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkDebugUtilsObjectNameInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkDebugUtilsObjectNameInfoEXT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkDebugUtilsObjectNameInfoEXT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDebugUtilsObjectNameInfoEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkDebugUtilsObjectNameInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand 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.
-
-