org.lwjgl.vulkan.VkImageBlit 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.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying an image blit operation.
*
* Description
*
* For each element of the {@code pRegions} array, a blit operation is performed for the specified source and destination regions.
*
* Valid Usage
*
*
* - The {@code aspectMask} member of {@code srcSubresource} and {@code dstSubresource} must match
* - The {@code layerCount} member of {@code srcSubresource} and {@code dstSubresource} must match
*
*
* Valid Usage (Implicit)
*
*
* - {@code srcSubresource} must be a valid {@link VkImageSubresourceLayers} structure
* - {@code dstSubresource} must be a valid {@link VkImageSubresourceLayers} structure
*
*
* See Also
*
* {@link VkImageSubresourceLayers}, {@link VkOffset3D}, {@link VK10#vkCmdBlitImage CmdBlitImage}
*
* Layout
*
*
* struct VkImageBlit {
* {@link VkImageSubresourceLayers VkImageSubresourceLayers} {@link #srcSubresource};
* {@link VkOffset3D VkOffset3D} {@link #srcOffsets}[2];
* {@link VkImageSubresourceLayers VkImageSubresourceLayers} {@link #dstSubresource};
* {@link VkOffset3D VkOffset3D} {@link #dstOffsets}[2];
* }
*/
public class VkImageBlit 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,
SRCOFFSETS,
DSTSUBRESOURCE,
DSTOFFSETS;
static {
Layout layout = __struct(
__member(VkImageSubresourceLayers.SIZEOF, VkImageSubresourceLayers.ALIGNOF),
__array(VkOffset3D.SIZEOF, VkOffset3D.ALIGNOF, 2),
__member(VkImageSubresourceLayers.SIZEOF, VkImageSubresourceLayers.ALIGNOF),
__array(VkOffset3D.SIZEOF, VkOffset3D.ALIGNOF, 2)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
SRCSUBRESOURCE = layout.offsetof(0);
SRCOFFSETS = layout.offsetof(1);
DSTSUBRESOURCE = layout.offsetof(2);
DSTOFFSETS = layout.offsetof(3);
}
/**
* Creates a {@code VkImageBlit} 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 VkImageBlit(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the subresource to blit from. */
public VkImageSubresourceLayers srcSubresource() { return nsrcSubresource(address()); }
/** a pointer to an array of two {@link VkOffset3D} structures specifying the bounds of the source region within {@code srcSubresource}. */
@NativeType("VkOffset3D[2]")
public VkOffset3D.Buffer srcOffsets() { return nsrcOffsets(address()); }
/** a pointer to an array of two {@link VkOffset3D} structures specifying the bounds of the source region within {@code srcSubresource}. */
public VkOffset3D srcOffsets(int index) { return nsrcOffsets(address(), index); }
/** the subresource to blit into. */
public VkImageSubresourceLayers dstSubresource() { return ndstSubresource(address()); }
/** a pointer to an array of two {@link VkOffset3D} structures specifying the bounds of the destination region within {@code dstSubresource}. */
@NativeType("VkOffset3D[2]")
public VkOffset3D.Buffer dstOffsets() { return ndstOffsets(address()); }
/** a pointer to an array of two {@link VkOffset3D} structures specifying the bounds of the destination region within {@code dstSubresource}. */
public VkOffset3D dstOffsets(int index) { return ndstOffsets(address(), index); }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@link #srcSubresource} field. */
public VkImageBlit srcSubresource(VkImageSubresourceLayers value) { nsrcSubresource(address(), value); return this; }
/** Passes the {@link #srcSubresource} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit srcSubresource(java.util.function.Consumer consumer) { consumer.accept(srcSubresource()); return this; }
/** Copies the specified {@link VkOffset3D.Buffer} to the {@link #srcOffsets} field. */
public VkImageBlit srcOffsets(@NativeType("VkOffset3D[2]") VkOffset3D.Buffer value) { nsrcOffsets(address(), value); return this; }
/** Copies the specified {@link VkOffset3D} at the specified index of the {@link #srcOffsets} field. */
public VkImageBlit srcOffsets(int index, VkOffset3D value) { nsrcOffsets(address(), index, value); return this; }
/** Passes the {@link #srcOffsets} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit srcOffsets(java.util.function.Consumer consumer) { consumer.accept(srcOffsets()); return this; }
/** Passes the element at {@code index} of the {@link #srcOffsets} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit srcOffsets(int index, java.util.function.Consumer consumer) { consumer.accept(srcOffsets(index)); return this; }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@link #dstSubresource} field. */
public VkImageBlit dstSubresource(VkImageSubresourceLayers value) { ndstSubresource(address(), value); return this; }
/** Passes the {@link #dstSubresource} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit dstSubresource(java.util.function.Consumer consumer) { consumer.accept(dstSubresource()); return this; }
/** Copies the specified {@link VkOffset3D.Buffer} to the {@link #dstOffsets} field. */
public VkImageBlit dstOffsets(@NativeType("VkOffset3D[2]") VkOffset3D.Buffer value) { ndstOffsets(address(), value); return this; }
/** Copies the specified {@link VkOffset3D} at the specified index of the {@link #dstOffsets} field. */
public VkImageBlit dstOffsets(int index, VkOffset3D value) { ndstOffsets(address(), index, value); return this; }
/** Passes the {@link #dstOffsets} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit dstOffsets(java.util.function.Consumer consumer) { consumer.accept(dstOffsets()); return this; }
/** Passes the element at {@code index} of the {@link #dstOffsets} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit dstOffsets(int index, java.util.function.Consumer consumer) { consumer.accept(dstOffsets(index)); return this; }
/** Initializes this struct with the specified values. */
public VkImageBlit set(
VkImageSubresourceLayers srcSubresource,
VkOffset3D.Buffer srcOffsets,
VkImageSubresourceLayers dstSubresource,
VkOffset3D.Buffer dstOffsets
) {
srcSubresource(srcSubresource);
srcOffsets(srcOffsets);
dstSubresource(dstSubresource);
dstOffsets(dstOffsets);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkImageBlit set(VkImageBlit src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkImageBlit} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkImageBlit malloc() {
return wrap(VkImageBlit.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkImageBlit} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkImageBlit calloc() {
return wrap(VkImageBlit.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkImageBlit} instance allocated with {@link BufferUtils}. */
public static VkImageBlit create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkImageBlit.class, memAddress(container), container);
}
/** Returns a new {@code VkImageBlit} instance for the specified memory address. */
public static VkImageBlit create(long address) {
return wrap(VkImageBlit.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkImageBlit createSafe(long address) {
return address == NULL ? null : wrap(VkImageBlit.class, address);
}
/**
* Returns a new {@link VkImageBlit.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkImageBlit.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkImageBlit.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkImageBlit.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkImageBlit.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkImageBlit.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkImageBlit.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkImageBlit.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 VkImageBlit.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 VkImageBlit mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkImageBlit callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkImageBlit mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkImageBlit callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkImageBlit.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkImageBlit.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkImageBlit.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 VkImageBlit.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code VkImageBlit} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkImageBlit malloc(MemoryStack stack) {
return wrap(VkImageBlit.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkImageBlit} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkImageBlit calloc(MemoryStack stack) {
return wrap(VkImageBlit.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkImageBlit.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkImageBlit.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkImageBlit.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 VkImageBlit.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 + VkImageBlit.SRCSUBRESOURCE); }
/** Unsafe version of {@link #srcOffsets}. */
public static VkOffset3D.Buffer nsrcOffsets(long struct) { return VkOffset3D.create(struct + VkImageBlit.SRCOFFSETS, 2); }
/** Unsafe version of {@link #srcOffsets(int) srcOffsets}. */
public static VkOffset3D nsrcOffsets(long struct, int index) {
return VkOffset3D.create(struct + VkImageBlit.SRCOFFSETS + check(index, 2) * VkOffset3D.SIZEOF);
}
/** Unsafe version of {@link #dstSubresource}. */
public static VkImageSubresourceLayers ndstSubresource(long struct) { return VkImageSubresourceLayers.create(struct + VkImageBlit.DSTSUBRESOURCE); }
/** Unsafe version of {@link #dstOffsets}. */
public static VkOffset3D.Buffer ndstOffsets(long struct) { return VkOffset3D.create(struct + VkImageBlit.DSTOFFSETS, 2); }
/** Unsafe version of {@link #dstOffsets(int) dstOffsets}. */
public static VkOffset3D ndstOffsets(long struct, int index) {
return VkOffset3D.create(struct + VkImageBlit.DSTOFFSETS + check(index, 2) * VkOffset3D.SIZEOF);
}
/** Unsafe version of {@link #srcSubresource(VkImageSubresourceLayers) srcSubresource}. */
public static void nsrcSubresource(long struct, VkImageSubresourceLayers value) { memCopy(value.address(), struct + VkImageBlit.SRCSUBRESOURCE, VkImageSubresourceLayers.SIZEOF); }
/** Unsafe version of {@link #srcOffsets(VkOffset3D.Buffer) srcOffsets}. */
public static void nsrcOffsets(long struct, VkOffset3D.Buffer value) {
if (CHECKS) { checkGT(value, 2); }
memCopy(value.address(), struct + VkImageBlit.SRCOFFSETS, value.remaining() * VkOffset3D.SIZEOF);
}
/** Unsafe version of {@link #srcOffsets(int, VkOffset3D) srcOffsets}. */
public static void nsrcOffsets(long struct, int index, VkOffset3D value) {
memCopy(value.address(), struct + VkImageBlit.SRCOFFSETS + check(index, 2) * VkOffset3D.SIZEOF, VkOffset3D.SIZEOF);
}
/** Unsafe version of {@link #dstSubresource(VkImageSubresourceLayers) dstSubresource}. */
public static void ndstSubresource(long struct, VkImageSubresourceLayers value) { memCopy(value.address(), struct + VkImageBlit.DSTSUBRESOURCE, VkImageSubresourceLayers.SIZEOF); }
/** Unsafe version of {@link #dstOffsets(VkOffset3D.Buffer) dstOffsets}. */
public static void ndstOffsets(long struct, VkOffset3D.Buffer value) {
if (CHECKS) { checkGT(value, 2); }
memCopy(value.address(), struct + VkImageBlit.DSTOFFSETS, value.remaining() * VkOffset3D.SIZEOF);
}
/** Unsafe version of {@link #dstOffsets(int, VkOffset3D) dstOffsets}. */
public static void ndstOffsets(long struct, int index, VkOffset3D value) {
memCopy(value.address(), struct + VkImageBlit.DSTOFFSETS + check(index, 2) * VkOffset3D.SIZEOF, VkOffset3D.SIZEOF);
}
// -----------------------------------
/** An array of {@link VkImageBlit} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkImageBlit ELEMENT_FACTORY = VkImageBlit.create(-1L);
/**
* Creates a new {@code VkImageBlit.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 VkImageBlit#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 VkImageBlit getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return a {@link VkImageSubresourceLayers} view of the {@link VkImageBlit#srcSubresource} field. */
public VkImageSubresourceLayers srcSubresource() { return VkImageBlit.nsrcSubresource(address()); }
/** @return a {@link VkOffset3D}.Buffer view of the {@link VkImageBlit#srcOffsets} field. */
@NativeType("VkOffset3D[2]")
public VkOffset3D.Buffer srcOffsets() { return VkImageBlit.nsrcOffsets(address()); }
/** @return a {@link VkOffset3D} view of the struct at the specified index of the {@link VkImageBlit#srcOffsets} field. */
public VkOffset3D srcOffsets(int index) { return VkImageBlit.nsrcOffsets(address(), index); }
/** @return a {@link VkImageSubresourceLayers} view of the {@link VkImageBlit#dstSubresource} field. */
public VkImageSubresourceLayers dstSubresource() { return VkImageBlit.ndstSubresource(address()); }
/** @return a {@link VkOffset3D}.Buffer view of the {@link VkImageBlit#dstOffsets} field. */
@NativeType("VkOffset3D[2]")
public VkOffset3D.Buffer dstOffsets() { return VkImageBlit.ndstOffsets(address()); }
/** @return a {@link VkOffset3D} view of the struct at the specified index of the {@link VkImageBlit#dstOffsets} field. */
public VkOffset3D dstOffsets(int index) { return VkImageBlit.ndstOffsets(address(), index); }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@link VkImageBlit#srcSubresource} field. */
public VkImageBlit.Buffer srcSubresource(VkImageSubresourceLayers value) { VkImageBlit.nsrcSubresource(address(), value); return this; }
/** Passes the {@link VkImageBlit#srcSubresource} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit.Buffer srcSubresource(java.util.function.Consumer consumer) { consumer.accept(srcSubresource()); return this; }
/** Copies the specified {@link VkOffset3D.Buffer} to the {@link VkImageBlit#srcOffsets} field. */
public VkImageBlit.Buffer srcOffsets(@NativeType("VkOffset3D[2]") VkOffset3D.Buffer value) { VkImageBlit.nsrcOffsets(address(), value); return this; }
/** Copies the specified {@link VkOffset3D} at the specified index of the {@link VkImageBlit#srcOffsets} field. */
public VkImageBlit.Buffer srcOffsets(int index, VkOffset3D value) { VkImageBlit.nsrcOffsets(address(), index, value); return this; }
/** Passes the {@link VkImageBlit#srcOffsets} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit.Buffer srcOffsets(java.util.function.Consumer consumer) { consumer.accept(srcOffsets()); return this; }
/** Passes the element at {@code index} of the {@link VkImageBlit#srcOffsets} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit.Buffer srcOffsets(int index, java.util.function.Consumer consumer) { consumer.accept(srcOffsets(index)); return this; }
/** Copies the specified {@link VkImageSubresourceLayers} to the {@link VkImageBlit#dstSubresource} field. */
public VkImageBlit.Buffer dstSubresource(VkImageSubresourceLayers value) { VkImageBlit.ndstSubresource(address(), value); return this; }
/** Passes the {@link VkImageBlit#dstSubresource} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit.Buffer dstSubresource(java.util.function.Consumer consumer) { consumer.accept(dstSubresource()); return this; }
/** Copies the specified {@link VkOffset3D.Buffer} to the {@link VkImageBlit#dstOffsets} field. */
public VkImageBlit.Buffer dstOffsets(@NativeType("VkOffset3D[2]") VkOffset3D.Buffer value) { VkImageBlit.ndstOffsets(address(), value); return this; }
/** Copies the specified {@link VkOffset3D} at the specified index of the {@link VkImageBlit#dstOffsets} field. */
public VkImageBlit.Buffer dstOffsets(int index, VkOffset3D value) { VkImageBlit.ndstOffsets(address(), index, value); return this; }
/** Passes the {@link VkImageBlit#dstOffsets} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit.Buffer dstOffsets(java.util.function.Consumer consumer) { consumer.accept(dstOffsets()); return this; }
/** Passes the element at {@code index} of the {@link VkImageBlit#dstOffsets} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkImageBlit.Buffer dstOffsets(int index, java.util.function.Consumer consumer) { consumer.accept(dstOffsets(index)); return this; }
}
}