Package org.lwjgl.vulkan

Class VkDebugUtilsObjectNameInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDebugUtilsObjectNameInfoEXT>

org.lwjgl.vulkan.VkDebugUtilsObjectNameInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkDebugUtilsObjectNameInfoEXT
extends org.lwjgl.system.Struct<VkDebugUtilsObjectNameInfoEXT>
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. If pObjectName is either NULL or an empty string, then any previously set name is removed.

The graphicsPipelineLibrary feature allows the specification of pipelines without the creation of VkShaderModule objects beforehand. In order to continue to allow naming these shaders independently, VkDebugUtilsObjectNameInfoEXT can be included in the pNext chain of VkPipelineShaderStageCreateInfo, which associates a static name with that particular shader.

Valid Usage

• If objectType is OBJECT_TYPE_UNKNOWN, objectHandle must not be NULL_HANDLE
• If objectType is not OBJECT_TYPE_UNKNOWN, objectHandle must be NULL_HANDLE or a valid Vulkan handle of the type associated with objectType as defined in the VkObjectType and Vulkan Handle Relationship table

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT
• objectType must be a valid VkObjectType value
• If pObjectName is not NULL, pObjectName must be a null-terminated UTF-8 string

See Also

VkDebugUtilsMessengerCallbackDataEXT, SetDebugUtilsObjectNameEXT

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 of VkDebugUtilsObjectNameInfoEXT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	OBJECTHANDLE	The struct member offsets.
static final int	OBJECTTYPE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	POBJECTNAME	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDebugUtilsObjectNameInfoEXT(ByteBuffer container)	Creates a VkDebugUtilsObjectNameInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDebugUtilsObjectNameInfoEXT	calloc()	Returns a new VkDebugUtilsObjectNameInfoEXT instance allocated with memCalloc.
static VkDebugUtilsObjectNameInfoEXT.Buffer	calloc(int capacity)	Returns a new VkDebugUtilsObjectNameInfoEXT.Buffer instance allocated with memCalloc.
static VkDebugUtilsObjectNameInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDebugUtilsObjectNameInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDebugUtilsObjectNameInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDebugUtilsObjectNameInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDebugUtilsObjectNameInfoEXT	callocStack()	Deprecated.
static VkDebugUtilsObjectNameInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkDebugUtilsObjectNameInfoEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDebugUtilsObjectNameInfoEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDebugUtilsObjectNameInfoEXT	create()	Returns a new VkDebugUtilsObjectNameInfoEXT instance allocated with BufferUtils.
static VkDebugUtilsObjectNameInfoEXT.Buffer	create(int capacity)	Returns a new VkDebugUtilsObjectNameInfoEXT.Buffer instance allocated with BufferUtils.
static VkDebugUtilsObjectNameInfoEXT	create(long address)	Returns a new VkDebugUtilsObjectNameInfoEXT instance for the specified memory address.
static VkDebugUtilsObjectNameInfoEXT.Buffer	create(long address, int capacity)	Create a VkDebugUtilsObjectNameInfoEXT.Buffer instance at the specified memory.
static @Nullable VkDebugUtilsObjectNameInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDebugUtilsObjectNameInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDebugUtilsObjectNameInfoEXT	malloc()	Returns a new VkDebugUtilsObjectNameInfoEXT instance allocated with memAlloc.
static VkDebugUtilsObjectNameInfoEXT.Buffer	malloc(int capacity)	Returns a new VkDebugUtilsObjectNameInfoEXT.Buffer instance allocated with memAlloc.
static VkDebugUtilsObjectNameInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDebugUtilsObjectNameInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkDebugUtilsObjectNameInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDebugUtilsObjectNameInfoEXT instance allocated on the specified MemoryStack.
static VkDebugUtilsObjectNameInfoEXT	mallocStack()	Deprecated.
static VkDebugUtilsObjectNameInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkDebugUtilsObjectNameInfoEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDebugUtilsObjectNameInfoEXT	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	nobjectHandle(long struct)	Unsafe version of objectHandle().
static void	nobjectHandle(long struct, long value)	Unsafe version of objectHandle.
static int	nobjectType(long struct)	Unsafe version of objectType().
static void	nobjectType(long struct, int value)	Unsafe version of objectType.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable ByteBuffer	npObjectName(long struct)	Unsafe version of pObjectName().
static void	npObjectName(long struct, @Nullable ByteBuffer value)	Unsafe version of pObjectName.
static @Nullable String	npObjectNameString(long struct)	Unsafe version of pObjectNameString().
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	objectHandle()	the object to be named.
VkDebugUtilsObjectNameInfoEXT	objectHandle(long value)	Sets the specified value to the objectHandle() field.
int	objectType()	a VkObjectType specifying the type of the object to be named.
VkDebugUtilsObjectNameInfoEXT	objectType(int value)	Sets the specified value to the objectType() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDebugUtilsObjectNameInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
@Nullable ByteBuffer	pObjectName()	either NULL or a null-terminated UTF-8 string specifying the name to apply to objectHandle.
VkDebugUtilsObjectNameInfoEXT	pObjectName(@Nullable ByteBuffer value)	Sets the address of the specified encoded string to the pObjectName() field.
@Nullable String	pObjectNameString()	either NULL or a null-terminated UTF-8 string specifying the name to apply to objectHandle.
VkDebugUtilsObjectNameInfoEXT	set(int sType, long pNext, int objectType, long objectHandle, @Nullable 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()	a VkStructureType value identifying this structure.
VkDebugUtilsObjectNameInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkDebugUtilsObjectNameInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

OBJECTTYPE

public static final int OBJECTTYPE

The struct member offsets.

OBJECTHANDLE

public static final int OBJECTHANDLE

The struct member offsets.

POBJECTNAME

public static final int POBJECTNAME

The struct member offsets.

Constructor Details

VkDebugUtilsObjectNameInfoEXT

public VkDebugUtilsObjectNameInfoEXT(ByteBuffer container)

Creates a VkDebugUtilsObjectNameInfoEXT instance at the current position of the specified ByteBuffer 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkDebugUtilsObjectNameInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

objectType

public int objectType()

a VkObjectType specifying the type of the object to be named.

objectHandle

public long objectHandle()

the object to be named.

pObjectName

public @Nullable ByteBuffer pObjectName()

either NULL or a null-terminated UTF-8 string specifying the name to apply to objectHandle.

pObjectNameString

public @Nullable String pObjectNameString()

either NULL or a null-terminated UTF-8 string specifying the name to apply to objectHandle.

sType

public VkDebugUtilsObjectNameInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDebugUtilsObjectNameInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT value to the sType() field.

pNext

public VkDebugUtilsObjectNameInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

objectType

public VkDebugUtilsObjectNameInfoEXT objectType(int value)

Sets the specified value to the objectType() field.

objectHandle

public VkDebugUtilsObjectNameInfoEXT objectHandle(long value)

Sets the specified value to the objectHandle() field.

pObjectName

public VkDebugUtilsObjectNameInfoEXT pObjectName(@Nullable ByteBuffer value)

Sets the address of the specified encoded string to the pObjectName() field.

set

public VkDebugUtilsObjectNameInfoEXT set(int sType,
 long pNext,
 int objectType,
 long objectHandle,
 @Nullable 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 new VkDebugUtilsObjectNameInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkDebugUtilsObjectNameInfoEXT calloc()

Returns a new VkDebugUtilsObjectNameInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkDebugUtilsObjectNameInfoEXT create()

Returns a new VkDebugUtilsObjectNameInfoEXT instance allocated with BufferUtils.

create

public static VkDebugUtilsObjectNameInfoEXT create(long address)

Returns a new VkDebugUtilsObjectNameInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkDebugUtilsObjectNameInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDebugUtilsObjectNameInfoEXT.Buffer malloc(int capacity)

Returns a new VkDebugUtilsObjectNameInfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkDebugUtilsObjectNameInfoEXT.Buffer calloc(int capacity)

Returns a new VkDebugUtilsObjectNameInfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkDebugUtilsObjectNameInfoEXT.Buffer create(int capacity)

Returns a new VkDebugUtilsObjectNameInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkDebugUtilsObjectNameInfoEXT.Buffer create(long address,
 int capacity)

Create a VkDebugUtilsObjectNameInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkDebugUtilsObjectNameInfoEXT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDebugUtilsObjectNameInfoEXT mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkDebugUtilsObjectNameInfoEXT callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkDebugUtilsObjectNameInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkDebugUtilsObjectNameInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkDebugUtilsObjectNameInfoEXT.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkDebugUtilsObjectNameInfoEXT.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(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. Use malloc(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. Use calloc(int, MemoryStack) instead.

malloc

public static VkDebugUtilsObjectNameInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDebugUtilsObjectNameInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDebugUtilsObjectNameInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDebugUtilsObjectNameInfoEXT instance allocated on the specified MemoryStack and 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 new VkDebugUtilsObjectNameInfoEXT.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDebugUtilsObjectNameInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkDebugUtilsObjectNameInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nobjectType

public static int nobjectType(long struct)

Unsafe version of objectType().

nobjectHandle

public static long nobjectHandle(long struct)

Unsafe version of objectHandle().

npObjectName

public static @Nullable ByteBuffer npObjectName(long struct)

Unsafe version of pObjectName().

npObjectNameString

public static @Nullable String npObjectNameString(long struct)

Unsafe version of pObjectNameString().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nobjectType

public static void nobjectType(long struct,
 int value)

Unsafe version of objectType.

nobjectHandle

public static void nobjectHandle(long struct,
 long value)

Unsafe version of objectHandle.

npObjectName

public static void npObjectName(long struct,
 @Nullable ByteBuffer value)

Unsafe version of pObjectName.