Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkResolveImageInfo2

extends Struct<VkResolveImageInfo2>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkResolveImageInfo2KHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying parameters of resolve image command.
Valid Usage
Valid Usage (Implicit)
See Also

VkImageResolve2, CmdResolveImage2, CmdResolveImage2KHR

Layout


struct VkResolveImageInfo2 {
    VkStructureType sType;
    void const * pNext;
    VkImage srcImage;
    VkImageLayout srcImageLayout;
    VkImage dstImage;
    VkImageLayout dstImageLayout;
    uint32_t regionCount;
    VkImageResolve2 const * pRegions;
}

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
DSTIMAGE

The struct member offsets.

public static final int
DSTIMAGELAYOUT

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PREGIONS

The struct member offsets.

public static final int
REGIONCOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SRCIMAGE

The struct member offsets.

public static final int
SRCIMAGELAYOUT

The struct member offsets.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkResolveImageInfo2(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkResolveImageInfo2
calloc()

Returns a new VkResolveImageInfo2 instance allocated with memCalloc.

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

Returns a new VkResolveImageInfo2.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkResolveImageInfo2
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 VkResolveImageInfo2
create()

Returns a new VkResolveImageInfo2 instance allocated with BufferUtils.

public static VkResolveImageInfo2
create(long address)

Returns a new VkResolveImageInfo2 instance for the specified memory address.

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

Returns a new VkResolveImageInfo2.Buffer instance allocated with BufferUtils.

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

Create a VkResolveImageInfo2.Buffer instance at the specified memory.

public static VkResolveImageInfo2
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
dstImage()

the destination image.

public VkResolveImageInfo2
dstImage(long value)

Sets the specified value to the dstImage field.

public int
dstImageLayout()

the layout of the destination image subresources for the resolve.

public VkResolveImageInfo2
dstImageLayout(int value)

Sets the specified value to the dstImageLayout field.

public static VkResolveImageInfo2
malloc()

Returns a new VkResolveImageInfo2 instance allocated with memAlloc.

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

Returns a new VkResolveImageInfo2.Buffer instance allocated with memAlloc.

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

Returns a new VkResolveImageInfo2 instance allocated on the specified MemoryStack.

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

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

public static long
ndstImage(long struct)

Unsafe version of dstImage.

public static void
ndstImage(long struct, long value)

Unsafe version of dstImage.

public static int
ndstImageLayout(long struct)

Unsafe version of dstImageLayout.

public static void
ndstImageLayout(long struct, int value)

Unsafe version of dstImageLayout.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkImageResolve2.Buffer
npRegions(long struct)

Unsafe version of pRegions.

public static void
npRegions(long struct, VkImageResolve2.Buffer value)

Unsafe version of pRegions.

public static int
nregionCount(long struct)

Unsafe version of regionCount.

public static void
nregionCount(long struct, int value)

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

public static long
nsrcImage(long struct)

Unsafe version of srcImage.

public static void
nsrcImage(long struct, long value)

Unsafe version of srcImage.

public static int
nsrcImageLayout(long struct)

Unsafe version of srcImageLayout.

public static void
nsrcImageLayout(long struct, int value)

Unsafe version of srcImageLayout.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkResolveImageInfo2
pNext(long value)

Sets the specified value to the pNext field.

public VkImageResolve2.Buffer
pRegions()

a pointer to an array of VkImageResolve2 structures specifying the regions to resolve.

public VkResolveImageInfo2
pRegions(VkImageResolve2.Buffer value)

Sets the address of the specified VkImageResolve2.Buffer to the pRegions field.

public int
regionCount()

the number of regions to resolve.

public VkResolveImageInfo2
set(int sType, long pNext, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageResolve2.Buffer pRegions)

Initializes this struct with the specified values.

public VkResolveImageInfo2

Returns:

this struct
set
(VkResolveImageInfo2
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 long
srcImage()

the source image.

public VkResolveImageInfo2
srcImage(long value)

Sets the specified value to the srcImage field.

public int
srcImageLayout()

the layout of the source image subresources for the resolve.

public VkResolveImageInfo2
srcImageLayout(int value)

Sets the specified value to the srcImageLayout field.

public int
sType()

a VkStructureType value identifying this structure.

public VkResolveImageInfo2
sType(int value)

Sets the specified value to the sType field.

public VkResolveImageInfo2
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

DSTIMAGEback to summary
public static final int DSTIMAGE

The struct member offsets.

DSTIMAGELAYOUTback to summary
public static final int DSTIMAGELAYOUT

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PREGIONSback to summary
public static final int PREGIONS

The struct member offsets.

REGIONCOUNTback to summary
public static final int REGIONCOUNT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SRCIMAGEback to summary
public static final int SRCIMAGE

The struct member offsets.

SRCIMAGELAYOUTback to summary
public static final int SRCIMAGELAYOUT

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkResolveImageInfo2back to summary
protected VkResolveImageInfo2(long address, ByteBuffer container)
VkResolveImageInfo2back to summary
public VkResolveImageInfo2(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkResolveImageInfo2 calloc(MemoryStack stack)

Returns a new VkResolveImageInfo2 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 VkResolveImageInfo2.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected VkResolveImageInfo2 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 VkResolveImageInfo2 create()

Returns a new VkResolveImageInfo2 instance allocated with BufferUtils.

createback to summary
public static VkResolveImageInfo2 create(long address)

Returns a new VkResolveImageInfo2 instance for the specified memory address.

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

Returns a new VkResolveImageInfo2.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkResolveImageInfo2.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkResolveImageInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
dstImageback to summary
public long dstImage()

the destination image.

Annotations
@NativeType:VkImage
dstImageback to summary
public VkResolveImageInfo2 dstImage(long value)

Sets the specified value to the dstImage field.

dstImageLayoutback to summary
public int dstImageLayout()

the layout of the destination image subresources for the resolve.

Annotations
@NativeType:VkImageLayout
dstImageLayoutback to summary
public VkResolveImageInfo2 dstImageLayout(int value)

Sets the specified value to the dstImageLayout field.

mallocback to summary
public static VkResolveImageInfo2 malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkResolveImageInfo2 malloc(MemoryStack stack)

Returns a new VkResolveImageInfo2 instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndstImageback to summary
public static long ndstImage(long struct)

Unsafe version of dstImage.

ndstImageback to summary
public static void ndstImage(long struct, long value)

Unsafe version of dstImage.

ndstImageLayoutback to summary
public static int ndstImageLayout(long struct)

Unsafe version of dstImageLayout.

ndstImageLayoutback to summary
public static void ndstImageLayout(long struct, int value)

Unsafe version of dstImageLayout.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

npRegionsback to summary
public static VkImageResolve2.Buffer npRegions(long struct)

Unsafe version of pRegions.

npRegionsback to summary
public static void npRegions(long struct, VkImageResolve2.Buffer value)

Unsafe version of pRegions.

nregionCountback to summary
public static int nregionCount(long struct)

Unsafe version of regionCount.

nregionCountback to summary
public static void nregionCount(long struct, int value)

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

nsrcImageback to summary
public static long nsrcImage(long struct)

Unsafe version of srcImage.

nsrcImageback to summary
public static void nsrcImage(long struct, long value)

Unsafe version of srcImage.

nsrcImageLayoutback to summary
public static int nsrcImageLayout(long struct)

Unsafe version of srcImageLayout.

nsrcImageLayoutback to summary
public static void nsrcImageLayout(long struct, int value)

Unsafe version of srcImageLayout.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkResolveImageInfo2 pNext(long value)

Sets the specified value to the pNext field.

pRegionsback to summary
public VkImageResolve2.Buffer pRegions()

a pointer to an array of VkImageResolve2 structures specifying the regions to resolve.

Annotations
@NativeType:VkImageResolve2 const *
pRegionsback to summary
public VkResolveImageInfo2 pRegions(VkImageResolve2.Buffer value)

Sets the address of the specified VkImageResolve2.Buffer to the pRegions field.

regionCountback to summary
public int regionCount()

the number of regions to resolve.

Annotations
@NativeType:uint32_t
setback to summary
public VkResolveImageInfo2 set(int sType, long pNext, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageResolve2.Buffer pRegions)

Initializes this struct with the specified values.

setback to summary
public VkResolveImageInfo2 set(VkResolveImageInfo2 src)

Copies the specified struct data to this struct.

Parameters
src:VkResolveImageInfo2

the source struct

Returns:VkResolveImageInfo2

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
srcImageback to summary
public long srcImage()

the source image.

Annotations
@NativeType:VkImage
srcImageback to summary
public VkResolveImageInfo2 srcImage(long value)

Sets the specified value to the srcImage field.

srcImageLayoutback to summary
public int srcImageLayout()

the layout of the source image subresources for the resolve.

Annotations
@NativeType:VkImageLayout
srcImageLayoutback to summary
public VkResolveImageInfo2 srcImageLayout(int value)

Sets the specified value to the srcImageLayout field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkResolveImageInfo2 sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkResolveImageInfo2 sType$Default()

Sets the STRUCTURE_TYPE_RESOLVE_IMAGE_INFO_2 value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkResolveImageInfo2.Buffer

extends StructBuffer<VkResolveImageInfo2, VkResolveImageInfo2.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkResolveImageInfo2KHR.Buffer

An array of VkResolveImageInfo2 structs.

Field Summary

Modifier and TypeField and Description
private static final VkResolveImageInfo2

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkResolveImageInfo2.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
public long

Returns:

the value of the VkResolveImageInfo2#dstImage field.
dstImage
()

public VkResolveImageInfo2.Buffer
dstImage(long value)

Sets the specified value to the VkResolveImageInfo2#dstImage field.

public int

Returns:

the value of the VkResolveImageInfo2#dstImageLayout field.
dstImageLayout
()

public VkResolveImageInfo2.Buffer
dstImageLayout(int value)

Sets the specified value to the VkResolveImageInfo2#dstImageLayout field.

protected VkResolveImageInfo2
public long

Returns:

the value of the VkResolveImageInfo2#pNext field.
pNext
()

public VkResolveImageInfo2.Buffer
pNext(long value)

Sets the specified value to the VkResolveImageInfo2#pNext field.

public VkImageResolve2.Buffer

Returns:

a VkImageResolve2.Buffer view of the struct array pointed to by the VkResolveImageInfo2#pRegions field.
pRegions
()

public VkResolveImageInfo2.Buffer
pRegions(VkImageResolve2.Buffer value)

Sets the address of the specified VkImageResolve2.Buffer to the VkResolveImageInfo2#pRegions field.

public int

Returns:

the value of the VkResolveImageInfo2#regionCount field.
regionCount
()

protected VkResolveImageInfo2.Buffer
public long

Returns:

the value of the VkResolveImageInfo2#srcImage field.
srcImage
()

public VkResolveImageInfo2.Buffer
srcImage(long value)

Sets the specified value to the VkResolveImageInfo2#srcImage field.

public int

Returns:

the value of the VkResolveImageInfo2#srcImageLayout field.
srcImageLayout
()

public VkResolveImageInfo2.Buffer
srcImageLayout(int value)

Sets the specified value to the VkResolveImageInfo2#srcImageLayout field.

public int

Returns:

the value of the VkResolveImageInfo2#sType field.
sType
()

public VkResolveImageInfo2.Buffer
sType(int value)

Sets the specified value to the VkResolveImageInfo2#sType field.

public VkResolveImageInfo2.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkResolveImageInfo2 ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkResolveImageInfo2.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 VkResolveImageInfo2#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

dstImageback to summary
public long dstImage()
Returns:long

the value of the VkResolveImageInfo2#dstImage field.

Annotations
@NativeType:VkImage
dstImageback to summary
public VkResolveImageInfo2.Buffer dstImage(long value)

Sets the specified value to the VkResolveImageInfo2#dstImage field.

dstImageLayoutback to summary
public int dstImageLayout()
Returns:int

the value of the VkResolveImageInfo2#dstImageLayout field.

Annotations
@NativeType:VkImageLayout
dstImageLayoutback to summary
public VkResolveImageInfo2.Buffer dstImageLayout(int value)

Sets the specified value to the VkResolveImageInfo2#dstImageLayout field.

getElementFactoryback to summary
protected VkResolveImageInfo2 getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkResolveImageInfo2#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkResolveImageInfo2.Buffer pNext(long value)

Sets the specified value to the VkResolveImageInfo2#pNext field.

pRegionsback to summary
public VkImageResolve2.Buffer pRegions()
Returns:VkImageResolve2.Buffer

a VkImageResolve2.Buffer view of the struct array pointed to by the VkResolveImageInfo2#pRegions field.

Annotations
@NativeType:VkImageResolve2 const *
pRegionsback to summary
public VkResolveImageInfo2.Buffer pRegions(VkImageResolve2.Buffer value)

Sets the address of the specified VkImageResolve2.Buffer to the VkResolveImageInfo2#pRegions field.

regionCountback to summary
public int regionCount()
Returns:int

the value of the VkResolveImageInfo2#regionCount field.

Annotations
@NativeType:uint32_t
selfback to summary
protected VkResolveImageInfo2.Buffer self()

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

Annotations
@Override
srcImageback to summary
public long srcImage()
Returns:long

the value of the VkResolveImageInfo2#srcImage field.

Annotations
@NativeType:VkImage
srcImageback to summary
public VkResolveImageInfo2.Buffer srcImage(long value)

Sets the specified value to the VkResolveImageInfo2#srcImage field.

srcImageLayoutback to summary
public int srcImageLayout()
Returns:int

the value of the VkResolveImageInfo2#srcImageLayout field.

Annotations
@NativeType:VkImageLayout
srcImageLayoutback to summary
public VkResolveImageInfo2.Buffer srcImageLayout(int value)

Sets the specified value to the VkResolveImageInfo2#srcImageLayout field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkResolveImageInfo2#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkResolveImageInfo2.Buffer sType(int value)

Sets the specified value to the VkResolveImageInfo2#sType field.

sType$Defaultback to summary
public VkResolveImageInfo2.Buffer sType$Default()

Sets the STRUCTURE_TYPE_RESOLVE_IMAGE_INFO_2 value to the VkResolveImageInfo2#sType field.