Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCheckpointDataNV

extends Struct<VkCheckpointDataNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Return structure for command buffer checkpoint data.
Description

The stages at which a checkpoint marker can be executed are implementation-defined and can be queried by calling GetPhysicalDeviceQueueFamilyProperties2.

Valid Usage (Implicit)
See Also

GetQueueCheckpointDataNV

Layout


struct VkCheckpointDataNV {
    VkStructureType sType;
    void * pNext;
    VkPipelineStageFlagBits stage;
    void * pCheckpointMarker;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkCheckpointDataNV.Buffer

An array of VkCheckpointDataNV structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PCHECKPOINTMARKER

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STAGE

The struct member offsets.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkCheckpointDataNV(long address, ByteBuffer container)

public
VkCheckpointDataNV(ByteBuffer container)

Creates a VkCheckpointDataNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkCheckpointDataNV
calloc()

Returns a new VkCheckpointDataNV instance allocated with memCalloc.

public static VkCheckpointDataNV.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkCheckpointDataNV.Buffer instance allocated with memCalloc.

public static VkCheckpointDataNV
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkCheckpointDataNV.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkCheckpointDataNV
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkCheckpointDataNV
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCheckpointDataNV.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCheckpointDataNV.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkCheckpointDataNV
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkCheckpointDataNV
create()

Returns a new VkCheckpointDataNV instance allocated with BufferUtils.

public static VkCheckpointDataNV
create(long address)

Returns a new VkCheckpointDataNV instance for the specified memory address.

public static VkCheckpointDataNV.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkCheckpointDataNV.Buffer instance allocated with BufferUtils.

public static VkCheckpointDataNV.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkCheckpointDataNV.Buffer instance at the specified memory.

public static VkCheckpointDataNV
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkCheckpointDataNV.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkCheckpointDataNV
malloc()

Returns a new VkCheckpointDataNV instance allocated with memAlloc.

public static VkCheckpointDataNV.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkCheckpointDataNV.Buffer instance allocated with memAlloc.

public static VkCheckpointDataNV
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkCheckpointDataNV instance allocated on the specified MemoryStack.

public static VkCheckpointDataNV.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkCheckpointDataNV
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkCheckpointDataNV
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCheckpointDataNV.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkCheckpointDataNV.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
npCheckpointMarker(long struct)

Unsafe version of pCheckpointMarker.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nstage(long struct)

Unsafe version of stage.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pCheckpointMarker()

contains the value of the last checkpoint marker executed in the stage that stage refers to.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkCheckpointDataNV
pNext(long value)

Sets the specified value to the pNext field.

public VkCheckpointDataNV
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkCheckpointDataNV

Returns:

this struct
set(VkCheckpointDataNV
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
stage()

a VkPipelineStageFlagBits value specifying which pipeline stage the checkpoint marker data refers to.

public int
sType()

a VkStructureType value identifying this structure.

public VkCheckpointDataNV
sType(int value)

Sets the specified value to the sType field.

public VkCheckpointDataNV
sType$Default()

Sets the STRUCTURE_TYPE_CHECKPOINT_DATA_NV value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PCHECKPOINTMARKERback to summary
public static final int PCHECKPOINTMARKER

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STAGEback to summary
public static final int STAGE

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkCheckpointDataNVback to summary
protected VkCheckpointDataNV(long address, ByteBuffer container)
VkCheckpointDataNVback to summary
public VkCheckpointDataNV(ByteBuffer container)

Creates a VkCheckpointDataNV 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 Detail

callocback to summary
public static VkCheckpointDataNV calloc()

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

callocback to summary
public static VkCheckpointDataNV.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCheckpointDataNV calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkCheckpointDataNV.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkCheckpointDataNV callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkCheckpointDataNV callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkCheckpointDataNV.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkCheckpointDataNV.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkCheckpointDataNV create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkCheckpointDataNV create()

Returns a new VkCheckpointDataNV instance allocated with BufferUtils.

createback to summary
public static VkCheckpointDataNV create(long address)

Returns a new VkCheckpointDataNV instance for the specified memory address.

createback to summary
public static VkCheckpointDataNV.Buffer create(int capacity)

Returns a new VkCheckpointDataNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkCheckpointDataNV.Buffer create(long address, int capacity)

Create a VkCheckpointDataNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCheckpointDataNV createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkCheckpointDataNV.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkCheckpointDataNV malloc()

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

mallocback to summary
public static VkCheckpointDataNV.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCheckpointDataNV malloc(MemoryStack stack)

Returns a new VkCheckpointDataNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkCheckpointDataNV.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkCheckpointDataNV mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkCheckpointDataNV mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkCheckpointDataNV.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkCheckpointDataNV.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
npCheckpointMarkerback to summary
public static long npCheckpointMarker(long struct)

Unsafe version of pCheckpointMarker.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nstageback to summary
public static int nstage(long struct)

Unsafe version of stage.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pCheckpointMarkerback to summary
public long pCheckpointMarker()

contains the value of the last checkpoint marker executed in the stage that stage refers to.

Annotations
@NativeType:void *
pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkCheckpointDataNV pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkCheckpointDataNV set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkCheckpointDataNV set(VkCheckpointDataNV src)

Copies the specified struct data to this struct.

Parameters
src:VkCheckpointDataNV

the source struct

Returns:VkCheckpointDataNV

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
stageback to summary
public int stage()

a VkPipelineStageFlagBits value specifying which pipeline stage the checkpoint marker data refers to.

Annotations
@NativeType:VkPipelineStageFlagBits
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkCheckpointDataNV sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkCheckpointDataNV sType$Default()

Sets the STRUCTURE_TYPE_CHECKPOINT_DATA_NV value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkCheckpointDataNV.Buffer

extends StructBuffer<VkCheckpointDataNV, VkCheckpointDataNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkCheckpointDataNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkCheckpointDataNV
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkCheckpointDataNV.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkCheckpointDataNV
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public long

Returns:

the value of the VkCheckpointDataNV#pCheckpointMarker field.
pCheckpointMarker()

public long

Returns:

the value of the VkCheckpointDataNV#pNext field.
pNext()

public VkCheckpointDataNV.Buffer
pNext(long value)

Sets the specified value to the VkCheckpointDataNV#pNext field.

protected VkCheckpointDataNV.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkCheckpointDataNV#stage field.
stage()

public int

Returns:

the value of the VkCheckpointDataNV#sType field.
sType()

public VkCheckpointDataNV.Buffer
sType(int value)

Sets the specified value to the VkCheckpointDataNV#sType field.

public VkCheckpointDataNV.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_CHECKPOINT_DATA_NV value to the VkCheckpointDataNV#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCheckpointDataNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkCheckpointDataNV.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkCheckpointDataNV#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkCheckpointDataNV getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pCheckpointMarkerback to summary
public long pCheckpointMarker()
Returns:long

the value of the VkCheckpointDataNV#pCheckpointMarker field.

Annotations
@NativeType:void *
pNextback to summary
public long pNext()
Returns:long

the value of the VkCheckpointDataNV#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkCheckpointDataNV.Buffer pNext(long value)

Sets the specified value to the VkCheckpointDataNV#pNext field.

selfback to summary
protected VkCheckpointDataNV.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
stageback to summary
public int stage()
Returns:int

the value of the VkCheckpointDataNV#stage field.

Annotations
@NativeType:VkPipelineStageFlagBits
sTypeback to summary
public int sType()
Returns:int

the value of the VkCheckpointDataNV#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkCheckpointDataNV.Buffer sType(int value)

Sets the specified value to the VkCheckpointDataNV#sType field.

sType$Defaultback to summary
public VkCheckpointDataNV.Buffer sType$Default()

Sets the STRUCTURE_TYPE_CHECKPOINT_DATA_NV value to the VkCheckpointDataNV#sType field.