org.lwjgl.vulkan.VkImageCopy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying an image copy operation.
*
* Description
*
* For {@link VK10#VK_IMAGE_TYPE_3D IMAGE_TYPE_3D} images, copies are performed slice by slice starting with the {@code z} member of the {@code srcOffset} or {@code dstOffset}, and copying {@code depth} slices. For images with multiple layers, copies are performed layer by layer starting with the {@code baseArrayLayer} member of the {@code srcSubresource} or {@code dstSubresource} and copying {@code layerCount} layers. Image data can be copied between images with different image types. If one image is {@link VK10#VK_IMAGE_TYPE_3D IMAGE_TYPE_3D} and the other image is {@link VK10#VK_IMAGE_TYPE_2D IMAGE_TYPE_2D} with multiple layers, then each slice is copied to or from a different layer.
*
* Copies involving a multi-planar image format specify the region to be copied in terms of the plane to be copied, not the coordinates of the multi-planar image. This means that copies accessing the R/B planes of “{@code _422}” format images must fit the copied region within half the {@code width} of the parent image, and that copies accessing the R/B planes of “{@code _420}” format images must fit the copied region within half the {@code width} and {@code height} of the parent image.
*
* Valid Usage
*
*
* - The number of slices of the {@code extent} (for 3D) or layers of the {@code srcSubresource} (for non-3D) must match the number of slices of the {@code extent} (for 3D) or layers of the {@code dstSubresource} (for non-3D)
*
*
* Valid Usage (Implicit)
*
*
* - {@code srcSubresource} must be a valid {@link VkImageSubresourceLayers} structure
* - {@code dstSubresource} must be a valid {@link VkImageSubresourceLayers} structure
*
*
* See Also
*
* {@link VkExtent3D}, {@link VkImageSubresourceLayers}, {@link VkOffset3D}, {@link VK10#vkCmdCopyImage CmdCopyImage}
*
* Layout
*
*
* struct VkImageCopy {
* {@link VkImageSubresourceLayers VkImageSubresourceLayers} {@link #srcSubresource};
* {@link VkOffset3D VkOffset3D} {@link #srcOffset};
* {@link VkImageSubresourceLayers VkImageSubresourceLayers} {@link #dstSubresource};
* {@link VkOffset3D VkOffset3D} {@link #dstOffset};
* {@link VkExtent3D VkExtent3D} {@link #extent};
* }
*/
public class VkImageCopy extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
SRCSUBRESOURCE,
SRCOFFSET,
DSTSUBRESOURCE,
DSTOFFSET,
EXTENT;
static {
Layout layout = __struct(
__member(VkImageSubresourceLayers.SIZEOF, VkImageSubresourceLayers.ALIGNOF),
__member(VkOffset3D.SIZEOF, VkOffset3D.ALIGNOF),
__member(VkImageSubresourceLayers.SIZEOF, VkImageSubresourceLayers.ALIGNOF),
__member(VkOffset3D.SIZEOF, VkOffset3D.ALIGNOF),
__member(VkExtent3D.SIZEOF, VkExtent3D.ALIGNOF)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
SRCSUBRESOURCE = layout.offsetof(0);
SRCOFFSET = layout.offsetof(1);
DSTSUBRESOURCE = layout.offsetof(2);
DSTOFFSET = layout.offsetof(3);
EXTENT = layout.offsetof(4);
}
/**
* Creates a {@code VkImageCopy} instance at the current position of the specified {@link 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.
*/
public VkImageCopy(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** {@code srcSubresource} and {@code dstSubresource} are {@link VkImageSubresourceLayers} structures specifying the image subresources of the images used for the source and destination image data, respectively. */
public VkImageSubresourceLayers srcSubresource() { return nsrcSubresource(address()); }
/** {@code srcOffset} and {@code dstOffset} select the initial {@code x}, {@code y}, and {@code z} offsets in texels of the sub-regions of the source and destination image data. */
public VkOffset3D srcOffset() { return nsrcOffset(address()); }
/** see {@code srcSubresource} */
public VkImageSubresourceLayers dstSubresource() { return ndstSubresource(address()); }
/** see {@code srcOffset} */
public VkOffset3D dstOffset() { return ndstOffset(address()); }
/** the size in texels of the image to copy in {@code width}, {@code height} and {@code depth}. */
public VkExtent3D extent() { return nextent(address()); }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@link #srcSubresource} field. */
public VkImageCopy srcSubresource(VkImageSubresourceLayers value) { nsrcSubresource(address(), value); return this; }
/** Passes the {@link #srcSubresource} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageCopy srcSubresource(java.util.function.Consumer consumer) { consumer.accept(srcSubresource()); return this; }
/** Copies the specified {@link VkOffset3D} to the {@link #srcOffset} field. */
public VkImageCopy srcOffset(VkOffset3D value) { nsrcOffset(address(), value); return this; }
/** Passes the {@link #srcOffset} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageCopy srcOffset(java.util.function.Consumer consumer) { consumer.accept(srcOffset()); return this; }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@link #dstSubresource} field. */
public VkImageCopy dstSubresource(VkImageSubresourceLayers value) { ndstSubresource(address(), value); return this; }
/** Passes the {@link #dstSubresource} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageCopy dstSubresource(java.util.function.Consumer consumer) { consumer.accept(dstSubresource()); return this; }
/** Copies the specified {@link VkOffset3D} to the {@link #dstOffset} field. */
public VkImageCopy dstOffset(VkOffset3D value) { ndstOffset(address(), value); return this; }
/** Passes the {@link #dstOffset} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageCopy dstOffset(java.util.function.Consumer consumer) { consumer.accept(dstOffset()); return this; }
/** Copies the specified {@link VkExtent3D} to the {@link #extent} field. */
public VkImageCopy extent(VkExtent3D value) { nextent(address(), value); return this; }
/** Passes the {@link #extent} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageCopy extent(java.util.function.Consumer consumer) { consumer.accept(extent()); return this; }
/** Initializes this struct with the specified values. */
public VkImageCopy set(
VkImageSubresourceLayers srcSubresource,
VkOffset3D srcOffset,
VkImageSubresourceLayers dstSubresource,
VkOffset3D dstOffset,
VkExtent3D extent
) {
srcSubresource(srcSubresource);
srcOffset(srcOffset);
dstSubresource(dstSubresource);
dstOffset(dstOffset);
extent(extent);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkImageCopy set(VkImageCopy src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkImageCopy} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkImageCopy malloc() {
return wrap(VkImageCopy.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkImageCopy} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkImageCopy calloc() {
return wrap(VkImageCopy.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkImageCopy} instance allocated with {@link BufferUtils}. */
public static VkImageCopy create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkImageCopy.class, memAddress(container), container);
}
/** Returns a new {@code VkImageCopy} instance for the specified memory address. */
public static VkImageCopy create(long address) {
return wrap(VkImageCopy.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkImageCopy createSafe(long address) {
return address == NULL ? null : wrap(VkImageCopy.class, address);
}
/**
* Returns a new {@link VkImageCopy.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkImageCopy.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkImageCopy.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkImageCopy.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkImageCopy.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkImageCopy.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkImageCopy.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkImageCopy.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkImageCopy.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkImageCopy mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkImageCopy callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkImageCopy mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkImageCopy callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkImageCopy.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkImageCopy.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkImageCopy.Buffer mallocStack(int capacity, MemoryStack stack) { return malloc(capacity, stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkImageCopy.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code VkImageCopy} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkImageCopy malloc(MemoryStack stack) {
return wrap(VkImageCopy.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkImageCopy} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkImageCopy calloc(MemoryStack stack) {
return wrap(VkImageCopy.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkImageCopy.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkImageCopy.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkImageCopy.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkImageCopy.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #srcSubresource}. */
public static VkImageSubresourceLayers nsrcSubresource(long struct) { return VkImageSubresourceLayers.create(struct + VkImageCopy.SRCSUBRESOURCE); }
/** Unsafe version of {@link #srcOffset}. */
public static VkOffset3D nsrcOffset(long struct) { return VkOffset3D.create(struct + VkImageCopy.SRCOFFSET); }
/** Unsafe version of {@link #dstSubresource}. */
public static VkImageSubresourceLayers ndstSubresource(long struct) { return VkImageSubresourceLayers.create(struct + VkImageCopy.DSTSUBRESOURCE); }
/** Unsafe version of {@link #dstOffset}. */
public static VkOffset3D ndstOffset(long struct) { return VkOffset3D.create(struct + VkImageCopy.DSTOFFSET); }
/** Unsafe version of {@link #extent}. */
public static VkExtent3D nextent(long struct) { return VkExtent3D.create(struct + VkImageCopy.EXTENT); }
/** Unsafe version of {@link #srcSubresource(VkImageSubresourceLayers) srcSubresource}. */
public static void nsrcSubresource(long struct, VkImageSubresourceLayers value) { memCopy(value.address(), struct + VkImageCopy.SRCSUBRESOURCE, VkImageSubresourceLayers.SIZEOF); }
/** Unsafe version of {@link #srcOffset(VkOffset3D) srcOffset}. */
public static void nsrcOffset(long struct, VkOffset3D value) { memCopy(value.address(), struct + VkImageCopy.SRCOFFSET, VkOffset3D.SIZEOF); }
/** Unsafe version of {@link #dstSubresource(VkImageSubresourceLayers) dstSubresource}. */
public static void ndstSubresource(long struct, VkImageSubresourceLayers value) { memCopy(value.address(), struct + VkImageCopy.DSTSUBRESOURCE, VkImageSubresourceLayers.SIZEOF); }
/** Unsafe version of {@link #dstOffset(VkOffset3D) dstOffset}. */
public static void ndstOffset(long struct, VkOffset3D value) { memCopy(value.address(), struct + VkImageCopy.DSTOFFSET, VkOffset3D.SIZEOF); }
/** Unsafe version of {@link #extent(VkExtent3D) extent}. */
public static void nextent(long struct, VkExtent3D value) { memCopy(value.address(), struct + VkImageCopy.EXTENT, VkExtent3D.SIZEOF); }
// -----------------------------------
/** An array of {@link VkImageCopy} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkImageCopy ELEMENT_FACTORY = VkImageCopy.create(-1L);
/**
* Creates a new {@code 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 {@link VkImageCopy#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected VkImageCopy getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return a {@link VkImageSubresourceLayers} view of the {@link VkImageCopy#srcSubresource} field. */
public VkImageSubresourceLayers srcSubresource() { return VkImageCopy.nsrcSubresource(address()); }
/** @return a {@link VkOffset3D} view of the {@link VkImageCopy#srcOffset} field. */
public VkOffset3D srcOffset() { return VkImageCopy.nsrcOffset(address()); }
/** @return a {@link VkImageSubresourceLayers} view of the {@link VkImageCopy#dstSubresource} field. */
public VkImageSubresourceLayers dstSubresource() { return VkImageCopy.ndstSubresource(address()); }
/** @return a {@link VkOffset3D} view of the {@link VkImageCopy#dstOffset} field. */
public VkOffset3D dstOffset() { return VkImageCopy.ndstOffset(address()); }
/** @return a {@link VkExtent3D} view of the {@link VkImageCopy#extent} field. */
public VkExtent3D extent() { return VkImageCopy.nextent(address()); }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@link VkImageCopy#srcSubresource} field. */
public VkImageCopy.Buffer srcSubresource(VkImageSubresourceLayers value) { VkImageCopy.nsrcSubresource(address(), value); return this; }
/** Passes the {@link VkImageCopy#srcSubresource} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageCopy.Buffer srcSubresource(java.util.function.Consumer consumer) { consumer.accept(srcSubresource()); return this; }
/** Copies the specified {@link VkOffset3D} to the {@link VkImageCopy#srcOffset} field. */
public VkImageCopy.Buffer srcOffset(VkOffset3D value) { VkImageCopy.nsrcOffset(address(), value); return this; }
/** Passes the {@link VkImageCopy#srcOffset} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageCopy.Buffer srcOffset(java.util.function.Consumer consumer) { consumer.accept(srcOffset()); return this; }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@link VkImageCopy#dstSubresource} field. */
public VkImageCopy.Buffer dstSubresource(VkImageSubresourceLayers value) { VkImageCopy.ndstSubresource(address(), value); return this; }
/** Passes the {@link VkImageCopy#dstSubresource} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageCopy.Buffer dstSubresource(java.util.function.Consumer consumer) { consumer.accept(dstSubresource()); return this; }
/** Copies the specified {@link VkOffset3D} to the {@link VkImageCopy#dstOffset} field. */
public VkImageCopy.Buffer dstOffset(VkOffset3D value) { VkImageCopy.ndstOffset(address(), value); return this; }
/** Passes the {@link VkImageCopy#dstOffset} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageCopy.Buffer dstOffset(java.util.function.Consumer consumer) { consumer.accept(dstOffset()); return this; }
/** Copies the specified {@link VkExtent3D} to the {@link VkImageCopy#extent} field. */
public VkImageCopy.Buffer extent(VkExtent3D value) { VkImageCopy.nextent(address(), value); return this; }
/** Passes the {@link VkImageCopy#extent} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageCopy.Buffer extent(java.util.function.Consumer consumer) { consumer.accept(extent()); return this; }
}
}