LWJGL 3.3.3 · org.lwjgl.vulkan.VkDescriptorDataEXT

Structure specifying descriptor data.

Description

If the nullDescriptor feature is enabled, pSampledImage, pStorageImage, pUniformTexelBuffer, pStorageTexelBuffer, pUniformBuffer, and pStorageBuffer can each be NULL. Loads from a null descriptor return zero values and stores and atomics to a null descriptor are discarded.

If the nullDescriptor feature is enabled, accelerationStructure can be 0. A null acceleration structure descriptor results in the miss shader being invoked.

Valid Usage

If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_UNIFORM_BUFFER, and pUniformBuffer→address is the address of a non-sparse buffer, then that buffer must be bound completely and contiguously to a single VkDeviceMemory object
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_STORAGE_BUFFER, and pStorageBuffer→address is the address of a non-sparse buffer, then that buffer must be bound completely and contiguously to a single VkDeviceMemory object
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, and pUniformTexelBuffer→address is the address of a non-sparse buffer, then that buffer must be bound completely and contiguously to a single VkDeviceMemory object
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, and pStorageTexelBuffer→address is the address of a non-sparse buffer, then that buffer must be bound completely and contiguously to a single VkDeviceMemory object
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and the nullDescriptor feature is not enabled, pCombinedImageSampler→imageView must not be NULL_HANDLE
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_SAMPLED_IMAGE, and the nullDescriptor feature is not enabled, pSampledImage must not be NULL and pSampledImage→imageView must not be NULL_HANDLE
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_STORAGE_IMAGE, and the nullDescriptor feature is not enabled, pStorageImage must not be NULL and pStorageImage→imageView must not be NULL_HANDLE
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, and the nullDescriptor feature is not enabled, pUniformTexelBuffer must not be NULL
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, and the nullDescriptor feature is not enabled, pStorageTexelBuffer must not be NULL
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_UNIFORM_BUFFER, and the nullDescriptor feature is not enabled, pUniformBuffer must not be NULL
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_STORAGE_BUFFER, and the nullDescriptor feature is not enabled, pStorageBuffer must not be NULL
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, and the nullDescriptor feature is not enabled, accelerationStructure must not be 0
If VkDescriptorGetInfoEXT:type is DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV, and the nullDescriptor feature is not enabled, accelerationStructure must not be 0

Layout


union VkDescriptorDataEXT {
    VkSampler const * pSampler;
    VkDescriptorImageInfo const * pCombinedImageSampler;
    VkDescriptorImageInfo const * pInputAttachmentImage;
    VkDescriptorImageInfo const * pSampledImage;
    VkDescriptorImageInfo const * pStorageImage;
    VkDescriptorAddressInfoEXT const * pUniformTexelBuffer;
    VkDescriptorAddressInfoEXT const * pStorageTexelBuffer;
    VkDescriptorAddressInfoEXT const * pUniformBuffer;
    VkDescriptorAddressInfoEXT const * pStorageBuffer;
    VkDeviceAddress accelerationStructure;
}

Modifier and Type	Class and Description
public static class	VkDescriptorDataEXT.Buffer An array of `VkDescriptorDataEXT` structs.

