Package org.lwjgl.vulkan

Class VkPushDescriptorSetWithTemplateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPushDescriptorSetWithTemplateInfo>

org.lwjgl.vulkan.VkPushDescriptorSetWithTemplateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPushDescriptorSetWithTemplateInfoKHR

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

Structure specifying a descriptor set push operation using a descriptor update template.

Valid Usage

• The pipelineBindPoint specified during the creation of the descriptor update template must be supported by the commandBuffer’s parent VkCommandPool’s queue family
• pData must be a valid pointer to a memory containing one or more valid instances of VkDescriptorImageInfo, VkDescriptorBufferInfo, or VkBufferView in a layout defined by descriptorUpdateTemplate when it was created with CreateDescriptorUpdateTemplate
• layout must be compatible with the layout used to create descriptorUpdateTemplate
• descriptorUpdateTemplate must have been created with a templateType of DESCRIPTOR_UPDATE_TEMPLATE_TYPE_PUSH_DESCRIPTORS
• set must be the same value used to create descriptorUpdateTemplate
• set must be less than VkPipelineLayoutCreateInfo::setLayoutCount provided when layout was created
• set must be the unique set number in the pipeline layout that uses a descriptor set layout that was created with DESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT

• If the dynamicPipelineLayout feature is not enabled, layout must be a valid VkPipelineLayout handle
• If layout is NULL_HANDLE, the pNext chain must include a valid VkPipelineLayoutCreateInfo structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_WITH_TEMPLATE_INFO
• pNext must be NULL or a pointer to a valid instance of VkPipelineLayoutCreateInfo
• The sType value of each struct in the pNext chain must be unique
• descriptorUpdateTemplate must be a valid VkDescriptorUpdateTemplate handle
• If layout is not NULL_HANDLE, layout must be a valid VkPipelineLayout handle
• pData must be a pointer value
• Both of descriptorUpdateTemplate, and layout that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice

See Also

CmdPushDescriptorSetWithTemplate2, CmdPushDescriptorSetWithTemplate2KHR

