Package org.lwjgl.vulkan

Class VkComputePipelineIndirectBufferInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkComputePipelineIndirectBufferInfoNV>

org.lwjgl.vulkan.VkComputePipelineIndirectBufferInfoNV

All Implemented Interfaces:

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

public class VkComputePipelineIndirectBufferInfoNV
extends org.lwjgl.system.Struct<VkComputePipelineIndirectBufferInfoNV>
implements org.lwjgl.system.NativeResource

Structure describing the device address where pipeline’s metadata will be saved.

Description

If pipelineDeviceAddressCaptureReplay is zero, no specific address is requested. If pipelineDeviceAddressCaptureReplay is not zero, then it must be an address retrieved from an identically created pipeline on the same implementation. The pipeline metadata must also be placed on an identically created buffer and at the same offset using the CmdUpdatePipelineIndirectBufferNV command.

Valid Usage

• The VkPhysicalDeviceDeviceGeneratedCommandsComputeFeaturesNV::deviceGeneratedComputePipelines feature must be enabled
• The pipeline creation flags in VkComputePipelineCreateInfo::flags must include PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV
• deviceAddress must be aligned to the VkMemoryRequirements2::alignment, as returned by GetPipelineIndirectMemoryRequirementsNV
• deviceAddress must have been allocated from a buffer that was created with usage BUFFER_USAGE_TRANSFER_DST_BIT and BUFFER_USAGE_INDIRECT_BUFFER_BIT
• size must be greater than or equal to the VkMemoryRequirements2::size, as returned by GetPipelineIndirectMemoryRequirementsNV
• If pipelineDeviceAddressCaptureReplay is non-zero then the VkPhysicalDeviceDeviceGeneratedCommandsComputeFeaturesNV::deviceGeneratedComputeCaptureReplay feature must be enabled
• If pipelineDeviceAddressCaptureReplay is non-zero then that address must have been allocated with flag MEMORY_ALLOCATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT set
• If pipelineDeviceAddressCaptureReplay is non-zero, the pipeline must have been recreated for replay
• pipelineDeviceAddressCaptureReplay must satisfy the alignment and size requirements similar to deviceAddress

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_COMPUTE_PIPELINE_INDIRECT_BUFFER_INFO_NV

Layout

 struct VkComputePipelineIndirectBufferInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkDeviceAddress deviceAddress();
     VkDeviceSize size();
     VkDeviceAddress pipelineDeviceAddressCaptureReplay();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkComputePipelineIndirectBufferInfoNV.Buffer	An array of VkComputePipelineIndirectBufferInfoNV 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	DEVICEADDRESS	The struct member offsets.
static final int	PIPELINEDEVICEADDRESSCAPTUREREPLAY	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZE	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
VkComputePipelineIndirectBufferInfoNV(ByteBuffer container)	Creates a VkComputePipelineIndirectBufferInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkComputePipelineIndirectBufferInfoNV	calloc()	Returns a new VkComputePipelineIndirectBufferInfoNV instance allocated with memCalloc.
static VkComputePipelineIndirectBufferInfoNV.Buffer	calloc(int capacity)	Returns a new VkComputePipelineIndirectBufferInfoNV.Buffer instance allocated with memCalloc.
static VkComputePipelineIndirectBufferInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkComputePipelineIndirectBufferInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkComputePipelineIndirectBufferInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkComputePipelineIndirectBufferInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkComputePipelineIndirectBufferInfoNV	create()	Returns a new VkComputePipelineIndirectBufferInfoNV instance allocated with BufferUtils.
static VkComputePipelineIndirectBufferInfoNV.Buffer	create(int capacity)	Returns a new VkComputePipelineIndirectBufferInfoNV.Buffer instance allocated with BufferUtils.
static VkComputePipelineIndirectBufferInfoNV	create(long address)	Returns a new VkComputePipelineIndirectBufferInfoNV instance for the specified memory address.
static VkComputePipelineIndirectBufferInfoNV.Buffer	create(long address, int capacity)	Create a VkComputePipelineIndirectBufferInfoNV.Buffer instance at the specified memory.
static @Nullable VkComputePipelineIndirectBufferInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkComputePipelineIndirectBufferInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	deviceAddress()	the address where the pipeline’s metadata will be stored.
VkComputePipelineIndirectBufferInfoNV	deviceAddress(long value)	Sets the specified value to the deviceAddress() field.
static VkComputePipelineIndirectBufferInfoNV	malloc()	Returns a new VkComputePipelineIndirectBufferInfoNV instance allocated with memAlloc.
static VkComputePipelineIndirectBufferInfoNV.Buffer	malloc(int capacity)	Returns a new VkComputePipelineIndirectBufferInfoNV.Buffer instance allocated with memAlloc.
static VkComputePipelineIndirectBufferInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkComputePipelineIndirectBufferInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkComputePipelineIndirectBufferInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkComputePipelineIndirectBufferInfoNV instance allocated on the specified MemoryStack.
static long	ndeviceAddress(long struct)	Unsafe version of deviceAddress().
static void	ndeviceAddress(long struct, long value)	Unsafe version of deviceAddress.
static long	npipelineDeviceAddressCaptureReplay(long struct)	Unsafe version of pipelineDeviceAddressCaptureReplay().
static void	npipelineDeviceAddressCaptureReplay(long struct, long value)	Unsafe version of pipelineDeviceAddressCaptureReplay.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static long	nsize(long struct)	Unsafe version of size().
static void	nsize(long struct, long value)	Unsafe version of size.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pipelineDeviceAddressCaptureReplay()	the device address where pipeline’s metadata was originally saved and can now be used to re-populate deviceAddress for replay.
VkComputePipelineIndirectBufferInfoNV	pipelineDeviceAddressCaptureReplay(long value)	Sets the specified value to the pipelineDeviceAddressCaptureReplay() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkComputePipelineIndirectBufferInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkComputePipelineIndirectBufferInfoNV	set(int sType, long pNext, long deviceAddress, long size, long pipelineDeviceAddressCaptureReplay)	Initializes this struct with the specified values.
VkComputePipelineIndirectBufferInfoNV	set(VkComputePipelineIndirectBufferInfoNV src)	Copies the specified struct data to this struct.
long	size()	the size of pipeline’s metadata that was queried using GetPipelineIndirectMemoryRequirementsNV.
VkComputePipelineIndirectBufferInfoNV	size(long value)	Sets the specified value to the size() field.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkComputePipelineIndirectBufferInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkComputePipelineIndirectBufferInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_COMPUTE_PIPELINE_INDIRECT_BUFFER_INFO_NV 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.