Modifier and Type	Field and Description
public static final int	ACCELERATIONSTRUCTURE The struct member offsets.
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	PCOMBINEDIMAGESAMPLER The struct member offsets.
public static final int	PINPUTATTACHMENTIMAGE The struct member offsets.
public static final int	PSAMPLEDIMAGE The struct member offsets.
public static final int	PSAMPLER The struct member offsets.
public static final int	PSTORAGEBUFFER The struct member offsets.
public static final int	PSTORAGEIMAGE The struct member offsets.
public static final int	PSTORAGETEXELBUFFER The struct member offsets.
public static final int	PUNIFORMBUFFER The struct member offsets.
public static final int	PUNIFORMTEXELBUFFER The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Access	Constructor and Description
protected	VkDescriptorDataEXT(long address, ByteBuffer container)
public	VkDescriptorDataEXT(ByteBuffer container) Creates a `VkDescriptorDataEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public long	accelerationStructure() the address of a `VkAccelerationStructureKHR` specifying the parameters of a `DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR` descriptor , or a `VkAccelerationStructureNV` handle specifying the parameters of a `DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV` descriptor.
public VkDescriptorDataEXT	accelerationStructure(long value) Sets the specified value to the `accelerationStructure` field.
public static VkDescriptorDataEXT	calloc() Returns a new `VkDescriptorDataEXT` instance allocated with `memCalloc`.
public static VkDescriptorDataEXT.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkDescriptorDataEXT.Buffer` instance allocated with `memCalloc`.
public static VkDescriptorDataEXT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorDataEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDescriptorDataEXT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorDataEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkDescriptorDataEXT	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 VkDescriptorDataEXT	create() Returns a new `VkDescriptorDataEXT` instance allocated with `BufferUtils`.
public static VkDescriptorDataEXT	create(long address) Returns a new `VkDescriptorDataEXT` instance for the specified memory address.
public static VkDescriptorDataEXT.Buffer	create(int the buffer capacity capacity) Returns a new `VkDescriptorDataEXT.Buffer` instance allocated with `BufferUtils`.
public static VkDescriptorDataEXT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkDescriptorDataEXT.Buffer` instance at the specified memory.
public static VkDescriptorDataEXT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkDescriptorDataEXT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkDescriptorDataEXT	malloc() Returns a new `VkDescriptorDataEXT` instance allocated with `memAlloc`.
public static VkDescriptorDataEXT.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkDescriptorDataEXT.Buffer` instance allocated with `memAlloc`.
public static VkDescriptorDataEXT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorDataEXT` instance allocated on the specified `MemoryStack`.
public static VkDescriptorDataEXT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDescriptorDataEXT.Buffer` instance allocated on the specified `MemoryStack`.
public static long	naccelerationStructure(long struct) Unsafe version of `accelerationStructure`.
public static void	naccelerationStructure(long struct, long value) Unsafe version of `accelerationStructure`.
public static VkDescriptorImageInfo	npCombinedImageSampler(long struct) Unsafe version of `pCombinedImageSampler`.
public static void	npCombinedImageSampler(long struct, VkDescriptorImageInfo value) Unsafe version of `pCombinedImageSampler`.
public static VkDescriptorImageInfo	npInputAttachmentImage(long struct) Unsafe version of `pInputAttachmentImage`.
public static void	npInputAttachmentImage(long struct, VkDescriptorImageInfo value) Unsafe version of `pInputAttachmentImage`.
public static VkDescriptorImageInfo	npSampledImage(long struct) Unsafe version of `pSampledImage`.
public static void	npSampledImage(long struct, VkDescriptorImageInfo value) Unsafe version of `pSampledImage`.
public static LongBuffer	npSampler(long struct, int capacity) Unsafe version of `pSampler`.
public static void	npSampler(long struct, LongBuffer value) Unsafe version of `pSampler`.
public static VkDescriptorAddressInfoEXT	npStorageBuffer(long struct) Unsafe version of `pStorageBuffer`.
public static void	npStorageBuffer(long struct, VkDescriptorAddressInfoEXT value) Unsafe version of `pStorageBuffer`.
public static VkDescriptorImageInfo	npStorageImage(long struct) Unsafe version of `pStorageImage`.
public static void	npStorageImage(long struct, VkDescriptorImageInfo value) Unsafe version of `pStorageImage`.
public static VkDescriptorAddressInfoEXT	npStorageTexelBuffer(long struct) Unsafe version of `pStorageTexelBuffer`.
public static void	npStorageTexelBuffer(long struct, VkDescriptorAddressInfoEXT value) Unsafe version of `pStorageTexelBuffer`.
public static VkDescriptorAddressInfoEXT	npUniformBuffer(long struct) Unsafe version of `pUniformBuffer`.
public static void	npUniformBuffer(long struct, VkDescriptorAddressInfoEXT value) Unsafe version of `pUniformBuffer`.
public static VkDescriptorAddressInfoEXT	npUniformTexelBuffer(long struct) Unsafe version of `pUniformTexelBuffer`.
public static void	npUniformTexelBuffer(long struct, VkDescriptorAddressInfoEXT value) Unsafe version of `pUniformTexelBuffer`.
public VkDescriptorImageInfo	pCombinedImageSampler() a pointer to a `VkDescriptorImageInfo` structure specifying the parameters of a `DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER` descriptor.
public VkDescriptorDataEXT	pCombinedImageSampler(VkDescriptorImageInfo value) Sets the address of the specified `VkDescriptorImageInfo` to the `pCombinedImageSampler` field.
public VkDescriptorImageInfo	pInputAttachmentImage() a pointer to a `VkDescriptorImageInfo` structure specifying the parameters of a `DESCRIPTOR_TYPE_INPUT_ATTACHMENT` descriptor.
public VkDescriptorDataEXT	pInputAttachmentImage(VkDescriptorImageInfo value) Sets the address of the specified `VkDescriptorImageInfo` to the `pInputAttachmentImage` field.
public VkDescriptorImageInfo	pSampledImage() a pointer to a `VkDescriptorImageInfo` structure specifying the parameters of a `DESCRIPTOR_TYPE_SAMPLED_IMAGE` descriptor.
public VkDescriptorDataEXT	pSampledImage(VkDescriptorImageInfo value) Sets the address of the specified `VkDescriptorImageInfo` to the `pSampledImage` field.
public LongBuffer	Returns: a pointer to a `VkSampler` handle specifying the parameters of a `DESCRIPTOR_TYPE_SAMPLER` descriptor. pSampler(int the number of elements in the returned buffer capacity)
public VkDescriptorDataEXT	pSampler(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pSampler` field.
public VkDescriptorAddressInfoEXT	pStorageBuffer() a pointer to a `VkDescriptorAddressInfoEXT` structure specifying the parameters of a `DESCRIPTOR_TYPE_STORAGE_BUFFER` descriptor.
public VkDescriptorDataEXT	pStorageBuffer(VkDescriptorAddressInfoEXT value) Sets the address of the specified `VkDescriptorAddressInfoEXT` to the `pStorageBuffer` field.
public VkDescriptorImageInfo	pStorageImage() a pointer to a `VkDescriptorImageInfo` structure specifying the parameters of a `DESCRIPTOR_TYPE_STORAGE_IMAGE` descriptor.
public VkDescriptorDataEXT	pStorageImage(VkDescriptorImageInfo value) Sets the address of the specified `VkDescriptorImageInfo` to the `pStorageImage` field.
public VkDescriptorAddressInfoEXT	pStorageTexelBuffer() a pointer to a `VkDescriptorAddressInfoEXT` structure specifying the parameters of a `DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER` descriptor.
public VkDescriptorDataEXT	pStorageTexelBuffer(VkDescriptorAddressInfoEXT value) Sets the address of the specified `VkDescriptorAddressInfoEXT` to the `pStorageTexelBuffer` field.
public VkDescriptorAddressInfoEXT	pUniformBuffer() a pointer to a `VkDescriptorAddressInfoEXT` structure specifying the parameters of a `DESCRIPTOR_TYPE_UNIFORM_BUFFER` descriptor.
public VkDescriptorDataEXT	pUniformBuffer(VkDescriptorAddressInfoEXT value) Sets the address of the specified `VkDescriptorAddressInfoEXT` to the `pUniformBuffer` field.
public VkDescriptorAddressInfoEXT	pUniformTexelBuffer() a pointer to a `VkDescriptorAddressInfoEXT` structure specifying the parameters of a `DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER` descriptor.
public VkDescriptorDataEXT	pUniformTexelBuffer(VkDescriptorAddressInfoEXT value) Sets the address of the specified `VkDescriptorAddressInfoEXT` to the `pUniformTexelBuffer` field.
public VkDescriptorDataEXT	Returns: this struct set(VkDescriptorDataEXT 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 Class VkDescriptorDataEXT

Description

Valid Usage

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary