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 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 etext:_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 etext:_420}" format images must fit the copied region within half the {@code width} and {@code height} of the parent image.
*
* Valid Usage
*
*
* - If neither the calling command’s {@code srcImage} nor the calling command’s {@code dstImage} has a multi-planar image format then the {@code aspectMask} member of {@code srcSubresource} and {@code dstSubresource} must match
* - If the calling command’s {@code srcImage} has a {@code VkFormat} with two planes then the {@code srcSubresource} {@code aspectMask} must be {@link KHRSamplerYcbcrConversion#VK_IMAGE_ASPECT_PLANE_0_BIT_KHR IMAGE_ASPECT_PLANE_0_BIT_KHR} or {@link KHRSamplerYcbcrConversion#VK_IMAGE_ASPECT_PLANE_1_BIT_KHR IMAGE_ASPECT_PLANE_1_BIT_KHR}
* - If the calling command’s {@code srcImage} has a {@code VkFormat} with three planes then the {@code srcSubresource} {@code aspectMask} must be {@link KHRSamplerYcbcrConversion#VK_IMAGE_ASPECT_PLANE_0_BIT_KHR IMAGE_ASPECT_PLANE_0_BIT_KHR}, {@link KHRSamplerYcbcrConversion#VK_IMAGE_ASPECT_PLANE_1_BIT_KHR IMAGE_ASPECT_PLANE_1_BIT_KHR}, or {@link KHRSamplerYcbcrConversion#VK_IMAGE_ASPECT_PLANE_2_BIT_KHR IMAGE_ASPECT_PLANE_2_BIT_KHR}
* - If the calling command’s {@code dstImage} has a {@code VkFormat} with two planes then the {@code dstSubresource} {@code aspectMask} must be {@link KHRSamplerYcbcrConversion#VK_IMAGE_ASPECT_PLANE_0_BIT_KHR IMAGE_ASPECT_PLANE_0_BIT_KHR} or {@link KHRSamplerYcbcrConversion#VK_IMAGE_ASPECT_PLANE_1_BIT_KHR IMAGE_ASPECT_PLANE_1_BIT_KHR}
* - If the calling command’s {@code dstImage} has a {@code VkFormat} with three planes then the {@code dstSubresource} {@code aspectMask} must be {@link KHRSamplerYcbcrConversion#VK_IMAGE_ASPECT_PLANE_0_BIT_KHR IMAGE_ASPECT_PLANE_0_BIT_KHR}, {@link KHRSamplerYcbcrConversion#VK_IMAGE_ASPECT_PLANE_1_BIT_KHR IMAGE_ASPECT_PLANE_1_BIT_KHR}, or {@link KHRSamplerYcbcrConversion#VK_IMAGE_ASPECT_PLANE_2_BIT_KHR IMAGE_ASPECT_PLANE_2_BIT_KHR}
* - If the calling command’s {@code srcImage} has a multi-planar image format and the {@code dstImage} does not have a multi-planar image format, the {@code dstSubresource} {@code aspectMask} must be {@link VK10#VK_IMAGE_ASPECT_COLOR_BIT IMAGE_ASPECT_COLOR_BIT}
* - If the calling command’s {@code dstImage} has a multi-planar image format and the {@code srcImage} does not have a multi-planar image format, the {@code srcSubresource} {@code aspectMask} must be {@link VK10#VK_IMAGE_ASPECT_COLOR_BIT IMAGE_ASPECT_COLOR_BIT}
* - 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)
* - If either of the calling command’s {@code srcImage} or {@code dstImage} parameters are of {@code VkImageType} {@link VK10#VK_IMAGE_TYPE_3D IMAGE_TYPE_3D}, the {@code baseArrayLayer} and {@code layerCount} members of the corresponding subresource must be 0 and 1, respectively
* - The {@code aspectMask} member of {@code srcSubresource} must specify aspects present in the calling command’s {@code srcImage}
* - The {@code aspectMask} member of {@code dstSubresource} must specify aspects present in the calling command’s {@code dstImage}
* - {@code srcOffset.x} and
(extent.width srcOffset.x) must both be greater than or equal to 0 and less than or equal to the source image subresource width
* - {@code srcOffset.y} and
(extent.height srcOffset.y) must both be greater than or equal to 0 and less than or equal to the source image subresource height
* - If the calling command’s {@code srcImage} is of type {@link VK10#VK_IMAGE_TYPE_1D IMAGE_TYPE_1D}, then {@code srcOffset.y} must be 0 and {@code extent.height} must be 1.
* - {@code srcOffset.z} and
(extent.depth srcOffset.z) must both be greater than or equal to 0 and less than or equal to the source image subresource depth
* - If the calling command’s {@code srcImage} is of type {@link VK10#VK_IMAGE_TYPE_1D IMAGE_TYPE_1D} or {@link VK10#VK_IMAGE_TYPE_2D IMAGE_TYPE_2D}, then {@code srcOffset.z} must be 0 and {@code extent.depth} must be 1.
* - {@code srcSubresource.baseArrayLayer} must be less than and
(srcSubresource.layerCount srcSubresource.baseArrayLayer) must be less than or equal to the number of layers in the source image
* - {@code dstOffset.x} and
(extent.width dstOffset.x) must both be greater than or equal to 0 and less than or equal to the destination image subresource width
* - {@code dstOffset.y} and
(extent.height dstOffset.y) must both be greater than or equal to 0 and less than or equal to the destination image subresource height
* - If the calling command’s {@code dstImage} is of type {@link VK10#VK_IMAGE_TYPE_1D IMAGE_TYPE_1D}, then {@code dstOffset.y} must be 0 and {@code extent.height} must be 1.
* - {@code dstOffset.z} and
(extent.depth dstOffset.z) must both be greater than or equal to 0 and less than or equal to the destination image subresource depth
* - If the calling command’s {@code dstImage} is of type {@link VK10#VK_IMAGE_TYPE_1D IMAGE_TYPE_1D} or {@link VK10#VK_IMAGE_TYPE_2D IMAGE_TYPE_2D}, then {@code dstOffset.z} must be 0 and {@code extent.depth} must be 1.
* - {@code dstSubresource.baseArrayLayer} must be less than and
(dstSubresource.layerCount dstSubresource.baseArrayLayer) must be less than or equal to the number of layers in the destination image
* - If the calling command’s {@code srcImage} is a compressed image, or a single-plane, “etext:_422” image format, all members of {@code srcOffset} must be a multiple of the corresponding dimensions of the compressed texel block
* - If the calling command’s {@code srcImage} is a compressed image, or a single-plane, “etext:_422” image format, {@code extent.width} must be a multiple of the compressed texel block width or
(extent.width + srcOffset.x) must equal the source image subresource width
* - If the calling command’s {@code srcImage} is a compressed image, or a single-plane, “etext:_422” image format, {@code extent.height} must be a multiple of the compressed texel block height or
(extent.height + srcOffset.y) must equal the source image subresource height
* - If the calling command’s {@code srcImage} is a compressed image, or a single-plane, “etext:_422” image format, {@code extent.depth} must be a multiple of the compressed texel block depth or
(extent.depth + srcOffset.z) must equal the source image subresource depth
* - If the calling command’s {@code dstImage} is a compressed format image, or a single-plane, “etext:_422” image format, all members of {@code dstOffset} must be a multiple of the corresponding dimensions of the compressed texel block
* - If the calling command’s {@code dstImage} is a compressed format image, or a single-plane, “etext:_422” image format, {@code extent.width} must be a multiple of the compressed texel block width or
(extent.width + dstOffset.x) must equal the destination image subresource width
* - If the calling command’s {@code dstImage} is a compressed format image, or a single-plane, “etext:_422” image format, {@code extent.height} must be a multiple of the compressed texel block height or
(extent.height + dstOffset.y) must equal the destination image subresource height
* - If the calling command’s {@code dstImage} is a compressed format image, or a single-plane, “etext:_422” image format, {@code extent.depth} must be a multiple of the compressed texel block depth or
(extent.depth + dstOffset.z) must equal the destination image subresource depth
* - {@code srcOffset}, {@code dstOffset}, and {@code extent} must respect the image transfer granularity requirements of the queue family that it will be submitted against, as described in Physical Device Enumeration
*
*
* 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}
*
* Member documentation
*
*
* - {@code srcSubresource} – {@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.
* - {@code srcOffset} – {@code srcOffset} and {@code dstOffset} select the initial x, y, and z offsets in texels of the sub-regions of the source and destination image data.
* - {@code dstSubresource} – see {@code srcSubresource}
* - {@code dstOffset} – see {@code srcOffset}
* - {@code extent} – the size in texels of the source image to copy in {@code width}, {@code height} and {@code depth}.
*
*
* Layout
*
*
* struct VkImageCopy {
* {@link VkImageSubresourceLayers VkImageSubresourceLayers} srcSubresource;
* {@link VkOffset3D VkOffset3D} srcOffset;
* {@link VkImageSubresourceLayers VkImageSubresourceLayers} dstSubresource;
* {@link VkOffset3D VkOffset3D} dstOffset;
* {@link VkExtent3D VkExtent3D} extent;
* }The created instance holds a strong reference to the container object.
*/
public VkImageCopy(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns a {@link VkImageSubresourceLayers} view of the {@code srcSubresource} field. */
public VkImageSubresourceLayers srcSubresource() { return nsrcSubresource(address()); }
/** Returns a {@link VkOffset3D} view of the {@code srcOffset} field. */
public VkOffset3D srcOffset() { return nsrcOffset(address()); }
/** Returns a {@link VkImageSubresourceLayers} view of the {@code dstSubresource} field. */
public VkImageSubresourceLayers dstSubresource() { return ndstSubresource(address()); }
/** Returns a {@link VkOffset3D} view of the {@code dstOffset} field. */
public VkOffset3D dstOffset() { return ndstOffset(address()); }
/** Returns a {@link VkExtent3D} view of the {@code extent} field. */
public VkExtent3D extent() { return nextent(address()); }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@code srcSubresource} field. */
public VkImageCopy srcSubresource(VkImageSubresourceLayers value) { nsrcSubresource(address(), value); return this; }
/** Copies the specified {@link VkOffset3D} to the {@code srcOffset} field. */
public VkImageCopy srcOffset(VkOffset3D value) { nsrcOffset(address(), value); return this; }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@code dstSubresource} field. */
public VkImageCopy dstSubresource(VkImageSubresourceLayers value) { ndstSubresource(address(), value); return this; }
/** Copies the specified {@link VkOffset3D} to the {@code dstOffset} field. */
public VkImageCopy dstOffset(VkOffset3D value) { ndstOffset(address(), value); return this; }
/** Copies the specified {@link VkExtent3D} to the {@code extent} field. */
public VkImageCopy extent(VkExtent3D value) { nextent(address(), value); 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 {@link VkImageCopy} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkImageCopy malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkImageCopy} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkImageCopy calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkImageCopy} instance allocated with {@link BufferUtils}. */
public static VkImageCopy create() {
return new VkImageCopy(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkImageCopy} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkImageCopy create(long address) {
return address == NULL ? null : new VkImageCopy(address, null);
}
/**
* 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 Buffer malloc(int capacity) {
return create(__malloc(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 Buffer calloc(int capacity) {
return create(nmemCalloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkImageCopy.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkImageCopy.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static Buffer create(long address, int capacity) {
return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
}
// -----------------------------------
/** Returns a new {@link VkImageCopy} instance allocated on the thread-local {@link MemoryStack}. */
public static VkImageCopy mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkImageCopy} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkImageCopy callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkImageCopy} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkImageCopy mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link 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 callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkImageCopy.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkImageCopy.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* 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 Buffer mallocStack(int capacity, MemoryStack stack) {
return create(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 Buffer callocStack(int capacity, MemoryStack stack) {
return create(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 {
/**
* Creates a new {@link 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);
}
Buffer(long address, 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 Buffer newBufferInstance(long address, ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkImageCopy newInstance(long address) {
return new VkImageCopy(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns a {@link VkImageSubresourceLayers} view of the {@code srcSubresource} field. */
public VkImageSubresourceLayers srcSubresource() { return VkImageCopy.nsrcSubresource(address()); }
/** Returns a {@link VkOffset3D} view of the {@code srcOffset} field. */
public VkOffset3D srcOffset() { return VkImageCopy.nsrcOffset(address()); }
/** Returns a {@link VkImageSubresourceLayers} view of the {@code dstSubresource} field. */
public VkImageSubresourceLayers dstSubresource() { return VkImageCopy.ndstSubresource(address()); }
/** Returns a {@link VkOffset3D} view of the {@code dstOffset} field. */
public VkOffset3D dstOffset() { return VkImageCopy.ndstOffset(address()); }
/** Returns a {@link VkExtent3D} view of the {@code extent} field. */
public VkExtent3D extent() { return VkImageCopy.nextent(address()); }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@code srcSubresource} field. */
public VkImageCopy.Buffer srcSubresource(VkImageSubresourceLayers value) { VkImageCopy.nsrcSubresource(address(), value); return this; }
/** Copies the specified {@link VkOffset3D} to the {@code srcOffset} field. */
public VkImageCopy.Buffer srcOffset(VkOffset3D value) { VkImageCopy.nsrcOffset(address(), value); return this; }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@code dstSubresource} field. */
public VkImageCopy.Buffer dstSubresource(VkImageSubresourceLayers value) { VkImageCopy.ndstSubresource(address(), value); return this; }
/** Copies the specified {@link VkOffset3D} to the {@code dstOffset} field. */
public VkImageCopy.Buffer dstOffset(VkOffset3D value) { VkImageCopy.ndstOffset(address(), value); return this; }
/** Copies the specified {@link VkExtent3D} to the {@code extent} field. */
public VkImageCopy.Buffer extent(VkExtent3D value) { VkImageCopy.nextent(address(), value); return this; }
}
}