Package org.lwjgl.vulkan

Class VkImageCopy

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageCopy>

org.lwjgl.vulkan.VkImageCopy

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkImageCopy
extends Struct<VkImageCopy>
implements NativeResource

Structure specifying an image copy operation.

Valid Usage

• If the VK_KHR_sampler_ycbcr_conversion extension is not enabled, and VkPhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, the aspectMask member of srcSubresource and dstSubresource must match
• If the VK_KHR_maintenance1 extension is not enabled, and VkPhysicalDeviceProperties::apiVersion is less than Vulkan 1.1, the layerCount member of srcSubresource and dstSubresource must match
• extent.width must not be 0
• extent.height must not be 0
• extent.depth must not be 0

Valid Usage (Implicit)

• srcSubresource must be a valid VkImageSubresourceLayers structure
• dstSubresource must be a valid VkImageSubresourceLayers structure

See Also

VkExtent3D, VkImageSubresourceLayers, VkOffset3D, CmdCopyImage

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageCopy.Buffer	An array of VkImageCopy structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DSTOFFSET	The struct member offsets.
static final int	DSTSUBRESOURCE	The struct member offsets.
static final int	EXTENT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SRCOFFSET	The struct member offsets.
static final int	SRCSUBRESOURCE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageCopy	calloc()	Returns a new VkImageCopy instance allocated with memCalloc.
static VkImageCopy.Buffer	calloc(int capacity)	Returns a new VkImageCopy.Buffer instance allocated with memCalloc.
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.
static VkImageCopy	calloc(MemoryStack stack)	Returns a new VkImageCopy instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageCopy	callocStack()	Deprecated.
static VkImageCopy.Buffer	callocStack(int capacity)	Deprecated.
static VkImageCopy.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageCopy	callocStack(MemoryStack stack)	Deprecated.
static VkImageCopy	create()	Returns a new VkImageCopy instance allocated with BufferUtils.
static VkImageCopy.Buffer	create(int capacity)	Returns a new VkImageCopy.Buffer instance allocated with BufferUtils.
static VkImageCopy	create(long address)	Returns a new VkImageCopy instance for the specified memory address.
static VkImageCopy.Buffer	create(long address, int capacity)	Create a VkImageCopy.Buffer instance at the specified memory.
static VkImageCopy	createSafe(long address)	Like create, but returns null if address is NULL.
static VkImageCopy.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkOffset3D	dstOffset()	see srcOffset
VkImageCopy	dstOffset(Consumer<VkOffset3D> consumer)	Passes the dstOffset() field to the specified Consumer.
VkImageCopy	dstOffset(VkOffset3D value)	Copies the specified VkOffset3D to the dstOffset() field.
VkImageSubresourceLayers	dstSubresource()	see srcSubresource
VkImageCopy	dstSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the dstSubresource() field to the specified Consumer.
VkImageCopy	dstSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the dstSubresource() field.
VkExtent3D	extent()	the size in texels of the image to copy in width, height and depth.
VkImageCopy	extent(Consumer<VkExtent3D> consumer)	Passes the extent() field to the specified Consumer.
VkImageCopy	extent(VkExtent3D value)	Copies the specified VkExtent3D to the extent() field.
static VkImageCopy	malloc()	Returns a new VkImageCopy instance allocated with memAlloc.
static VkImageCopy.Buffer	malloc(int capacity)	Returns a new VkImageCopy.Buffer instance allocated with memAlloc.
static VkImageCopy.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkImageCopy.Buffer instance allocated on the specified MemoryStack.
static VkImageCopy	malloc(MemoryStack stack)	Returns a new VkImageCopy instance allocated on the specified MemoryStack.
static VkImageCopy	mallocStack()	Deprecated.
static VkImageCopy.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageCopy.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageCopy	mallocStack(MemoryStack stack)	Deprecated.
static VkOffset3D	ndstOffset(long struct)	Unsafe version of dstOffset().
static void	ndstOffset(long struct, VkOffset3D value)	Unsafe version of dstOffset.
static VkImageSubresourceLayers	ndstSubresource(long struct)	Unsafe version of dstSubresource().
static void	ndstSubresource(long struct, VkImageSubresourceLayers value)	Unsafe version of dstSubresource.
static VkExtent3D	nextent(long struct)	Unsafe version of extent().
static void	nextent(long struct, VkExtent3D value)	Unsafe version of extent.
static VkOffset3D	nsrcOffset(long struct)	Unsafe version of srcOffset().
static void	nsrcOffset(long struct, VkOffset3D value)	Unsafe version of srcOffset.
static VkImageSubresourceLayers	nsrcSubresource(long struct)	Unsafe version of srcSubresource().
static void	nsrcSubresource(long struct, VkImageSubresourceLayers value)	Unsafe version of srcSubresource.
VkImageCopy	set(VkImageCopy src)	Copies the specified struct data to this struct.
VkImageCopy	set(VkImageSubresourceLayers srcSubresource, VkOffset3D srcOffset, VkImageSubresourceLayers dstSubresource, VkOffset3D dstOffset, VkExtent3D extent)	Initializes this struct with the specified values.
int	sizeof()	Returns sizeof(struct).
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.
VkImageCopy	srcOffset(Consumer<VkOffset3D> consumer)	Passes the srcOffset() field to the specified Consumer.
VkImageCopy	srcOffset(VkOffset3D value)	Copies the specified VkOffset3D to the srcOffset() field.
VkImageSubresourceLayers	srcSubresource()	srcSubresource and dstSubresource are VkImageSubresourceLayers structures specifying the image subresources of the images used for the source and destination image data, respectively.
VkImageCopy	srcSubresource(Consumer<VkImageSubresourceLayers> consumer)	Passes the srcSubresource() field to the specified Consumer.
VkImageCopy	srcSubresource(VkImageSubresourceLayers value)	Copies the specified VkImageSubresourceLayers to the srcSubresource() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

