Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageCopy

extends Struct<VkImageCopy>
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 an image copy operation.
Valid Usage
Valid Usage (Implicit)
See Also

VkExtent3D, VkImageSubresourceLayers, VkOffset3D, CmdCopyImage

Layout


struct VkImageCopy {
    VkImageSubresourceLayers srcSubresource;
    VkOffset3D srcOffset;
    VkImageSubresourceLayers dstSubresource;
    VkOffset3D dstOffset;
    VkExtent3D extent;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkImageCopy.Buffer

An array of VkImageCopy structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DSTOFFSET

The struct member offsets.

public static final int
DSTSUBRESOURCE

The struct member offsets.

public static final int
EXTENT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SRCOFFSET

The struct member offsets.

public static final int
SRCSUBRESOURCE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkImageCopy(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImageCopy
calloc()

Returns a new VkImageCopy instance allocated with memCalloc.

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

Returns a new VkImageCopy.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkImageCopy
callocStack()

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

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

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

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

Returns a new VkImageCopy instance allocated with BufferUtils.

public static VkImageCopy
create(long address)

Returns a new VkImageCopy instance for the specified memory address.

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

Returns a new VkImageCopy.Buffer instance allocated with BufferUtils.

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

Create a VkImageCopy.Buffer instance at the specified memory.

public static VkImageCopy
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public VkOffset3D
dstOffset()

see srcOffset

public VkImageCopy
dstOffset(VkOffset3D value)

Copies the specified VkOffset3D to the dstOffset field.

public VkImageCopy
dstOffset(Consumer<VkOffset3D> consumer)

Passes the dstOffset field to the specified Consumer.

public VkImageSubresourceLayers
dstSubresource()

see srcSubresource

public VkImageCopy
public VkImageCopy
dstSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the dstSubresource field to the specified Consumer.

public VkExtent3D
extent()

the size in texels of the image to copy in width, height and depth.

public VkImageCopy
extent(VkExtent3D value)

Copies the specified VkExtent3D to the extent field.

public VkImageCopy
extent(Consumer<VkExtent3D> consumer)

Passes the extent field to the specified Consumer.

public static VkImageCopy
malloc()

Returns a new VkImageCopy instance allocated with memAlloc.

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

Returns a new VkImageCopy.Buffer instance allocated with memAlloc.

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

Returns a new VkImageCopy instance allocated on the specified MemoryStack.

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

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

public static VkImageCopy
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static VkOffset3D
ndstOffset(long struct)

Unsafe version of dstOffset.

public static void
ndstOffset(long struct, VkOffset3D value)

Unsafe version of dstOffset.

public static VkImageSubresourceLayers
ndstSubresource(long struct)

Unsafe version of dstSubresource.

public static void
ndstSubresource(long struct, VkImageSubresourceLayers value)

Unsafe version of dstSubresource.

public static VkExtent3D
nextent(long struct)

Unsafe version of extent.

public static void
nextent(long struct, VkExtent3D value)

Unsafe version of extent.

public static VkOffset3D
nsrcOffset(long struct)

Unsafe version of srcOffset.

public static void
nsrcOffset(long struct, VkOffset3D value)

Unsafe version of srcOffset.

public static VkImageSubresourceLayers
nsrcSubresource(long struct)

Unsafe version of srcSubresource.

public static void
nsrcSubresource(long struct, VkImageSubresourceLayers value)

Unsafe version of srcSubresource.

public VkImageCopy
set(VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)

Initializes this struct with the specified values.

public VkImageCopy

Returns:

this struct
set
(VkImageCopy
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 VkOffset3D
srcOffset()

srcOffset and dstOffset select the initial x, y, and z offsets in texels of the sub-regions of the source and destination image data.

public VkImageCopy
srcOffset(VkOffset3D value)

Copies the specified VkOffset3D to the srcOffset field.

public VkImageCopy
srcOffset(Consumer<VkOffset3D> consumer)

Passes the srcOffset field to the specified Consumer.

public VkImageSubresourceLayers
srcSubresource()

srcSubresource and dstSubresource are VkImageSubresourceLayers structures specifying the image subresources of the images used for the source and destination image data, respectively.

public VkImageCopy
public VkImageCopy
srcSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the srcSubresource field to the specified Consumer.

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.

DSTOFFSETback to summary
public static final int DSTOFFSET

The struct member offsets.

DSTSUBRESOURCEback to summary
public static final int DSTSUBRESOURCE

The struct member offsets.

EXTENTback to summary
public static final int EXTENT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SRCOFFSETback to summary
public static final int SRCOFFSET

The struct member offsets.

SRCSUBRESOURCEback to summary
public static final int SRCSUBRESOURCE

The struct member offsets.

Constructor Detail

VkImageCopyback to summary
protected VkImageCopy(long address, ByteBuffer container)
VkImageCopyback to summary
public VkImageCopy(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageCopy calloc(MemoryStack stack)

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

Returns a new VkImageCopy.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 VkImageCopy callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkImageCopy.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 VkImageCopy 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 VkImageCopy create()

Returns a new VkImageCopy instance allocated with BufferUtils.

createback to summary
public static VkImageCopy create(long address)

Returns a new VkImageCopy instance for the specified memory address.

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

Returns a new VkImageCopy.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImageCopy.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageCopy createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
dstOffsetback to summary
public VkOffset3D dstOffset()

see srcOffset

dstOffsetback to summary
public VkImageCopy dstOffset(VkOffset3D value)

Copies the specified VkOffset3D to the dstOffset field.

dstOffsetback to summary
public VkImageCopy dstOffset(Consumer<VkOffset3D> consumer)

Passes the dstOffset field to the specified Consumer.

dstSubresourceback to summary
public VkImageSubresourceLayers dstSubresource()

see srcSubresource

dstSubresourceback to summary
public VkImageCopy dstSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the dstSubresource field.

dstSubresourceback to summary
public VkImageCopy dstSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the dstSubresource field to the specified Consumer.

extentback to summary
public VkExtent3D extent()

the size in texels of the image to copy in width, height and depth.

extentback to summary
public VkImageCopy extent(VkExtent3D value)

Copies the specified VkExtent3D to the extent field.

extentback to summary
public VkImageCopy extent(Consumer<VkExtent3D> consumer)

Passes the extent field to the specified Consumer.

mallocback to summary
public static VkImageCopy malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageCopy malloc(MemoryStack stack)

Returns a new VkImageCopy instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkImageCopy.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 VkImageCopy mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ndstOffsetback to summary
public static VkOffset3D ndstOffset(long struct)

Unsafe version of dstOffset.

ndstOffsetback to summary
public static void ndstOffset(long struct, VkOffset3D value)

Unsafe version of dstOffset.

ndstSubresourceback to summary
public static VkImageSubresourceLayers ndstSubresource(long struct)

Unsafe version of dstSubresource.

ndstSubresourceback to summary
public static void ndstSubresource(long struct, VkImageSubresourceLayers value)

Unsafe version of dstSubresource.

nextentback to summary
public static VkExtent3D nextent(long struct)

Unsafe version of extent.

nextentback to summary
public static void nextent(long struct, VkExtent3D value)

Unsafe version of extent.

nsrcOffsetback to summary
public static VkOffset3D nsrcOffset(long struct)

Unsafe version of srcOffset.

nsrcOffsetback to summary
public static void nsrcOffset(long struct, VkOffset3D value)

Unsafe version of srcOffset.

nsrcSubresourceback to summary
public static VkImageSubresourceLayers nsrcSubresource(long struct)

Unsafe version of srcSubresource.

nsrcSubresourceback to summary
public static void nsrcSubresource(long struct, VkImageSubresourceLayers value)

Unsafe version of srcSubresource.

setback to summary
public VkImageCopy set(VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)

Initializes this struct with the specified values.

setback to summary
public VkImageCopy set(VkImageCopy src)

Copies the specified struct data to this struct.

Parameters
src:VkImageCopy

the source struct

Returns:VkImageCopy

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
srcOffsetback to summary
public VkOffset3D srcOffset()

srcOffset and dstOffset select the initial x, y, and z offsets in texels of the sub-regions of the source and destination image data.

srcOffsetback to summary
public VkImageCopy srcOffset(VkOffset3D value)

Copies the specified VkOffset3D to the srcOffset field.

srcOffsetback to summary
public VkImageCopy srcOffset(Consumer<VkOffset3D> consumer)

Passes the srcOffset field to the specified Consumer.

srcSubresourceback to summary
public VkImageSubresourceLayers srcSubresource()

srcSubresource and dstSubresource are VkImageSubresourceLayers structures specifying the image subresources of the images used for the source and destination image data, respectively.

srcSubresourceback to summary
public VkImageCopy srcSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the srcSubresource field.

srcSubresourceback to summary
public VkImageCopy srcSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the srcSubresource field to the specified Consumer.

org.lwjgl.vulkan back to summary

public Class VkImageCopy.Buffer

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

An array of VkImageCopy structs.

Field Summary

Modifier and TypeField and Description
private static final VkImageCopy

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImageCopy.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 VkOffset3D

Returns:

a VkOffset3D view of the VkImageCopy#dstOffset field.
dstOffset
()

public VkImageCopy.Buffer
dstOffset(VkOffset3D value)

Copies the specified VkOffset3D to the VkImageCopy#dstOffset field.

public VkImageCopy.Buffer
dstOffset(Consumer<VkOffset3D> consumer)

Passes the VkImageCopy#dstOffset field to the specified Consumer.

public VkImageSubresourceLayers
public VkImageCopy.Buffer
public VkImageCopy.Buffer
public VkExtent3D

Returns:

a VkExtent3D view of the VkImageCopy#extent field.
extent
()

public VkImageCopy.Buffer
extent(VkExtent3D value)

Copies the specified VkExtent3D to the VkImageCopy#extent field.

public VkImageCopy.Buffer
extent(Consumer<VkExtent3D> consumer)

Passes the VkImageCopy#extent field to the specified Consumer.

protected VkImageCopy
protected VkImageCopy.Buffer
public VkOffset3D

Returns:

a VkOffset3D view of the VkImageCopy#srcOffset field.
srcOffset
()

public VkImageCopy.Buffer
srcOffset(VkOffset3D value)

Copies the specified VkOffset3D to the VkImageCopy#srcOffset field.

public VkImageCopy.Buffer
srcOffset(Consumer<VkOffset3D> consumer)

Passes the VkImageCopy#srcOffset field to the specified Consumer.

public VkImageSubresourceLayers
public VkImageCopy.Buffer
public VkImageCopy.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageCopy ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

dstOffsetback to summary
public VkOffset3D dstOffset()
Returns:VkOffset3D

a VkOffset3D view of the VkImageCopy#dstOffset field.

dstOffsetback to summary
public VkImageCopy.Buffer dstOffset(VkOffset3D value)

Copies the specified VkOffset3D to the VkImageCopy#dstOffset field.

dstOffsetback to summary
public VkImageCopy.Buffer dstOffset(Consumer<VkOffset3D> consumer)

Passes the VkImageCopy#dstOffset field to the specified Consumer.

dstSubresourceback to summary
public VkImageSubresourceLayers dstSubresource()
Returns:VkImageSubresourceLayers

a VkImageSubresourceLayers view of the VkImageCopy#dstSubresource field.

dstSubresourceback to summary
public VkImageCopy.Buffer dstSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the VkImageCopy#dstSubresource field.

dstSubresourceback to summary
public VkImageCopy.Buffer dstSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the VkImageCopy#dstSubresource field to the specified Consumer.

extentback to summary
public VkExtent3D extent()
Returns:VkExtent3D

a VkExtent3D view of the VkImageCopy#extent field.

extentback to summary
public VkImageCopy.Buffer extent(VkExtent3D value)

Copies the specified VkExtent3D to the VkImageCopy#extent field.

extentback to summary
public VkImageCopy.Buffer extent(Consumer<VkExtent3D> consumer)

Passes the VkImageCopy#extent field to the specified Consumer.

getElementFactoryback to summary
protected VkImageCopy getElementFactory()

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

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

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

Annotations
@Override
srcOffsetback to summary
public VkOffset3D srcOffset()
Returns:VkOffset3D

a VkOffset3D view of the VkImageCopy#srcOffset field.

srcOffsetback to summary
public VkImageCopy.Buffer srcOffset(VkOffset3D value)

Copies the specified VkOffset3D to the VkImageCopy#srcOffset field.

srcOffsetback to summary
public VkImageCopy.Buffer srcOffset(Consumer<VkOffset3D> consumer)

Passes the VkImageCopy#srcOffset field to the specified Consumer.

srcSubresourceback to summary
public VkImageSubresourceLayers srcSubresource()
Returns:VkImageSubresourceLayers

a VkImageSubresourceLayers view of the VkImageCopy#srcSubresource field.

srcSubresourceback to summary
public VkImageCopy.Buffer srcSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the VkImageCopy#srcSubresource field.

srcSubresourceback to summary
public VkImageCopy.Buffer srcSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the VkImageCopy#srcSubresource field to the specified Consumer.