Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkCopyImageToBufferInfo2KHR

extends VkCopyImageToBufferInfo2
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
See VkCopyImageToBufferInfo2.

Layout


struct VkCopyImageToBufferInfo2KHR {
    VkStructureType sType;
    void const * pNext;
    VkImage srcImage;
    VkImageLayout srcImageLayout;
    VkBuffer dstBuffer;
    uint32_t regionCount;
    VkBufferImageCopy2 const * pRegions;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkCopyImageToBufferInfo2KHR.Buffer

An array of VkCopyImageToBufferInfo2KHR structs.

Field Summary

Inherited from org.lwjgl.vulkan.VkCopyImageToBufferInfo2:
ALIGNOFDSTBUFFERPNEXTPREGIONSREGIONCOUNTSIZEOFSRCIMAGESRCIMAGELAYOUTSTYPE

Constructor Summary

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

public
VkCopyImageToBufferInfo2KHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkCopyImageToBufferInfo2KHR
calloc()

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.calloc.

Returns a new VkCopyImageToBufferInfo2KHR instance allocated with memCalloc.
public static VkCopyImageToBufferInfo2KHR.Buffer
calloc(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.calloc.

Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated with memCalloc.
public static VkCopyImageToBufferInfo2KHR
calloc(MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.calloc.

Returns a new VkCopyImageToBufferInfo2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
public static VkCopyImageToBufferInfo2KHR.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.calloc.

Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
protected VkCopyImageToBufferInfo2KHR
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkCopyImageToBufferInfo2KHR
create()

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.create.

Returns a new VkCopyImageToBufferInfo2KHR instance allocated with BufferUtils.
public static VkCopyImageToBufferInfo2KHR
create(long address)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.create.

Returns a new VkCopyImageToBufferInfo2KHR instance for the specified memory address.
public static VkCopyImageToBufferInfo2KHR.Buffer
create(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.create.

Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated with BufferUtils.
public static VkCopyImageToBufferInfo2KHR.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.create.

Create a VkCopyImageToBufferInfo2KHR.Buffer instance at the specified memory.
public static VkCopyImageToBufferInfo2KHR
createSafe(long address)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.createSafe.

Like create, but returns null if address is NULL.
public static VkCopyImageToBufferInfo2KHR.Buffer
createSafe(long address, int capacity)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.createSafe.

Like create, but returns null if address is NULL.
public VkCopyImageToBufferInfo2KHR
dstBuffer(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.dstBuffer.

Sets the specified value to the dstBuffer field.
public static VkCopyImageToBufferInfo2KHR
malloc()

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.malloc.

Returns a new VkCopyImageToBufferInfo2KHR instance allocated with memAlloc.
public static VkCopyImageToBufferInfo2KHR.Buffer
malloc(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.malloc.

Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated with memAlloc.
public static VkCopyImageToBufferInfo2KHR
malloc(MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.malloc.

Returns a new VkCopyImageToBufferInfo2KHR instance allocated on the specified MemoryStack.
public static VkCopyImageToBufferInfo2KHR.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.malloc.

Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated on the specified MemoryStack.
public VkCopyImageToBufferInfo2KHR
pNext(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.pNext.

Sets the specified value to the pNext field.
public VkCopyImageToBufferInfo2KHR
pRegions(VkBufferImageCopy2.Buffer value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.pRegions.

Sets the address of the specified VkBufferImageCopy2.Buffer to the pRegions field.
public VkCopyImageToBufferInfo2KHR
set(int sType, long pNext, long srcImage, int srcImageLayout, long dstBuffer, VkBufferImageCopy2.Buffer pRegions)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.set.

Initializes this struct with the specified values.
public VkCopyImageToBufferInfo2KHR

Returns:

this struct
set(VkCopyImageToBufferInfo2KHR
the source struct
src)

Copies the specified struct data to this struct.

public VkCopyImageToBufferInfo2KHR
srcImage(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.srcImage.

Sets the specified value to the srcImage field.
public VkCopyImageToBufferInfo2KHR
srcImageLayout(int value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.srcImageLayout.

Sets the specified value to the srcImageLayout field.
public VkCopyImageToBufferInfo2KHR
sType(int value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.sType.

Sets the specified value to the sType field.
public VkCopyImageToBufferInfo2KHR
sType$Default()

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.sType$Default.

Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2 value to the sType field.
Inherited from org.lwjgl.vulkan.VkCopyImageToBufferInfo2:
dstBufferndstBufferndstBuffernpNextnpNextnpRegionsnpRegionsnregionCountnregionCountnsrcImagensrcImagensrcImageLayoutnsrcImageLayoutnsTypensTypepNextpRegionsregionCountsetsizeofsrcImagesrcImageLayoutsTypevalidate

Constructor Detail

VkCopyImageToBufferInfo2KHRback to summary
protected VkCopyImageToBufferInfo2KHR(long address, ByteBuffer container)
VkCopyImageToBufferInfo2KHRback to summary
public VkCopyImageToBufferInfo2KHR(ByteBuffer container)

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

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.calloc.

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

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

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.calloc.

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkCopyImageToBufferInfo2KHR calloc(MemoryStack stack)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.calloc.

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

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.calloc.

Returns a new VkCopyImageToBufferInfo2KHR.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 VkCopyImageToBufferInfo2KHR create(long address, ByteBuffer container)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.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 VkCopyImageToBufferInfo2KHR create()

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.create.

Returns a new VkCopyImageToBufferInfo2KHR instance allocated with BufferUtils.

createback to summary
public static VkCopyImageToBufferInfo2KHR create(long address)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.create.

Returns a new VkCopyImageToBufferInfo2KHR instance for the specified memory address.

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

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.create.

Returns a new VkCopyImageToBufferInfo2KHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.create.

Create a VkCopyImageToBufferInfo2KHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkCopyImageToBufferInfo2KHR createSafe(long address)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.createSafe.

Like create, but returns null if address is NULL.

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

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.createSafe.

Like create, but returns null if address is NULL.

Annotations
@Nullable
dstBufferback to summary
public VkCopyImageToBufferInfo2KHR dstBuffer(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.dstBuffer.

Sets the specified value to the dstBuffer field.

Annotations
@Override
mallocback to summary
public static VkCopyImageToBufferInfo2KHR malloc()

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.malloc.

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

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

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.malloc.

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkCopyImageToBufferInfo2KHR malloc(MemoryStack stack)

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.malloc.

Returns a new VkCopyImageToBufferInfo2KHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.malloc.

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

pNextback to summary
public VkCopyImageToBufferInfo2KHR pNext(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.pNext.

Sets the specified value to the pNext field.

Annotations
@Override
pRegionsback to summary
public VkCopyImageToBufferInfo2KHR pRegions(VkBufferImageCopy2.Buffer value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.pRegions.

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

Annotations
@Override
setback to summary
public VkCopyImageToBufferInfo2KHR set(int sType, long pNext, long srcImage, int srcImageLayout, long dstBuffer, VkBufferImageCopy2.Buffer pRegions)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.set.

Initializes this struct with the specified values.

Annotations
@Override
setback to summary
public VkCopyImageToBufferInfo2KHR set(VkCopyImageToBufferInfo2KHR src)

Copies the specified struct data to this struct.

Parameters
src:VkCopyImageToBufferInfo2KHR

the source struct

Returns:VkCopyImageToBufferInfo2KHR

this struct

srcImageback to summary
public VkCopyImageToBufferInfo2KHR srcImage(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.srcImage.

Sets the specified value to the srcImage field.

Annotations
@Override
srcImageLayoutback to summary
public VkCopyImageToBufferInfo2KHR srcImageLayout(int value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.srcImageLayout.

Sets the specified value to the srcImageLayout field.

Annotations
@Override
sTypeback to summary
public VkCopyImageToBufferInfo2KHR sType(int value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.sType.

Sets the specified value to the sType field.

Annotations
@Override
sType$Defaultback to summary
public VkCopyImageToBufferInfo2KHR sType$Default()

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.sType$Default.

Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2 value to the sType field.

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkCopyImageToBufferInfo2KHR.Buffer

extends Buffer
Class Inheritance
An array of VkCopyImageToBufferInfo2KHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkCopyImageToBufferInfo2KHR
ELEMENT_FACTORY

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.ELEMENT_FACTORY.

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkCopyImageToBufferInfo2KHR.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 VkCopyImageToBufferInfo2KHR.Buffer
dstBuffer(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.dstBuffer.

Sets the specified value to the dstBuffer field.
protected VkCopyImageToBufferInfo2KHR
getElementFactory()

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.getElementFactory.

public VkCopyImageToBufferInfo2KHR.Buffer
pNext(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.pNext.

Sets the specified value to the pNext field.
public VkCopyImageToBufferInfo2KHR.Buffer
pRegions(VkBufferImageCopy2.Buffer value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.pRegions.

Sets the address of the specified VkBufferImageCopy2.Buffer to the pRegions field.
protected VkCopyImageToBufferInfo2KHR.Buffer
self()

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.self.

public VkCopyImageToBufferInfo2KHR.Buffer
srcImage(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.srcImage.

Sets the specified value to the srcImage field.
public VkCopyImageToBufferInfo2KHR.Buffer
srcImageLayout(int value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.srcImageLayout.

Sets the specified value to the srcImageLayout field.
public VkCopyImageToBufferInfo2KHR.Buffer
sType(int value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.sType.

Sets the specified value to the sType field.
public VkCopyImageToBufferInfo2KHR.Buffer
sType$Default()

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.sType$Default.

Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2 value to the sType field.
Inherited from org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer:
dstBufferpNextpRegionsregionCountsrcImagesrcImageLayoutsType

Field Detail

ELEMENT_FACTORYback to summary
private static final VkCopyImageToBufferInfo2KHR ELEMENT_FACTORY

Hides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.ELEMENT_FACTORY.

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

dstBufferback to summary
public VkCopyImageToBufferInfo2KHR.Buffer dstBuffer(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.dstBuffer.

Sets the specified value to the dstBuffer field.

Annotations
@Override
getElementFactoryback to summary
protected VkCopyImageToBufferInfo2KHR getElementFactory()

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.getElementFactory.

Annotations
@Override
pNextback to summary
public VkCopyImageToBufferInfo2KHR.Buffer pNext(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.pNext.

Sets the specified value to the pNext field.

Annotations
@Override
pRegionsback to summary
public VkCopyImageToBufferInfo2KHR.Buffer pRegions(VkBufferImageCopy2.Buffer value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.pRegions.

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

Annotations
@Override
selfback to summary
protected VkCopyImageToBufferInfo2KHR.Buffer self()

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.self.

Annotations
@Override
srcImageback to summary
public VkCopyImageToBufferInfo2KHR.Buffer srcImage(long value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.srcImage.

Sets the specified value to the srcImage field.

Annotations
@Override
srcImageLayoutback to summary
public VkCopyImageToBufferInfo2KHR.Buffer srcImageLayout(int value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.srcImageLayout.

Sets the specified value to the srcImageLayout field.

Annotations
@Override
sTypeback to summary
public VkCopyImageToBufferInfo2KHR.Buffer sType(int value)

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.sType.

Sets the specified value to the sType field.

Annotations
@Override
sType$Defaultback to summary
public VkCopyImageToBufferInfo2KHR.Buffer sType$Default()

Overrides org.lwjgl.vulkan.VkCopyImageToBufferInfo2.Buffer.sType$Default.

Sets the STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_2 value to the sType field.

Annotations
@Override