SRCSUBRESOURCE

public static final int SRCSUBRESOURCE

The struct member offsets.

SRCOFFSET

public static final int SRCOFFSET

The struct member offsets.

DSTSUBRESOURCE

public static final int DSTSUBRESOURCE

The struct member offsets.

DSTOFFSET

public static final int DSTOFFSET

The struct member offsets.

EXTENT

public static final int EXTENT

The struct member offsets.

Constructor Details

VkImageCopy

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkImageCopy>

srcSubresource

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.

srcOffset

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.

dstSubresource

public VkImageSubresourceLayers dstSubresource()

see srcSubresource

dstOffset

public VkOffset3D dstOffset()

see srcOffset

extent

public VkExtent3D extent()

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

srcSubresource

public VkImageCopy srcSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the srcSubresource() field.

srcSubresource

public VkImageCopy srcSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the srcSubresource() field to the specified Consumer.

srcOffset

public VkImageCopy srcOffset(VkOffset3D value)

Copies the specified VkOffset3D to the srcOffset() field.

srcOffset

public VkImageCopy srcOffset(Consumer<VkOffset3D> consumer)

Passes the srcOffset() field to the specified Consumer.

dstSubresource

public VkImageCopy dstSubresource(VkImageSubresourceLayers value)

Copies the specified VkImageSubresourceLayers to the dstSubresource() field.

dstSubresource

public VkImageCopy dstSubresource(Consumer<VkImageSubresourceLayers> consumer)

Passes the dstSubresource() field to the specified Consumer.

dstOffset

public VkImageCopy dstOffset(VkOffset3D value)

Copies the specified VkOffset3D to the dstOffset() field.

dstOffset

public VkImageCopy dstOffset(Consumer<VkOffset3D> consumer)

Passes the dstOffset() field to the specified Consumer.

extent

public VkImageCopy extent(VkExtent3D value)

Copies the specified VkExtent3D to the extent() field.

extent

public VkImageCopy extent(Consumer<VkExtent3D> consumer)

Passes the extent() field to the specified Consumer.

set

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

Initializes this struct with the specified values.

set

public VkImageCopy set(VkImageCopy src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageCopy malloc()

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

calloc

public static VkImageCopy calloc()

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

create

public static VkImageCopy create()

Returns a new VkImageCopy instance allocated with BufferUtils.

create

public static VkImageCopy create(long address)

Returns a new VkImageCopy instance for the specified memory address.

createSafe

@Nullable
public static VkImageCopy createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageCopy.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageCopy.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageCopy.Buffer create(int capacity)

Returns a new VkImageCopy.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageCopy.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageCopy mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageCopy callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkImageCopy mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageCopy callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkImageCopy.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageCopy.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkImageCopy malloc(MemoryStack stack)

Returns a new VkImageCopy instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nsrcSubresource

public static VkImageSubresourceLayers nsrcSubresource(long struct)

Unsafe version of srcSubresource().

nsrcOffset

public static VkOffset3D nsrcOffset(long struct)

Unsafe version of srcOffset().

ndstSubresource

public static VkImageSubresourceLayers ndstSubresource(long struct)

Unsafe version of dstSubresource().

ndstOffset

public static VkOffset3D ndstOffset(long struct)

Unsafe version of dstOffset().

nextent

public static VkExtent3D nextent(long struct)

Unsafe version of extent().

nsrcSubresource

public static void nsrcSubresource(long struct,
 VkImageSubresourceLayers value)

Unsafe version of srcSubresource.

nsrcOffset

public static void nsrcOffset(long struct,
 VkOffset3D value)

Unsafe version of srcOffset.

ndstSubresource

public static void ndstSubresource(long struct,
 VkImageSubresourceLayers value)

Unsafe version of dstSubresource.

ndstOffset

public static void ndstOffset(long struct,
 VkOffset3D value)

Unsafe version of dstOffset.

nextent

public static void nextent(long struct,
 VkExtent3D value)

Unsafe version of extent.