DEVICEADDRESS

public static final int DEVICEADDRESS

The struct member offsets.

SIZE

public static final int SIZE

The struct member offsets.

PIPELINEDEVICEADDRESSCAPTUREREPLAY

public static final int PIPELINEDEVICEADDRESSCAPTUREREPLAY

The struct member offsets.

Constructor Details

VkComputePipelineIndirectBufferInfoNV

public VkComputePipelineIndirectBufferInfoNV(ByteBuffer container)

Creates a VkComputePipelineIndirectBufferInfoNV 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<VkComputePipelineIndirectBufferInfoNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

deviceAddress

public long deviceAddress()

the address where the pipeline’s metadata will be stored.

size

public long size()

the size of pipeline’s metadata that was queried using GetPipelineIndirectMemoryRequirementsNV.

pipelineDeviceAddressCaptureReplay

public long pipelineDeviceAddressCaptureReplay()

the device address where pipeline’s metadata was originally saved and can now be used to re-populate deviceAddress for replay.

sType

public VkComputePipelineIndirectBufferInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkComputePipelineIndirectBufferInfoNV sType$Default()

Sets the STRUCTURE_TYPE_COMPUTE_PIPELINE_INDIRECT_BUFFER_INFO_NV value to the sType() field.

pNext

public VkComputePipelineIndirectBufferInfoNV pNext(long value)

Sets the specified value to the pNext() field.

deviceAddress

public VkComputePipelineIndirectBufferInfoNV deviceAddress(long value)

Sets the specified value to the deviceAddress() field.

size

public VkComputePipelineIndirectBufferInfoNV size(long value)

Sets the specified value to the size() field.

pipelineDeviceAddressCaptureReplay

public VkComputePipelineIndirectBufferInfoNV pipelineDeviceAddressCaptureReplay(long value)

Sets the specified value to the pipelineDeviceAddressCaptureReplay() field.

set

public VkComputePipelineIndirectBufferInfoNV set(int sType,
 long pNext,
 long deviceAddress,
 long size,
 long pipelineDeviceAddressCaptureReplay)

Initializes this struct with the specified values.

set

public VkComputePipelineIndirectBufferInfoNV set(VkComputePipelineIndirectBufferInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkComputePipelineIndirectBufferInfoNV malloc()

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

calloc

public static VkComputePipelineIndirectBufferInfoNV calloc()

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

create

public static VkComputePipelineIndirectBufferInfoNV create()

Returns a new VkComputePipelineIndirectBufferInfoNV instance allocated with BufferUtils.

create

public static VkComputePipelineIndirectBufferInfoNV create(long address)

Returns a new VkComputePipelineIndirectBufferInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkComputePipelineIndirectBufferInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkComputePipelineIndirectBufferInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkComputePipelineIndirectBufferInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkComputePipelineIndirectBufferInfoNV.Buffer create(int capacity)

Returns a new VkComputePipelineIndirectBufferInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkComputePipelineIndirectBufferInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkComputePipelineIndirectBufferInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkComputePipelineIndirectBufferInfoNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndeviceAddress

public static long ndeviceAddress(long struct)

Unsafe version of deviceAddress().

nsize

public static long nsize(long struct)

Unsafe version of size().

npipelineDeviceAddressCaptureReplay

public static long npipelineDeviceAddressCaptureReplay(long struct)

Unsafe version of pipelineDeviceAddressCaptureReplay().

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.

ndeviceAddress

public static void ndeviceAddress(long struct,
 long value)

Unsafe version of deviceAddress.

nsize

public static void nsize(long struct,
 long value)

Unsafe version of size.

npipelineDeviceAddressCaptureReplay

public static void npipelineDeviceAddressCaptureReplay(long struct,
 long value)

Unsafe version of pipelineDeviceAddressCaptureReplay.