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 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 the VkObjectType and 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,SetDebugUtilsObjectNameEXTMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.objectType– aVkObjectTypespecifying 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 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 Modifier and Type Method Description static VkDebugUtilsObjectNameInfoEXTcalloc()Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated withmemCalloc.static VkDebugUtilsObjectNameInfoEXT.Buffercalloc(int capacity)Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated withmemCalloc.static VkDebugUtilsObjectNameInfoEXTcallocStack()Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDebugUtilsObjectNameInfoEXT.BuffercallocStack(int capacity)Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDebugUtilsObjectNameInfoEXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDebugUtilsObjectNameInfoEXTcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.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 VkDebugUtilsObjectNameInfoEXTmallocStack()Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the thread-localMemoryStack.static VkDebugUtilsObjectNameInfoEXT.BuffermallocStack(int capacity)Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated on the thread-localMemoryStack.static VkDebugUtilsObjectNameInfoEXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkDebugUtilsObjectNameInfoEXTmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the specifiedMemoryStack.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()Returns the value of theobjectHandlefield.VkDebugUtilsObjectNameInfoEXTobjectHandle(long value)Sets the specified value to theobjectHandlefield.intobjectType()Returns the value of theobjectTypefield.VkDebugUtilsObjectNameInfoEXTobjectType(int value)Sets the specified value to theobjectTypefield.longpNext()Returns the value of thepNextfield.VkDebugUtilsObjectNameInfoEXTpNext(long value)Sets the specified value to thepNextfield.java.nio.ByteBufferpObjectName()Returns aByteBufferview of the null-terminated string pointed to by thepObjectNamefield.VkDebugUtilsObjectNameInfoEXTpObjectName(java.nio.ByteBuffer value)Sets the address of the specified encoded string to thepObjectNamefield.java.lang.StringpObjectNameString()Decodes the null-terminated string pointed to by thepObjectNamefield.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()Returns the value of thesTypefield.VkDebugUtilsObjectNameInfoEXTsType(int value)Sets the specified value to thesTypefield.
-
-
-
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()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
objectType
public int objectType()
Returns the value of theobjectTypefield.
-
objectHandle
public long objectHandle()
Returns the value of theobjectHandlefield.
-
pObjectName
@Nullable public java.nio.ByteBuffer pObjectName()
Returns aByteBufferview of the null-terminated string pointed to by thepObjectNamefield.
-
pObjectNameString
@Nullable public java.lang.String pObjectNameString()
Decodes the null-terminated string pointed to by thepObjectNamefield.
-
sType
public VkDebugUtilsObjectNameInfoEXT sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkDebugUtilsObjectNameInfoEXT pNext(long value)
Sets the specified value to thepNextfield.
-
objectType
public VkDebugUtilsObjectNameInfoEXT objectType(int value)
Sets the specified value to theobjectTypefield.
-
objectHandle
public VkDebugUtilsObjectNameInfoEXT objectHandle(long value)
Sets the specified value to theobjectHandlefield.
-
pObjectName
public VkDebugUtilsObjectNameInfoEXT pObjectName(@Nullable java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thepObjectNamefield.
-
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
public static VkDebugUtilsObjectNameInfoEXT mallocStack()
Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkDebugUtilsObjectNameInfoEXT callocStack()
Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkDebugUtilsObjectNameInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectNameInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkDebugUtilsObjectNameInfoEXT callocStack(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
-
mallocStack
public static VkDebugUtilsObjectNameInfoEXT.Buffer mallocStack(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkDebugUtilsObjectNameInfoEXT.Buffer callocStack(int capacity)
Returns a newVkDebugUtilsObjectNameInfoEXT.Bufferinstance allocated on the thread-localMemoryStackand 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.Bufferinstance 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.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.
-
-