Package org.lwjgl.vulkan

Class VkDescriptorGetInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDescriptorGetInfoEXT>

org.lwjgl.vulkan.VkDescriptorGetInfoEXT

All Implemented Interfaces:

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

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

Structure specifying parameters of descriptor to get.

Valid Usage

• type must not be DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC or DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK
• If type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the pCombinedImageSampler→sampler member of data must be a VkSampler created on device
• If type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the pCombinedImageSampler→imageView member of data must be a VkImageView created on device, or NULL_HANDLE
• If type is DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the pInputAttachmentImage→imageView member of data must be a VkImageView created on device
• If type is DESCRIPTOR_TYPE_SAMPLED_IMAGE, and if pSampledImage is not NULL, the pSampledImage→imageView member of data must be a VkImageView created on device, or NULL_HANDLE
• If type is DESCRIPTOR_TYPE_STORAGE_IMAGE, and if pStorageImage is not NULL, the pStorageImage→imageView member of data must be a VkImageView created on device, or NULL_HANDLE
• If type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, pUniformTexelBuffer is not NULL and pUniformTexelBuffer→address is not zero, pUniformTexelBuffer→address must be an address within a VkBuffer created on device
• If type is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, pStorageTexelBuffer is not NULL and pStorageTexelBuffer→address is not zero, pStorageTexelBuffer→address must be an address within a VkBuffer created on device
• If type is DESCRIPTOR_TYPE_UNIFORM_BUFFER, pUniformBuffer is not NULL and pUniformBuffer→address is not zero, pUniformBuffer→address must be an address within a VkBuffer created on device
• If type is DESCRIPTOR_TYPE_STORAGE_BUFFER, pStorageBuffer is not NULL and pStorageBuffer→address is not zero, pStorageBuffer→address must be an address within a VkBuffer created on device
• If type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, pUniformBuffer is not NULL , the number of texel buffer elements given by (⌊pUniformBuffer→range / (texel block size)⌋ × (texels per block)) where texel block size and texels per block are as defined in the Compatible Formats table for pUniformBuffer→format, must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
• If type is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, pStorageBuffer is not NULL , the number of texel buffer elements given by (⌊pStorageBuffer→range / (texel block size)⌋ × (texels per block)) where texel block size and texels per block are as defined in the Compatible Formats table for pStorageBuffer→format, must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
• If type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR and accelerationStructure is not 0, accelerationStructure must contain the address of a VkAccelerationStructureKHR created on device
• If type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV and accelerationStructure is not 0, accelerationStructure must contain the handle of a VkAccelerationStructureNV created on device, returned by GetAccelerationStructureHandleNV

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DESCRIPTOR_GET_INFO_EXT
• pNext must be NULL
• type must be a valid VkDescriptorType value
• If type is DESCRIPTOR_TYPE_SAMPLER, the pSampler member of data must be a valid pointer to a valid VkSampler handle
• If type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the pCombinedImageSampler member of data must be a valid pointer to a valid VkDescriptorImageInfo structure
• If type is DESCRIPTOR_TYPE_INPUT_ATTACHMENT, the pInputAttachmentImage member of data must be a valid pointer to a valid VkDescriptorImageInfo structure
• If type is DESCRIPTOR_TYPE_SAMPLED_IMAGE, and if pSampledImage is not NULL, the pSampledImage member of data must be a valid pointer to a valid VkDescriptorImageInfo structure
• If type is DESCRIPTOR_TYPE_STORAGE_IMAGE, and if pStorageImage is not NULL, the pStorageImage member of data must be a valid pointer to a valid VkDescriptorImageInfo structure
• If type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, and if pUniformTexelBuffer is not NULL, the pUniformTexelBuffer member of data must be a valid pointer to a valid VkDescriptorAddressInfoEXT structure
• If type is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, and if pStorageTexelBuffer is not NULL, the pStorageTexelBuffer member of data must be a valid pointer to a valid VkDescriptorAddressInfoEXT structure
• If type is DESCRIPTOR_TYPE_UNIFORM_BUFFER, and if pUniformBuffer is not NULL, the pUniformBuffer member of data must be a valid pointer to a valid VkDescriptorAddressInfoEXT structure
• If type is DESCRIPTOR_TYPE_STORAGE_BUFFER, and if pStorageBuffer is not NULL, the pStorageBuffer member of data must be a valid pointer to a valid VkDescriptorAddressInfoEXT structure

See Also

VkDescriptorDataEXT, GetDescriptorEXT

Layout

 struct VkDescriptorGetInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkDescriptorType type();
     VkDescriptorDataEXT data();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDescriptorGetInfoEXT.Buffer	An array of VkDescriptorGetInfoEXT 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	DATA	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	TYPE	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
