Package org.lwjgl.vulkan

Class VkDebugMarkerObjectNameInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDebugMarkerObjectNameInfoEXT>

org.lwjgl.vulkan.VkDebugMarkerObjectNameInfoEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDebugMarkerObjectNameInfoEXT
extends Struct<VkDebugMarkerObjectNameInfoEXT>
implements NativeResource

Specify parameters of a name to give to an object.

Description

Applications may change the name associated with an object simply by calling vkDebugMarkerSetObjectNameEXT again with a new string. To remove a previously set name, pObjectName should be set to an empty string.

Valid Usage

• objectType must not be DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT
• object must not be NULL_HANDLE
• object must be a Vulkan object of the type associated with objectType as defined in VkDebugReportObjectTypeEXT and Vulkan Handle Relationship

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT
• pNext must be NULL
• objectType must be a valid VkDebugReportObjectTypeEXT value
• pObjectName must be a null-terminated UTF-8 string

See Also

DebugMarkerSetObjectNameEXT

Layout

 struct VkDebugMarkerObjectNameInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkDebugReportObjectTypeEXT objectType();
     uint64_t object();
     char const * pObjectName();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDebugMarkerObjectNameInfoEXT.Buffer	An array of VkDebugMarkerObjectNameInfoEXT structs.

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	OBJECT	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
VkDebugMarkerObjectNameInfoEXT(ByteBuffer container)	Creates a VkDebugMarkerObjectNameInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDebugMarkerObjectNameInfoEXT	calloc()	Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated with memCalloc.
static VkDebugMarkerObjectNameInfoEXT.Buffer	calloc(int capacity)	Returns a new VkDebugMarkerObjectNameInfoEXT.Buffer instance allocated with memCalloc.
static VkDebugMarkerObjectNameInfoEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDebugMarkerObjectNameInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDebugMarkerObjectNameInfoEXT	calloc(MemoryStack stack)	Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDebugMarkerObjectNameInfoEXT	callocStack()	Deprecated.
static VkDebugMarkerObjectNameInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkDebugMarkerObjectNameInfoEXT.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDebugMarkerObjectNameInfoEXT	callocStack(MemoryStack stack)	Deprecated.
static VkDebugMarkerObjectNameInfoEXT	create()	Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated with BufferUtils.
static VkDebugMarkerObjectNameInfoEXT.Buffer	create(int capacity)	Returns a new VkDebugMarkerObjectNameInfoEXT.Buffer instance allocated with BufferUtils.
static VkDebugMarkerObjectNameInfoEXT	create(long address)	Returns a new VkDebugMarkerObjectNameInfoEXT instance for the specified memory address.
static VkDebugMarkerObjectNameInfoEXT.Buffer	create(long address, int capacity)	Create a VkDebugMarkerObjectNameInfoEXT.Buffer instance at the specified memory.
static VkDebugMarkerObjectNameInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkDebugMarkerObjectNameInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDebugMarkerObjectNameInfoEXT	malloc()	Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated with memAlloc.
static VkDebugMarkerObjectNameInfoEXT.Buffer	malloc(int capacity)	Returns a new VkDebugMarkerObjectNameInfoEXT.Buffer instance allocated with memAlloc.
static VkDebugMarkerObjectNameInfoEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDebugMarkerObjectNameInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkDebugMarkerObjectNameInfoEXT	malloc(MemoryStack stack)	Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated on the specified MemoryStack.
static VkDebugMarkerObjectNameInfoEXT	mallocStack()	Deprecated.
static VkDebugMarkerObjectNameInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkDebugMarkerObjectNameInfoEXT.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDebugMarkerObjectNameInfoEXT	mallocStack(MemoryStack stack)	Deprecated.
static long	nobject(long struct)	Unsafe version of object().
static void	nobject(long struct, long value)	Unsafe version of object.
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 ByteBuffer	npObjectName(long struct)	Unsafe version of pObjectName().
static void	npObjectName(long struct, ByteBuffer value)	Unsafe version of pObjectName.
static 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	object()	the object to be named.
VkDebugMarkerObjectNameInfoEXT	object(long value)	Sets the specified value to the object() field.
int	objectType()	a VkDebugReportObjectTypeEXT specifying the type of the object to be named.
VkDebugMarkerObjectNameInfoEXT	objectType(int value)	Sets the specified value to the objectType() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDebugMarkerObjectNameInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
ByteBuffer	pObjectName()	a null-terminated UTF-8 string specifying the name to apply to object.
VkDebugMarkerObjectNameInfoEXT	pObjectName(ByteBuffer value)	Sets the address of the specified encoded string to the pObjectName() field.
String	pObjectNameString()	a null-terminated UTF-8 string specifying the name to apply to object.
VkDebugMarkerObjectNameInfoEXT	set(int sType, long pNext, int objectType, long object, ByteBuffer pObjectName)	Initializes this struct with the specified values.
VkDebugMarkerObjectNameInfoEXT	set(VkDebugMarkerObjectNameInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkDebugMarkerObjectNameInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkDebugMarkerObjectNameInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

OBJECT

public static final int OBJECT

The struct member offsets.

POBJECTNAME

public static final int POBJECTNAME

The struct member offsets.

Constructor Details

VkDebugMarkerObjectNameInfoEXT

public VkDebugMarkerObjectNameInfoEXT(ByteBuffer container)

Creates a VkDebugMarkerObjectNameInfoEXT 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDebugMarkerObjectNameInfoEXT>

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 VkDebugReportObjectTypeEXT specifying the type of the object to be named.

object

public long object()

the object to be named.

pObjectName

public ByteBuffer pObjectName()

a null-terminated UTF-8 string specifying the name to apply to object.

pObjectNameString

public String pObjectNameString()

a null-terminated UTF-8 string specifying the name to apply to object.

sType

public VkDebugMarkerObjectNameInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDebugMarkerObjectNameInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT value to the sType() field.

pNext

public VkDebugMarkerObjectNameInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

objectType

public VkDebugMarkerObjectNameInfoEXT objectType(int value)

Sets the specified value to the objectType() field.

object

public VkDebugMarkerObjectNameInfoEXT object(long value)

Sets the specified value to the object() field.

pObjectName

public VkDebugMarkerObjectNameInfoEXT pObjectName(ByteBuffer value)

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

set

public VkDebugMarkerObjectNameInfoEXT set(int sType,
 long pNext,
 int objectType,
 long object,
 ByteBuffer pObjectName)

Initializes this struct with the specified values.

set

public VkDebugMarkerObjectNameInfoEXT set(VkDebugMarkerObjectNameInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDebugMarkerObjectNameInfoEXT malloc()

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

calloc

public static VkDebugMarkerObjectNameInfoEXT calloc()

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

create

public static VkDebugMarkerObjectNameInfoEXT create()

Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated with BufferUtils.

create

public static VkDebugMarkerObjectNameInfoEXT create(long address)

Returns a new VkDebugMarkerObjectNameInfoEXT instance for the specified memory address.

createSafe

@Nullable
public static VkDebugMarkerObjectNameInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDebugMarkerObjectNameInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDebugMarkerObjectNameInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDebugMarkerObjectNameInfoEXT.Buffer create(int capacity)

Returns a new VkDebugMarkerObjectNameInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDebugMarkerObjectNameInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDebugMarkerObjectNameInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDebugMarkerObjectNameInfoEXT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDebugMarkerObjectNameInfoEXT mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDebugMarkerObjectNameInfoEXT callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkDebugMarkerObjectNameInfoEXT.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDebugMarkerObjectNameInfoEXT.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkDebugMarkerObjectNameInfoEXT malloc(MemoryStack stack)

Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDebugMarkerObjectNameInfoEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDebugMarkerObjectNameInfoEXT.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new VkDebugMarkerObjectNameInfoEXT.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDebugMarkerObjectNameInfoEXT.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkDebugMarkerObjectNameInfoEXT.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().

nobject

public static long nobject(long struct)

Unsafe version of object().

npObjectName

public static ByteBuffer npObjectName(long struct)

Unsafe version of pObjectName().

npObjectNameString

public static 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.

nobject

public static void nobject(long struct,
 long value)

Unsafe version of object.

npObjectName

public static void npObjectName(long struct,
 ByteBuffer value)

Unsafe version of pObjectName.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate