Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDescriptorImageInfo

extends Struct<VkDescriptorImageInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying descriptor image information.
Description

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

Valid Usage
Valid Usage (Implicit)
See Also

VkDescriptorDataEXT, VkWriteDescriptorSet

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
IMAGELAYOUT

The struct member offsets.

public static final int
IMAGEVIEW

The struct member offsets.

public static final int
SAMPLER

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkDescriptorImageInfo(long address, ByteBuffer container)

public
VkDescriptorImageInfo(ByteBuffer container)

Creates a VkDescriptorImageInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkDescriptorImageInfo
calloc()

Returns a new VkDescriptorImageInfo instance allocated with memCalloc.

public static VkDescriptorImageInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkDescriptorImageInfo.Buffer instance allocated with memCalloc.

public static VkDescriptorImageInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkDescriptorImageInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkDescriptorImageInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorImageInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorImageInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorImageInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkDescriptorImageInfo
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 VkDescriptorImageInfo
create()

Returns a new VkDescriptorImageInfo instance allocated with BufferUtils.

public static VkDescriptorImageInfo
create(long address)

Returns a new VkDescriptorImageInfo instance for the specified memory address.

public static VkDescriptorImageInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkDescriptorImageInfo.Buffer instance allocated with BufferUtils.

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

Create a VkDescriptorImageInfo.Buffer instance at the specified memory.

public static VkDescriptorImageInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
imageLayout()

the layout that the image subresources accessible from imageView will be in at the time this descriptor is accessed.

public VkDescriptorImageInfo
imageLayout(int value)

Sets the specified value to the imageLayout field.

public long
public VkDescriptorImageInfo
imageView(long value)

Sets the specified value to the imageView field.

public static VkDescriptorImageInfo
malloc()

Returns a new VkDescriptorImageInfo instance allocated with memAlloc.

public static VkDescriptorImageInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkDescriptorImageInfo.Buffer instance allocated with memAlloc.

public static VkDescriptorImageInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDescriptorImageInfo instance allocated on the specified MemoryStack.

public static VkDescriptorImageInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkDescriptorImageInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorImageInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorImageInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDescriptorImageInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nimageLayout(long struct)

Unsafe version of imageLayout.

public static void
nimageLayout(long struct, int value)

Unsafe version of imageLayout.

public static long
nimageView(long struct)

Unsafe version of imageView.

public static void
nimageView(long struct, long value)

Unsafe version of imageView.

public static long
nsampler(long struct)

Unsafe version of sampler.

public static void
nsampler(long struct, long value)

Unsafe version of 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.

public VkDescriptorImageInfo
sampler(long value)

Sets the specified value to the sampler field.

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

Initializes this struct with the specified values.

public VkDescriptorImageInfo

Returns:

this struct
set
(VkDescriptorImageInfo
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).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

IMAGELAYOUTback to summary
public static final int IMAGELAYOUT

The struct member offsets.

IMAGEVIEWback to summary
public static final int IMAGEVIEW

The struct member offsets.

SAMPLERback to summary
public static final int SAMPLER

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkDescriptorImageInfoback to summary
protected VkDescriptorImageInfo(long address, ByteBuffer container)
VkDescriptorImageInfoback to summary
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 Detail

callocback to summary
public static VkDescriptorImageInfo calloc()

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

callocback to summary
public static VkDescriptorImageInfo.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDescriptorImageInfo calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkDescriptorImageInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkDescriptorImageInfo callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDescriptorImageInfo callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDescriptorImageInfo.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDescriptorImageInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkDescriptorImageInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkDescriptorImageInfo create()

Returns a new VkDescriptorImageInfo instance allocated with BufferUtils.

createback to summary
public static VkDescriptorImageInfo create(long address)

Returns a new VkDescriptorImageInfo instance for the specified memory address.

createback to summary
public static VkDescriptorImageInfo.Buffer create(int capacity)

Returns a new VkDescriptorImageInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDescriptorImageInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDescriptorImageInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkDescriptorImageInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageLayoutback to summary
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.

Annotations
@NativeType:VkImageLayout
imageLayoutback to summary
public VkDescriptorImageInfo imageLayout(int value)

Sets the specified value to the imageLayout field.

imageViewback to summary
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.

Annotations
@NativeType:VkImageView
imageViewback to summary
public VkDescriptorImageInfo imageView(long value)

Sets the specified value to the imageView field.

mallocback to summary
public static VkDescriptorImageInfo malloc()

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

mallocback to summary
public static VkDescriptorImageInfo.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDescriptorImageInfo malloc(MemoryStack stack)

Returns a new VkDescriptorImageInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkDescriptorImageInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkDescriptorImageInfo mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDescriptorImageInfo mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDescriptorImageInfo.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDescriptorImageInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nimageLayoutback to summary
public static int nimageLayout(long struct)

Unsafe version of imageLayout.

nimageLayoutback to summary
public static void nimageLayout(long struct, int value)

Unsafe version of imageLayout.

nimageViewback to summary
public static long nimageView(long struct)

Unsafe version of imageView.

nimageViewback to summary
public static void nimageView(long struct, long value)

Unsafe version of imageView.

nsamplerback to summary
public static long nsampler(long struct)

Unsafe version of sampler.

nsamplerback to summary
public static void nsampler(long struct, long value)

Unsafe version of sampler.

samplerback to summary
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.

Annotations
@NativeType:VkSampler
samplerback to summary
public VkDescriptorImageInfo sampler(long value)

Sets the specified value to the sampler field.

setback to summary
public VkDescriptorImageInfo set(long sampler, long imageView, int imageLayout)

Initializes this struct with the specified values.

setback to summary
public VkDescriptorImageInfo set(VkDescriptorImageInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkDescriptorImageInfo

the source struct

Returns:VkDescriptorImageInfo

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkDescriptorImageInfo.Buffer

extends StructBuffer<VkDescriptorImageInfo, VkDescriptorImageInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDescriptorImageInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkDescriptorImageInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDescriptorImageInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkDescriptorImageInfo
public int

Returns:

the value of the VkDescriptorImageInfo#imageLayout field.
imageLayout
()

public VkDescriptorImageInfo.Buffer
imageLayout(int value)

Sets the specified value to the VkDescriptorImageInfo#imageLayout field.

public long

Returns:

the value of the VkDescriptorImageInfo#imageView field.
imageView
()

public VkDescriptorImageInfo.Buffer
imageView(long value)

Sets the specified value to the VkDescriptorImageInfo#imageView field.

public long

Returns:

the value of the VkDescriptorImageInfo#sampler field.
sampler
()

public VkDescriptorImageInfo.Buffer
sampler(long value)

Sets the specified value to the VkDescriptorImageInfo#sampler field.

protected VkDescriptorImageInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDescriptorImageInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDescriptorImageInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkDescriptorImageInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkDescriptorImageInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
imageLayoutback to summary
public int imageLayout()
Returns:int

the value of the VkDescriptorImageInfo#imageLayout field.

Annotations
@NativeType:VkImageLayout
imageLayoutback to summary
public VkDescriptorImageInfo.Buffer imageLayout(int value)

Sets the specified value to the VkDescriptorImageInfo#imageLayout field.

imageViewback to summary
public long imageView()
Returns:long

the value of the VkDescriptorImageInfo#imageView field.

Annotations
@NativeType:VkImageView
imageViewback to summary
public VkDescriptorImageInfo.Buffer imageView(long value)

Sets the specified value to the VkDescriptorImageInfo#imageView field.

samplerback to summary
public long sampler()
Returns:long

the value of the VkDescriptorImageInfo#sampler field.

Annotations
@NativeType:VkSampler
samplerback to summary
public VkDescriptorImageInfo.Buffer sampler(long value)

Sets the specified value to the VkDescriptorImageInfo#sampler field.

selfback to summary
protected VkDescriptorImageInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override