Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkQueueFamilyCheckpointPropertiesNV

extends Struct<VkQueueFamilyCheckpointPropertiesNV>
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 queue family checkpoint information query.
Description

Additional queue family information can be queried by setting VkQueueFamilyProperties2::pNext to point to a VkQueueFamilyCheckpointPropertiesNV structure.

Valid Usage (Implicit)

Layout


struct VkQueueFamilyCheckpointPropertiesNV {
    VkStructureType sType;
    void * pNext;
    VkPipelineStageFlags checkpointExecutionStageMask;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkQueueFamilyCheckpointPropertiesNV.Buffer

An array of VkQueueFamilyCheckpointPropertiesNV structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CHECKPOINTEXECUTIONSTAGEMASK

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
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkQueueFamilyCheckpointPropertiesNV(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkQueueFamilyCheckpointPropertiesNV
calloc()

Returns a new VkQueueFamilyCheckpointPropertiesNV instance allocated with memCalloc.

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

Returns a new VkQueueFamilyCheckpointPropertiesNV.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkQueueFamilyCheckpointPropertiesNV
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public int
checkpointExecutionStageMask()

a mask indicating which pipeline stages the implementation can execute checkpoint markers in.

protected VkQueueFamilyCheckpointPropertiesNV
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 VkQueueFamilyCheckpointPropertiesNV
create()

Returns a new VkQueueFamilyCheckpointPropertiesNV instance allocated with BufferUtils.

public static VkQueueFamilyCheckpointPropertiesNV
create(long address)

Returns a new VkQueueFamilyCheckpointPropertiesNV instance for the specified memory address.

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

Returns a new VkQueueFamilyCheckpointPropertiesNV.Buffer instance allocated with BufferUtils.

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

Create a VkQueueFamilyCheckpointPropertiesNV.Buffer instance at the specified memory.

public static VkQueueFamilyCheckpointPropertiesNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkQueueFamilyCheckpointPropertiesNV
malloc()

Returns a new VkQueueFamilyCheckpointPropertiesNV instance allocated with memAlloc.

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

Returns a new VkQueueFamilyCheckpointPropertiesNV.Buffer instance allocated with memAlloc.

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

Returns a new VkQueueFamilyCheckpointPropertiesNV instance allocated on the specified MemoryStack.

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

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

public static VkQueueFamilyCheckpointPropertiesNV
mallocStack()

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

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

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

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

Unsafe version of checkpointExecutionStageMask.

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
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkQueueFamilyCheckpointPropertiesNV
pNext(long value)

Sets the specified value to the pNext field.

public VkQueueFamilyCheckpointPropertiesNV
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkQueueFamilyCheckpointPropertiesNV

Returns:

this struct
set(VkQueueFamilyCheckpointPropertiesNV
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
sType()

a VkStructureType value identifying this structure.

public VkQueueFamilyCheckpointPropertiesNV
sType(int value)

Sets the specified value to the sType field.

public VkQueueFamilyCheckpointPropertiesNV
sType$Default()

Sets the STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_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.

CHECKPOINTEXECUTIONSTAGEMASKback to summary
public static final int CHECKPOINTEXECUTIONSTAGEMASK

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.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkQueueFamilyCheckpointPropertiesNVback to summary
protected VkQueueFamilyCheckpointPropertiesNV(long address, ByteBuffer container)
VkQueueFamilyCheckpointPropertiesNVback to summary
public VkQueueFamilyCheckpointPropertiesNV(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkQueueFamilyCheckpointPropertiesNV calloc(MemoryStack stack)

Returns a new VkQueueFamilyCheckpointPropertiesNV 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 VkQueueFamilyCheckpointPropertiesNV.Buffer calloc(int capacity, MemoryStack stack)

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
checkpointExecutionStageMaskback to summary
public int checkpointExecutionStageMask()

a mask indicating which pipeline stages the implementation can execute checkpoint markers in.

Annotations
@NativeType:VkPipelineStageFlags
createback to summary
protected VkQueueFamilyCheckpointPropertiesNV 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 VkQueueFamilyCheckpointPropertiesNV create()

Returns a new VkQueueFamilyCheckpointPropertiesNV instance allocated with BufferUtils.

createback to summary
public static VkQueueFamilyCheckpointPropertiesNV create(long address)

Returns a new VkQueueFamilyCheckpointPropertiesNV instance for the specified memory address.

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

Returns a new VkQueueFamilyCheckpointPropertiesNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkQueueFamilyCheckpointPropertiesNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkQueueFamilyCheckpointPropertiesNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkQueueFamilyCheckpointPropertiesNV malloc(MemoryStack stack)

Returns a new VkQueueFamilyCheckpointPropertiesNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ncheckpointExecutionStageMaskback to summary
public static int ncheckpointExecutionStageMask(long struct)

Unsafe version of checkpointExecutionStageMask.

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.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkQueueFamilyCheckpointPropertiesNV set(VkQueueFamilyCheckpointPropertiesNV src)

Copies the specified struct data to this struct.

Parameters
src:VkQueueFamilyCheckpointPropertiesNV

the source struct

Returns:VkQueueFamilyCheckpointPropertiesNV

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
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_NV value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkQueueFamilyCheckpointPropertiesNV.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkQueueFamilyCheckpointPropertiesNV
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkQueueFamilyCheckpointPropertiesNV.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
public int

Returns:

the value of the VkQueueFamilyCheckpointPropertiesNV#checkpointExecutionStageMask field.
checkpointExecutionStageMask()

protected VkQueueFamilyCheckpointPropertiesNV
getElementFactory()

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

public long

Returns:

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

public VkQueueFamilyCheckpointPropertiesNV.Buffer
pNext(long value)

Sets the specified value to the VkQueueFamilyCheckpointPropertiesNV#pNext field.

protected VkQueueFamilyCheckpointPropertiesNV.Buffer
self()

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

public int

Returns:

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

public VkQueueFamilyCheckpointPropertiesNV.Buffer
sType(int value)

Sets the specified value to the VkQueueFamilyCheckpointPropertiesNV#sType field.

public VkQueueFamilyCheckpointPropertiesNV.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_NV value to the VkQueueFamilyCheckpointPropertiesNV#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkQueueFamilyCheckpointPropertiesNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkQueueFamilyCheckpointPropertiesNV.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 VkQueueFamilyCheckpointPropertiesNV#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

checkpointExecutionStageMaskback to summary
public int checkpointExecutionStageMask()
Returns:int

the value of the VkQueueFamilyCheckpointPropertiesNV#checkpointExecutionStageMask field.

Annotations
@NativeType:VkPipelineStageFlags
getElementFactoryback to summary
protected VkQueueFamilyCheckpointPropertiesNV getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkQueueFamilyCheckpointPropertiesNV#pNext field.

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

Sets the specified value to the VkQueueFamilyCheckpointPropertiesNV#pNext field.

selfback to summary
protected VkQueueFamilyCheckpointPropertiesNV.Buffer self()

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

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

the value of the VkQueueFamilyCheckpointPropertiesNV#sType field.

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

Sets the specified value to the VkQueueFamilyCheckpointPropertiesNV#sType field.

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

Sets the STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_NV value to the VkQueueFamilyCheckpointPropertiesNV#sType field.