Package org.lwjgl.vulkan

Class VkDescriptorImageInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDescriptorImageInfo>

org.lwjgl.vulkan.VkDescriptorImageInfo

All Implemented Interfaces:

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

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

Structure specifying descriptor image information.

Description

Members of VkDescriptorImageInfo that are not used in an update (as described above) are ignored.

Valid Usage

• imageView must not be a 2D array image view created from a 3D image
• If imageView is a 2D view created from a 3D image, then descriptorType must be DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_SAMPLED_IMAGE, or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
• If imageView is a 2D view created from a 3D image, then the image must have been created with IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT set
• If the image2DViewOf3D feature is not enabled or descriptorType is not DESCRIPTOR_TYPE_STORAGE_IMAGE then imageView must not be a 2D view created from a 3D image
• If the sampler2DViewOf3D feature is not enabled or descriptorType is not DESCRIPTOR_TYPE_SAMPLED_IMAGE or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER then imageView must not be a 2D view created from a 3D image
• If imageView is created from a depth/stencil image, the aspectMask used to create the imageView must include either IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT but not both
• If imageLayout is IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, then the aspectMask used to create imageView must not include either IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• If imageLayout is IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, then the aspectMask used to create imageView must not include IMAGE_ASPECT_COLOR_BIT
• imageLayout must match the actual VkImageLayout of each subresource accessible from imageView at the time this descriptor is accessed as defined by the image layout matching rules
• If sampler is used and the VkFormat of the image is a multi-planar format, the image must have been created with IMAGE_CREATE_MUTABLE_FORMAT_BIT, and the aspectMask of the imageView must be a valid multi-planar aspect mask bit
• If the VK_KHR_portability_subset extension is enabled, and VkPhysicalDevicePortabilitySubsetFeaturesKHR::mutableComparisonSamplers is FALSE, then sampler must have been created with VkSamplerCreateInfo::compareEnable set to FALSE

Valid Usage (Implicit)

• Both of imageView, and sampler that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice

See Also

VkDescriptorDataEXT, VkWriteDescriptorSet

Layout

 struct VkDescriptorImageInfo {
     VkSampler sampler();
     VkImageView imageView();
     VkImageLayout imageLayout();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDescriptorImageInfo.Buffer	An array of VkDescriptorImageInfo 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	IMAGELAYOUT	The struct member offsets.
static final int	IMAGEVIEW	The struct member offsets.
static final int	SAMPLER	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDescriptorImageInfo(ByteBuffer container)	Creates a VkDescriptorImageInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDescriptorImageInfo	calloc()	Returns a new VkDescriptorImageInfo instance allocated with memCalloc.
static VkDescriptorImageInfo.Buffer	calloc(int capacity)	Returns a new VkDescriptorImageInfo.Buffer instance allocated with memCalloc.
static VkDescriptorImageInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorImageInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorImageInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorImageInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorImageInfo	callocStack()	Deprecated.
static VkDescriptorImageInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkDescriptorImageInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDescriptorImageInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDescriptorImageInfo	create()	Returns a new VkDescriptorImageInfo instance allocated with BufferUtils.
static VkDescriptorImageInfo.Buffer	create(int capacity)	Returns a new VkDescriptorImageInfo.Buffer instance allocated with BufferUtils.
static VkDescriptorImageInfo	create(long address)	Returns a new VkDescriptorImageInfo instance for the specified memory address.
static VkDescriptorImageInfo.Buffer	create(long address, int capacity)	Create a VkDescriptorImageInfo.Buffer instance at the specified memory.
static @Nullable VkDescriptorImageInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDescriptorImageInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	imageLayout()	the layout that the image subresources accessible from imageView will be in at the time this descriptor is accessed.
VkDescriptorImageInfo	imageLayout(int value)	Sets the specified value to the imageLayout() field.
long	imageView()	NULL_HANDLE or an image view handle, and is used in descriptor updates for types DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and DESCRIPTOR_TYPE_INPUT_ATTACHMENT.
VkDescriptorImageInfo	imageView(long value)	Sets the specified value to the imageView() field.
static VkDescriptorImageInfo	malloc()	Returns a new VkDescriptorImageInfo instance allocated with memAlloc.
static VkDescriptorImageInfo.Buffer	malloc(int capacity)	Returns a new VkDescriptorImageInfo.Buffer instance allocated with memAlloc.
static VkDescriptorImageInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorImageInfo.Buffer instance allocated on the specified MemoryStack.
static VkDescriptorImageInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDescriptorImageInfo instance allocated on the specified MemoryStack.
static VkDescriptorImageInfo	mallocStack()	Deprecated.
static VkDescriptorImageInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkDescriptorImageInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDescriptorImageInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nimageLayout(long struct)	Unsafe version of imageLayout().
static void	nimageLayout(long struct, int value)	Unsafe version of imageLayout.
static long	nimageView(long struct)	Unsafe version of imageView().
static void	nimageView(long struct, long value)	Unsafe version of imageView.
static long	nsampler(long struct)	Unsafe version of sampler().
static void	nsampler(long struct, long value)	Unsafe version of sampler.
long	sampler()	a sampler handle, and is used in descriptor updates for types DESCRIPTOR_TYPE_SAMPLER and DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER if the binding being updated does not use immutable samplers.
VkDescriptorImageInfo	sampler(long value)	Sets the specified value to the sampler() field.
VkDescriptorImageInfo	set(long sampler, long imageView, int imageLayout)	Initializes this struct with the specified values.
VkDescriptorImageInfo	set(VkDescriptorImageInfo src)	Copies the specified struct data to this struct.
int	sizeof()

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.

SAMPLER

public static final int SAMPLER

The struct member offsets.

IMAGEVIEW

public static final int IMAGEVIEW

The struct member offsets.

IMAGELAYOUT

public static final int IMAGELAYOUT

The struct member offsets.

Constructor Details

VkDescriptorImageInfo

public VkDescriptorImageInfo(ByteBuffer container)

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

sampler

public long sampler()

a sampler handle, and is used in descriptor updates for types DESCRIPTOR_TYPE_SAMPLER and DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER if the binding being updated does not use immutable samplers.

imageView

public long imageView()

NULL_HANDLE or an image view handle, and is used in descriptor updates for types DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and DESCRIPTOR_TYPE_INPUT_ATTACHMENT.

imageLayout

public int imageLayout()

the layout that the image subresources accessible from imageView will be in at the time this descriptor is accessed. imageLayout is used in descriptor updates for types DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and DESCRIPTOR_TYPE_INPUT_ATTACHMENT.

sampler

public VkDescriptorImageInfo sampler(long value)

Sets the specified value to the sampler() field.

imageView

public VkDescriptorImageInfo imageView(long value)

Sets the specified value to the imageView() field.

imageLayout

public VkDescriptorImageInfo imageLayout(int value)

Sets the specified value to the imageLayout() field.

set

public VkDescriptorImageInfo set(long sampler,
 long imageView,
 int imageLayout)

Initializes this struct with the specified values.

set

public VkDescriptorImageInfo set(VkDescriptorImageInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDescriptorImageInfo malloc()

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

calloc

public static VkDescriptorImageInfo calloc()

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

create

public static VkDescriptorImageInfo create()

Returns a new VkDescriptorImageInfo instance allocated with BufferUtils.

create

public static VkDescriptorImageInfo create(long address)

Returns a new VkDescriptorImageInfo instance for the specified memory address.

createSafe

public static @Nullable VkDescriptorImageInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorImageInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDescriptorImageInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDescriptorImageInfo.Buffer create(int capacity)

Returns a new VkDescriptorImageInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDescriptorImageInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDescriptorImageInfo mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkDescriptorImageInfo callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkDescriptorImageInfo mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkDescriptorImageInfo callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkDescriptorImageInfo.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkDescriptorImageInfo.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkDescriptorImageInfo.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkDescriptorImageInfo.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

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

Returns a new VkDescriptorImageInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkDescriptorImageInfo.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

nsampler

public static long nsampler(long struct)

Unsafe version of sampler().

nimageView

public static long nimageView(long struct)

Unsafe version of imageView().

nimageLayout

public static int nimageLayout(long struct)

Unsafe version of imageLayout().

nsampler

public static void nsampler(long struct,
 long value)

Unsafe version of sampler.

nimageView

public static void nimageView(long struct,
 long value)

Unsafe version of imageView.

nimageLayout

public static void nimageLayout(long struct,
 int value)

Unsafe version of imageLayout.