Layout

 struct VkPushDescriptorSetWithTemplateInfo {
     VkStructureType sType();
     void const * pNext();
     VkDescriptorUpdateTemplate descriptorUpdateTemplate();
     VkPipelineLayout layout();
     uint32_t set();
     void const * pData();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkPushDescriptorSetWithTemplateInfo	calloc()	Returns a new VkPushDescriptorSetWithTemplateInfo instance allocated with memCalloc.
static VkPushDescriptorSetWithTemplateInfo.Buffer	calloc(int capacity)	Returns a new VkPushDescriptorSetWithTemplateInfo.Buffer instance allocated with memCalloc.
static VkPushDescriptorSetWithTemplateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPushDescriptorSetWithTemplateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPushDescriptorSetWithTemplateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPushDescriptorSetWithTemplateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPushDescriptorSetWithTemplateInfo	create()	Returns a new VkPushDescriptorSetWithTemplateInfo instance allocated with BufferUtils.
static VkPushDescriptorSetWithTemplateInfo.Buffer	create(int capacity)	Returns a new VkPushDescriptorSetWithTemplateInfo.Buffer instance allocated with BufferUtils.
static VkPushDescriptorSetWithTemplateInfo	create(long address)	Returns a new VkPushDescriptorSetWithTemplateInfo instance for the specified memory address.
static VkPushDescriptorSetWithTemplateInfo.Buffer	create(long address, int capacity)	Create a VkPushDescriptorSetWithTemplateInfo.Buffer instance at the specified memory.
static @Nullable VkPushDescriptorSetWithTemplateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPushDescriptorSetWithTemplateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	descriptorUpdateTemplate()	a descriptor update template defining how to interpret the descriptor information in pData.
VkPushDescriptorSetWithTemplateInfo	descriptorUpdateTemplate(long value)	Sets the specified value to the descriptorUpdateTemplate() field.
long	layout()	a VkPipelineLayout object used to program the bindings.
VkPushDescriptorSetWithTemplateInfo	layout(long value)	Sets the specified value to the layout() field.
static VkPushDescriptorSetWithTemplateInfo	malloc()	Returns a new VkPushDescriptorSetWithTemplateInfo instance allocated with memAlloc.
static VkPushDescriptorSetWithTemplateInfo.Buffer	malloc(int capacity)	Returns a new VkPushDescriptorSetWithTemplateInfo.Buffer instance allocated with memAlloc.
static VkPushDescriptorSetWithTemplateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPushDescriptorSetWithTemplateInfo.Buffer instance allocated on the specified MemoryStack.
static VkPushDescriptorSetWithTemplateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPushDescriptorSetWithTemplateInfo instance allocated on the specified MemoryStack.
static long	ndescriptorUpdateTemplate(long struct)	Unsafe version of descriptorUpdateTemplate().
static void	ndescriptorUpdateTemplate(long struct, long value)	Unsafe version of descriptorUpdateTemplate.
static long	nlayout(long struct)	Unsafe version of layout().
static void	nlayout(long struct, long value)	Unsafe version of layout.
static long	npData(long struct)	Unsafe version of pData().
static void	npData(long struct, long value)	Unsafe version of pData.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nset(long struct)	Unsafe version of set().
static void	nset(long struct, int value)	Unsafe version of set.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pData()	a pointer to memory containing descriptors for the templated update.
VkPushDescriptorSetWithTemplateInfo	pData(long value)	Sets the specified value to the pData() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPushDescriptorSetWithTemplateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkPushDescriptorSetWithTemplateInfo	pNext(VkPipelineLayoutCreateInfo value)	Prepends the specified VkPipelineLayoutCreateInfo value to the pNext chain.
int	set()	the set number of the descriptor set in the pipeline layout that will be updated.
VkPushDescriptorSetWithTemplateInfo	set(int value)	Sets the specified value to the set() field.
VkPushDescriptorSetWithTemplateInfo	set(int sType, long pNext, long descriptorUpdateTemplate, long layout, int set, long pData)	Initializes this struct with the specified values.
VkPushDescriptorSetWithTemplateInfo	set(VkPushDescriptorSetWithTemplateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPushDescriptorSetWithTemplateInfo	sType(int value)	Sets the specified value to the sType() field.
VkPushDescriptorSetWithTemplateInfo	sType$Default()	Sets the STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_WITH_TEMPLATE_INFO 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, 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.

DESCRIPTORUPDATETEMPLATE

public static final int DESCRIPTORUPDATETEMPLATE

The struct member offsets.

LAYOUT

public static final int LAYOUT

The struct member offsets.

SET

public static final int SET

The struct member offsets.

PDATA

public static final int PDATA

The struct member offsets.

Constructor Details

VkPushDescriptorSetWithTemplateInfo

public VkPushDescriptorSetWithTemplateInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

descriptorUpdateTemplate

public long descriptorUpdateTemplate()

a descriptor update template defining how to interpret the descriptor information in pData.

layout

public long layout()

a VkPipelineLayout object used to program the bindings. It must be compatible with the layout used to create the descriptorUpdateTemplate handle. If the dynamicPipelineLayout feature is enabled, layout can be NULL_HANDLE and the layout must be specified by chaining VkPipelineLayoutCreateInfo structure off the pNext

set

public int set()

the set number of the descriptor set in the pipeline layout that will be updated. This must be the same number used to create the descriptorUpdateTemplate handle.

pData

public long pData()

a pointer to memory containing descriptors for the templated update.

sType

public VkPushDescriptorSetWithTemplateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPushDescriptorSetWithTemplateInfo sType$Default()

Sets the STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_WITH_TEMPLATE_INFO value to the sType() field.

pNext

public VkPushDescriptorSetWithTemplateInfo pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkPushDescriptorSetWithTemplateInfo pNext(VkPipelineLayoutCreateInfo value)

Prepends the specified VkPipelineLayoutCreateInfo value to the pNext chain.

descriptorUpdateTemplate

public VkPushDescriptorSetWithTemplateInfo descriptorUpdateTemplate(long value)

Sets the specified value to the descriptorUpdateTemplate() field.

layout

public VkPushDescriptorSetWithTemplateInfo layout(long value)

Sets the specified value to the layout() field.

set

public VkPushDescriptorSetWithTemplateInfo set(int value)

Sets the specified value to the set() field.

pData

public VkPushDescriptorSetWithTemplateInfo pData(long value)

Sets the specified value to the pData() field.

set

public VkPushDescriptorSetWithTemplateInfo set(int sType,
 long pNext,
 long descriptorUpdateTemplate,
 long layout,
 int set,
 long pData)

Initializes this struct with the specified values.

set

public VkPushDescriptorSetWithTemplateInfo set(VkPushDescriptorSetWithTemplateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPushDescriptorSetWithTemplateInfo malloc()

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

calloc

public static VkPushDescriptorSetWithTemplateInfo calloc()

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

create

public static VkPushDescriptorSetWithTemplateInfo create()

Returns a new VkPushDescriptorSetWithTemplateInfo instance allocated with BufferUtils.

create

public static VkPushDescriptorSetWithTemplateInfo create(long address)

Returns a new VkPushDescriptorSetWithTemplateInfo instance for the specified memory address.

createSafe

public static @Nullable VkPushDescriptorSetWithTemplateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPushDescriptorSetWithTemplateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPushDescriptorSetWithTemplateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPushDescriptorSetWithTemplateInfo.Buffer create(int capacity)

Returns a new VkPushDescriptorSetWithTemplateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPushDescriptorSetWithTemplateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPushDescriptorSetWithTemplateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndescriptorUpdateTemplate

public static long ndescriptorUpdateTemplate(long struct)

Unsafe version of descriptorUpdateTemplate().

nlayout

public static long nlayout(long struct)

Unsafe version of layout().

nset

public static int nset(long struct)

Unsafe version of set().

npData

public static long npData(long struct)

Unsafe version of pData().

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.

ndescriptorUpdateTemplate

public static void ndescriptorUpdateTemplate(long struct,
 long value)

Unsafe version of descriptorUpdateTemplate.

nlayout

public static void nlayout(long struct,
 long value)

Unsafe version of layout.

nset

public static void nset(long struct,
 int value)

Unsafe version of set.

npData

public static void npData(long struct,
 long value)

Unsafe version of pData.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate