Package org.lwjgl.vulkan
Class VkDebugMarkerObjectNameInfoEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDebugMarkerObjectNameInfoEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkDebugMarkerObjectNameInfoEXT 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
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 beDEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT
object
must not beNULL_HANDLE
object
must be a Vulkan object of the type associated withobjectType
as defined inVkDebugReportObjectTypeEXT
and Vulkan Handle Relationship.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT
pNext
must beNULL
objectType
must be a validVkDebugReportObjectTypeEXT
valuepObjectName
must be a null-terminated UTF-8 string
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.objectType
– aVkDebugReportObjectTypeEXT
specifying the type of the object to be named.object
– the object to be named.pObjectName
– a null-terminated UTF-8 string specifying the name to apply toobject
.
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 ofVkDebugMarkerObjectNameInfoEXT
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
OBJECT
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 VkDebugMarkerObjectNameInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugMarkerObjectNameInfoEXT
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 VkDebugMarkerObjectNameInfoEXT
calloc()
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated withmemCalloc
.static VkDebugMarkerObjectNameInfoEXT.Buffer
calloc(int capacity)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated withmemCalloc
.static VkDebugMarkerObjectNameInfoEXT
callocStack()
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugMarkerObjectNameInfoEXT.Buffer
callocStack(int capacity)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugMarkerObjectNameInfoEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugMarkerObjectNameInfoEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugMarkerObjectNameInfoEXT
create()
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated withBufferUtils
.static VkDebugMarkerObjectNameInfoEXT.Buffer
create(int capacity)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated withBufferUtils
.static VkDebugMarkerObjectNameInfoEXT
create(long address)
Returns a newVkDebugMarkerObjectNameInfoEXT
instance for the specified memory address.static VkDebugMarkerObjectNameInfoEXT.Buffer
create(long address, int capacity)
Create aVkDebugMarkerObjectNameInfoEXT.Buffer
instance at the specified memory.static VkDebugMarkerObjectNameInfoEXT
createSafe(long address)
static VkDebugMarkerObjectNameInfoEXT.Buffer
createSafe(long address, int capacity)
static VkDebugMarkerObjectNameInfoEXT
malloc()
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated withmemAlloc
.static VkDebugMarkerObjectNameInfoEXT.Buffer
malloc(int capacity)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated withmemAlloc
.static VkDebugMarkerObjectNameInfoEXT
mallocStack()
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated on the thread-localMemoryStack
.static VkDebugMarkerObjectNameInfoEXT.Buffer
mallocStack(int capacity)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkDebugMarkerObjectNameInfoEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkDebugMarkerObjectNameInfoEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated on the specifiedMemoryStack
.static long
nobject(long struct)
Unsafe version ofobject()
.static void
nobject(long struct, long value)
Unsafe version ofobject
.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
object()
Returns the value of theobject
field.VkDebugMarkerObjectNameInfoEXT
object(long value)
Sets the specified value to theobject
field.int
objectType()
Returns the value of theobjectType
field.VkDebugMarkerObjectNameInfoEXT
objectType(int value)
Sets the specified value to theobjectType
field.long
pNext()
Returns the value of thepNext
field.VkDebugMarkerObjectNameInfoEXT
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.VkDebugMarkerObjectNameInfoEXT
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.VkDebugMarkerObjectNameInfoEXT
set(int sType, long pNext, int objectType, long object, java.nio.ByteBuffer pObjectName)
Initializes this struct with the specified values.VkDebugMarkerObjectNameInfoEXT
set(VkDebugMarkerObjectNameInfoEXT src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkDebugMarkerObjectNameInfoEXT
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkDebugMarkerObjectNameInfoEXT
public VkDebugMarkerObjectNameInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugMarkerObjectNameInfoEXT
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.
-
object
public long object()
Returns the value of theobject
field.
-
pObjectName
public java.nio.ByteBuffer pObjectName()
Returns aByteBuffer
view of the null-terminated string pointed to by thepObjectName
field.
-
pObjectNameString
public java.lang.String pObjectNameString()
Decodes the null-terminated string pointed to by thepObjectName
field.
-
sType
public VkDebugMarkerObjectNameInfoEXT sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDebugMarkerObjectNameInfoEXT pNext(long value)
Sets the specified value to thepNext
field.
-
objectType
public VkDebugMarkerObjectNameInfoEXT objectType(int value)
Sets the specified value to theobjectType
field.
-
object
public VkDebugMarkerObjectNameInfoEXT object(long value)
Sets the specified value to theobject
field.
-
pObjectName
public VkDebugMarkerObjectNameInfoEXT pObjectName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thepObjectName
field.
-
set
public VkDebugMarkerObjectNameInfoEXT set(int sType, long pNext, int objectType, long object, java.nio.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 newVkDebugMarkerObjectNameInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDebugMarkerObjectNameInfoEXT calloc()
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDebugMarkerObjectNameInfoEXT create()
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated withBufferUtils
.
-
create
public static VkDebugMarkerObjectNameInfoEXT create(long address)
Returns a newVkDebugMarkerObjectNameInfoEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkDebugMarkerObjectNameInfoEXT createSafe(long address)
-
malloc
public static VkDebugMarkerObjectNameInfoEXT.Buffer malloc(int capacity)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDebugMarkerObjectNameInfoEXT.Buffer calloc(int capacity)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugMarkerObjectNameInfoEXT.Buffer create(int capacity)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugMarkerObjectNameInfoEXT.Buffer create(long address, int capacity)
Create aVkDebugMarkerObjectNameInfoEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDebugMarkerObjectNameInfoEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDebugMarkerObjectNameInfoEXT mallocStack()
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDebugMarkerObjectNameInfoEXT callocStack()
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDebugMarkerObjectNameInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDebugMarkerObjectNameInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectNameInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDebugMarkerObjectNameInfoEXT.Buffer mallocStack(int capacity)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDebugMarkerObjectNameInfoEXT.Buffer callocStack(int capacity)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDebugMarkerObjectNameInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectNameInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDebugMarkerObjectNameInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectNameInfoEXT.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()
.
-
nobject
public static long nobject(long struct)
Unsafe version ofobject()
.
-
npObjectName
public static java.nio.ByteBuffer npObjectName(long struct)
Unsafe version ofpObjectName()
.
-
npObjectNameString
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
.
-
nobject
public static void nobject(long struct, long value)
Unsafe version ofobject
.
-
npObjectName
public static void npObjectName(long struct, java.nio.ByteBuffer value)
Unsafe version ofpObjectName
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-