VkDescriptorGetInfoEXT(ByteBuffer container)	Creates a VkDescriptorGetInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDescriptorGetInfoEXT	calloc()	Returns a new VkDescriptorGetInfoEXT instance allocated with memCalloc.
static VkDescriptorGetInfoEXT.Buffer	calloc(int capacity)	Returns a new VkDescriptorGetInfoEXT.Buffer instance allocated with memCalloc.
static VkDescriptorGetInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorGetInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorGetInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorGetInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorGetInfoEXT	create()	Returns a new VkDescriptorGetInfoEXT instance allocated with BufferUtils.
static VkDescriptorGetInfoEXT.Buffer	create(int capacity)	Returns a new VkDescriptorGetInfoEXT.Buffer instance allocated with BufferUtils.
static VkDescriptorGetInfoEXT	create(long address)	Returns a new VkDescriptorGetInfoEXT instance for the specified memory address.
static VkDescriptorGetInfoEXT.Buffer	create(long address, int capacity)	Create a VkDescriptorGetInfoEXT.Buffer instance at the specified memory.
static @Nullable VkDescriptorGetInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDescriptorGetInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkDescriptorDataEXT	data()	a structure containing the information needed to get the descriptor.
VkDescriptorGetInfoEXT	data(Consumer<VkDescriptorDataEXT> consumer)	Passes the data() field to the specified Consumer.
VkDescriptorGetInfoEXT	data(VkDescriptorDataEXT value)	Copies the specified VkDescriptorDataEXT to the data() field.
static VkDescriptorGetInfoEXT	malloc()	Returns a new VkDescriptorGetInfoEXT instance allocated with memAlloc.
static VkDescriptorGetInfoEXT.Buffer	malloc(int capacity)	Returns a new VkDescriptorGetInfoEXT.Buffer instance allocated with memAlloc.
static VkDescriptorGetInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorGetInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkDescriptorGetInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorGetInfoEXT instance allocated on the specified MemoryStack.
static VkDescriptorDataEXT	ndata(long struct)	Unsafe version of data().
static void	ndata(long struct, VkDescriptorDataEXT value)	Unsafe version of data.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDescriptorGetInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkDescriptorGetInfoEXT	set(int sType, long pNext, int type, VkDescriptorDataEXT data)	Initializes this struct with the specified values.
VkDescriptorGetInfoEXT	set(VkDescriptorGetInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDescriptorGetInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkDescriptorGetInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_DESCRIPTOR_GET_INFO_EXT value to the sType() field.
int	type()	the type of descriptor to get.
VkDescriptorGetInfoEXT	type(int value)	Sets the specified value to the type() 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.

TYPE

public static final int TYPE

The struct member offsets.

DATA

public static final int DATA

The struct member offsets.

Constructor Details

VkDescriptorGetInfoEXT

public VkDescriptorGetInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

type

public int type()

the type of descriptor to get.

data

public VkDescriptorDataEXT data()

a structure containing the information needed to get the descriptor.

sType

public VkDescriptorGetInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDescriptorGetInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_DESCRIPTOR_GET_INFO_EXT value to the sType() field.

pNext

public VkDescriptorGetInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

type

public VkDescriptorGetInfoEXT type(int value)

Sets the specified value to the type() field.

data

public VkDescriptorGetInfoEXT data(VkDescriptorDataEXT value)

Copies the specified VkDescriptorDataEXT to the data() field.

data

public VkDescriptorGetInfoEXT data(Consumer<VkDescriptorDataEXT> consumer)

Passes the data() field to the specified Consumer.

set

public VkDescriptorGetInfoEXT set(int sType,
 long pNext,
 int type,
 VkDescriptorDataEXT data)

Initializes this struct with the specified values.

set

public VkDescriptorGetInfoEXT set(VkDescriptorGetInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDescriptorGetInfoEXT malloc()

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

calloc

public static VkDescriptorGetInfoEXT calloc()

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

create

public static VkDescriptorGetInfoEXT create()

Returns a new VkDescriptorGetInfoEXT instance allocated with BufferUtils.

create

public static VkDescriptorGetInfoEXT create(long address)

Returns a new VkDescriptorGetInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkDescriptorGetInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorGetInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDescriptorGetInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDescriptorGetInfoEXT.Buffer create(int capacity)

Returns a new VkDescriptorGetInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDescriptorGetInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkDescriptorGetInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntype

public static int ntype(long struct)

Unsafe version of type().

ndata

public static VkDescriptorDataEXT ndata(long struct)

Unsafe version of data().

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.

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

ndata

public static void ndata(long struct,
 VkDescriptorDataEXT value)

Unsafe version of data.