Package org.lwjgl.vulkan

Class VkPushDescriptorSetInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPushDescriptorSetInfo>

org.lwjgl.vulkan.VkPushDescriptorSetInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkPushDescriptorSetInfoKHR

public class VkPushDescriptorSetInfo
extends Struct<VkPushDescriptorSetInfo>
implements NativeResource

 struct VkPushDescriptorSetInfo {
     VkStructureType sType;
     void const * pNext;
     VkShaderStageFlags stageFlags;
     VkPipelineLayout layout;
     uint32_t set;
     uint32_t descriptorWriteCount;
     {@link VkWriteDescriptorSet VkWriteDescriptorSet} const * pDescriptorWrites;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPushDescriptorSetInfo.Buffer	An array of VkPushDescriptorSetInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DESCRIPTORWRITECOUNT	The struct member offsets.
static final int	LAYOUT	The struct member offsets.
static final int	PDESCRIPTORWRITES	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	STAGEFLAGS	The struct member offsets.
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
VkPushDescriptorSetInfo(ByteBuffer container)	Creates a VkPushDescriptorSetInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPushDescriptorSetInfo	calloc()	Returns a new VkPushDescriptorSetInfo instance allocated with memCalloc.
static VkPushDescriptorSetInfo.Buffer	calloc(int capacity)	Returns a new VkPushDescriptorSetInfo.Buffer instance allocated with memCalloc.
static VkPushDescriptorSetInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkPushDescriptorSetInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPushDescriptorSetInfo	calloc(MemoryStack stack)	Returns a new VkPushDescriptorSetInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPushDescriptorSetInfo	create()	Returns a new VkPushDescriptorSetInfo instance allocated with BufferUtils.
static VkPushDescriptorSetInfo.Buffer	create(int capacity)	Returns a new VkPushDescriptorSetInfo.Buffer instance allocated with BufferUtils.
static VkPushDescriptorSetInfo	create(long address)	Returns a new VkPushDescriptorSetInfo instance for the specified memory address.
static VkPushDescriptorSetInfo.Buffer	create(long address, int capacity)	Create a VkPushDescriptorSetInfo.Buffer instance at the specified memory.
static @Nullable VkPushDescriptorSetInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPushDescriptorSetInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	descriptorWriteCount()
long	layout()
VkPushDescriptorSetInfo	layout(long value)	Sets the specified value to the layout field.
static VkPushDescriptorSetInfo	malloc()	Returns a new VkPushDescriptorSetInfo instance allocated with memAlloc.
static VkPushDescriptorSetInfo.Buffer	malloc(int capacity)	Returns a new VkPushDescriptorSetInfo.Buffer instance allocated with memAlloc.
static VkPushDescriptorSetInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPushDescriptorSetInfo.Buffer instance allocated on the specified MemoryStack.
static VkPushDescriptorSetInfo	malloc(MemoryStack stack)	Returns a new VkPushDescriptorSetInfo instance allocated on the specified MemoryStack.
static int	ndescriptorWriteCount(long struct)	Unsafe version of descriptorWriteCount().
static void	ndescriptorWriteCount(long struct, int value)	Sets the specified value to the descriptorWriteCount field of the specified struct.
static long	nlayout(long struct)	Unsafe version of layout().
static void	nlayout(long struct, long value)	Unsafe version of layout.
static VkWriteDescriptorSet.Buffer	npDescriptorWrites(long struct)	Unsafe version of pDescriptorWrites().
static void	npDescriptorWrites(long struct, VkWriteDescriptorSet.Buffer value)	Unsafe version of pDescriptorWrites.
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	nstageFlags(long struct)	Unsafe version of stageFlags().
static void	nstageFlags(long struct, int value)	Unsafe version of stageFlags.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
VkWriteDescriptorSet.Buffer	pDescriptorWrites()
VkPushDescriptorSetInfo	pDescriptorWrites(VkWriteDescriptorSet.Buffer value)	Sets the address of the specified VkWriteDescriptorSet.Buffer to the pDescriptorWrites field.
long	pNext()
VkPushDescriptorSetInfo	pNext(long value)	Sets the specified value to the pNext field.
VkPushDescriptorSetInfo	pNext(VkPipelineLayoutCreateInfo value)	Prepends the specified VkPipelineLayoutCreateInfo value to the pNext chain.
int	set()
VkPushDescriptorSetInfo	set(int value)	Sets the specified value to the set field.
VkPushDescriptorSetInfo	set(int sType, long pNext, int stageFlags, long layout, int set, VkWriteDescriptorSet.Buffer pDescriptorWrites)	Initializes this struct with the specified values.
VkPushDescriptorSetInfo	set(VkPushDescriptorSetInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	stageFlags()
VkPushDescriptorSetInfo	stageFlags(int value)	Sets the specified value to the stageFlags field.
int	sType()
VkPushDescriptorSetInfo	sType(int value)	Sets the specified value to the sType field.
VkPushDescriptorSetInfo	sType$Default()	Sets the STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_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.

STAGEFLAGS

public static final int STAGEFLAGS

The struct member offsets.

LAYOUT

public static final int LAYOUT

The struct member offsets.

SET

public static final int SET

The struct member offsets.

DESCRIPTORWRITECOUNT

public static final int DESCRIPTORWRITECOUNT

The struct member offsets.

PDESCRIPTORWRITES

public static final int PDESCRIPTORWRITES

The struct member offsets.

Constructor Details

VkPushDescriptorSetInfo

public VkPushDescriptorSetInfo(ByteBuffer container)

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

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkPushDescriptorSetInfo>

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

stageFlags

public int stageFlags()

Returns:

the value of the stageFlags field.

layout

public long layout()

Returns:

the value of the layout field.

set

public int set()

Returns:

the value of the set field.

descriptorWriteCount

public int descriptorWriteCount()

Returns:

the value of the descriptorWriteCount field.

pDescriptorWrites

public VkWriteDescriptorSet.Buffer pDescriptorWrites()

Returns:

a VkWriteDescriptorSet.Buffer view of the struct array pointed to by the pDescriptorWrites field.

sType

public VkPushDescriptorSetInfo sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkPushDescriptorSetInfo sType$Default()

Sets the STRUCTURE_TYPE_PUSH_DESCRIPTOR_SET_INFO value to the sType field.

pNext

public VkPushDescriptorSetInfo pNext(long value)

Sets the specified value to the pNext field.

pNext

public VkPushDescriptorSetInfo pNext(VkPipelineLayoutCreateInfo value)

Prepends the specified VkPipelineLayoutCreateInfo value to the pNext chain.

stageFlags

public VkPushDescriptorSetInfo stageFlags(int value)

Sets the specified value to the stageFlags field.

layout

public VkPushDescriptorSetInfo layout(long value)

Sets the specified value to the layout field.

set

public VkPushDescriptorSetInfo set(int value)

Sets the specified value to the set field.

pDescriptorWrites

public VkPushDescriptorSetInfo pDescriptorWrites(VkWriteDescriptorSet.Buffer value)

Sets the address of the specified VkWriteDescriptorSet.Buffer to the pDescriptorWrites field.

set

public VkPushDescriptorSetInfo set(int sType,
 long pNext,
 int stageFlags,
 long layout,
 int set,
 VkWriteDescriptorSet.Buffer pDescriptorWrites)

Initializes this struct with the specified values.

set

public VkPushDescriptorSetInfo set(VkPushDescriptorSetInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPushDescriptorSetInfo malloc()

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

calloc

public static VkPushDescriptorSetInfo calloc()

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

create

public static VkPushDescriptorSetInfo create()

Returns a new VkPushDescriptorSetInfo instance allocated with BufferUtils.

create

public static VkPushDescriptorSetInfo create(long address)

Returns a new VkPushDescriptorSetInfo instance for the specified memory address.

createSafe

public static @Nullable VkPushDescriptorSetInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPushDescriptorSetInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPushDescriptorSetInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPushDescriptorSetInfo.Buffer create(int capacity)

Returns a new VkPushDescriptorSetInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPushDescriptorSetInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkPushDescriptorSetInfo malloc(MemoryStack stack)

Returns a new VkPushDescriptorSetInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPushDescriptorSetInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPushDescriptorSetInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPushDescriptorSetInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

nstageFlags

public static int nstageFlags(long struct)

Unsafe version of stageFlags().

nlayout

public static long nlayout(long struct)

Unsafe version of layout().

nset

public static int nset(long struct)

Unsafe version of set().

ndescriptorWriteCount

public static int ndescriptorWriteCount(long struct)

Unsafe version of descriptorWriteCount().

npDescriptorWrites

public static VkWriteDescriptorSet.Buffer npDescriptorWrites(long struct)

Unsafe version of pDescriptorWrites().

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.

nstageFlags

public static void nstageFlags(long struct,
 int value)

Unsafe version of stageFlags.

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.

ndescriptorWriteCount

public static void ndescriptorWriteCount(long struct,
 int value)

Sets the specified value to the descriptorWriteCount field of the specified struct.

npDescriptorWrites

public static void npDescriptorWrites(long struct,
 VkWriteDescriptorSet.Buffer value)

Unsafe version of pDescriptorWrites.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate