org.lwjgl.vulkan.VkCopyDescriptorSet 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 a copy descriptor set operation.
*
* Valid Usage
*
*
* - {@code srcBinding} must be a valid binding within {@code srcSet}
* - The sum of {@code srcArrayElement} and {@code descriptorCount} must be less than or equal to the number of array elements in the descriptor set binding specified by {@code srcBinding}, and all applicable consecutive bindings, as described by the “consecutive binding updates” section
* - {@code dstBinding} must be a valid binding within {@code dstSet}
* - The sum of {@code dstArrayElement} and {@code descriptorCount} must be less than or equal to the number of array elements in the descriptor set binding specified by {@code dstBinding}, and all applicable consecutive bindings, as described by the “consecutive binding updates” section
* - If {@code srcSet} is equal to {@code dstSet}, then the source and destination ranges of descriptors must not overlap, where the ranges may include array elements from consecutive bindings as described by the “consecutive binding updates” section
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link VK10#VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET STRUCTURE_TYPE_COPY_DESCRIPTOR_SET}
* - {@code pNext} must be {@code NULL}
* - {@code srcSet} must be a valid {@code VkDescriptorSet} handle
* - {@code dstSet} must be a valid {@code VkDescriptorSet} handle
* - Both of {@code dstSet}, and {@code srcSet} must have been created, allocated, or retrieved from the same {@code VkDevice}
*
*
* See Also
*
* {@link VK10#vkUpdateDescriptorSets UpdateDescriptorSets}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code srcSet} – {@code srcSet}, {@code srcBinding}, and {@code srcArrayElement} are the source set, binding, and array element, respectively.
* - {@code srcBinding} – see {@code srcSet}
* - {@code srcArrayElement} – see {@code srcSet}
* - {@code dstSet} – {@code dstSet}, {@code dstBinding}, and {@code dstArrayElement} are the destination set, binding, and array element, respectively.
* - {@code dstBinding} – see {@code dstSet}
* - {@code dstArrayElement} – see {@code dstSet}
* - {@code descriptorCount} – the number of descriptors to copy from the source to destination. If {@code descriptorCount} is greater than the number of remaining array elements in the source or destination binding, those affect consecutive bindings in a manner similar to {@link VkWriteDescriptorSet} above.
*
*
* Layout
*
*
* struct VkCopyDescriptorSet {
* VkStructureType sType;
* const void * pNext;
* VkDescriptorSet srcSet;
* uint32_t srcBinding;
* uint32_t srcArrayElement;
* VkDescriptorSet dstSet;
* uint32_t dstBinding;
* uint32_t dstArrayElement;
* uint32_t descriptorCount;
* }The created instance holds a strong reference to the container object.
*/
public VkCopyDescriptorSet(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return npNext(address()); }
/** Returns the value of the {@code srcSet} field. */
@NativeType("VkDescriptorSet")
public long srcSet() { return nsrcSet(address()); }
/** Returns the value of the {@code srcBinding} field. */
@NativeType("uint32_t")
public int srcBinding() { return nsrcBinding(address()); }
/** Returns the value of the {@code srcArrayElement} field. */
@NativeType("uint32_t")
public int srcArrayElement() { return nsrcArrayElement(address()); }
/** Returns the value of the {@code dstSet} field. */
@NativeType("VkDescriptorSet")
public long dstSet() { return ndstSet(address()); }
/** Returns the value of the {@code dstBinding} field. */
@NativeType("uint32_t")
public int dstBinding() { return ndstBinding(address()); }
/** Returns the value of the {@code dstArrayElement} field. */
@NativeType("uint32_t")
public int dstArrayElement() { return ndstArrayElement(address()); }
/** Returns the value of the {@code descriptorCount} field. */
@NativeType("uint32_t")
public int descriptorCount() { return ndescriptorCount(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkCopyDescriptorSet sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkCopyDescriptorSet pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code srcSet} field. */
public VkCopyDescriptorSet srcSet(@NativeType("VkDescriptorSet") long value) { nsrcSet(address(), value); return this; }
/** Sets the specified value to the {@code srcBinding} field. */
public VkCopyDescriptorSet srcBinding(@NativeType("uint32_t") int value) { nsrcBinding(address(), value); return this; }
/** Sets the specified value to the {@code srcArrayElement} field. */
public VkCopyDescriptorSet srcArrayElement(@NativeType("uint32_t") int value) { nsrcArrayElement(address(), value); return this; }
/** Sets the specified value to the {@code dstSet} field. */
public VkCopyDescriptorSet dstSet(@NativeType("VkDescriptorSet") long value) { ndstSet(address(), value); return this; }
/** Sets the specified value to the {@code dstBinding} field. */
public VkCopyDescriptorSet dstBinding(@NativeType("uint32_t") int value) { ndstBinding(address(), value); return this; }
/** Sets the specified value to the {@code dstArrayElement} field. */
public VkCopyDescriptorSet dstArrayElement(@NativeType("uint32_t") int value) { ndstArrayElement(address(), value); return this; }
/** Sets the specified value to the {@code descriptorCount} field. */
public VkCopyDescriptorSet descriptorCount(@NativeType("uint32_t") int value) { ndescriptorCount(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkCopyDescriptorSet set(
int sType,
long pNext,
long srcSet,
int srcBinding,
int srcArrayElement,
long dstSet,
int dstBinding,
int dstArrayElement,
int descriptorCount
) {
sType(sType);
pNext(pNext);
srcSet(srcSet);
srcBinding(srcBinding);
srcArrayElement(srcArrayElement);
dstSet(dstSet);
dstBinding(dstBinding);
dstArrayElement(dstArrayElement);
descriptorCount(descriptorCount);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkCopyDescriptorSet set(VkCopyDescriptorSet src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkCopyDescriptorSet} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkCopyDescriptorSet malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkCopyDescriptorSet} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkCopyDescriptorSet calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkCopyDescriptorSet} instance allocated with {@link BufferUtils}. */
public static VkCopyDescriptorSet create() {
return new VkCopyDescriptorSet(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkCopyDescriptorSet} instance for the specified memory address. */
public static VkCopyDescriptorSet create(long address) {
return new VkCopyDescriptorSet(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkCopyDescriptorSet createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkCopyDescriptorSet.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkCopyDescriptorSet.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkCopyDescriptorSet.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkCopyDescriptorSet.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkCopyDescriptorSet.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkCopyDescriptorSet.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkCopyDescriptorSet.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkCopyDescriptorSet.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkCopyDescriptorSet.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkCopyDescriptorSet} instance allocated on the thread-local {@link MemoryStack}. */
public static VkCopyDescriptorSet mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkCopyDescriptorSet} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkCopyDescriptorSet callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkCopyDescriptorSet} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkCopyDescriptorSet mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkCopyDescriptorSet} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkCopyDescriptorSet callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkCopyDescriptorSet.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkCopyDescriptorSet.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkCopyDescriptorSet.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkCopyDescriptorSet.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkCopyDescriptorSet.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkCopyDescriptorSet.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkCopyDescriptorSet.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 VkCopyDescriptorSet.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return memGetInt(struct + VkCopyDescriptorSet.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkCopyDescriptorSet.PNEXT); }
/** Unsafe version of {@link #srcSet}. */
public static long nsrcSet(long struct) { return memGetLong(struct + VkCopyDescriptorSet.SRCSET); }
/** Unsafe version of {@link #srcBinding}. */
public static int nsrcBinding(long struct) { return memGetInt(struct + VkCopyDescriptorSet.SRCBINDING); }
/** Unsafe version of {@link #srcArrayElement}. */
public static int nsrcArrayElement(long struct) { return memGetInt(struct + VkCopyDescriptorSet.SRCARRAYELEMENT); }
/** Unsafe version of {@link #dstSet}. */
public static long ndstSet(long struct) { return memGetLong(struct + VkCopyDescriptorSet.DSTSET); }
/** Unsafe version of {@link #dstBinding}. */
public static int ndstBinding(long struct) { return memGetInt(struct + VkCopyDescriptorSet.DSTBINDING); }
/** Unsafe version of {@link #dstArrayElement}. */
public static int ndstArrayElement(long struct) { return memGetInt(struct + VkCopyDescriptorSet.DSTARRAYELEMENT); }
/** Unsafe version of {@link #descriptorCount}. */
public static int ndescriptorCount(long struct) { return memGetInt(struct + VkCopyDescriptorSet.DESCRIPTORCOUNT); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkCopyDescriptorSet.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkCopyDescriptorSet.PNEXT, value); }
/** Unsafe version of {@link #srcSet(long) srcSet}. */
public static void nsrcSet(long struct, long value) { memPutLong(struct + VkCopyDescriptorSet.SRCSET, value); }
/** Unsafe version of {@link #srcBinding(int) srcBinding}. */
public static void nsrcBinding(long struct, int value) { memPutInt(struct + VkCopyDescriptorSet.SRCBINDING, value); }
/** Unsafe version of {@link #srcArrayElement(int) srcArrayElement}. */
public static void nsrcArrayElement(long struct, int value) { memPutInt(struct + VkCopyDescriptorSet.SRCARRAYELEMENT, value); }
/** Unsafe version of {@link #dstSet(long) dstSet}. */
public static void ndstSet(long struct, long value) { memPutLong(struct + VkCopyDescriptorSet.DSTSET, value); }
/** Unsafe version of {@link #dstBinding(int) dstBinding}. */
public static void ndstBinding(long struct, int value) { memPutInt(struct + VkCopyDescriptorSet.DSTBINDING, value); }
/** Unsafe version of {@link #dstArrayElement(int) dstArrayElement}. */
public static void ndstArrayElement(long struct, int value) { memPutInt(struct + VkCopyDescriptorSet.DSTARRAYELEMENT, value); }
/** Unsafe version of {@link #descriptorCount(int) descriptorCount}. */
public static void ndescriptorCount(long struct, int value) { memPutInt(struct + VkCopyDescriptorSet.DESCRIPTORCOUNT, value); }
// -----------------------------------
/** An array of {@link VkCopyDescriptorSet} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkCopyDescriptorSet.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 VkCopyDescriptorSet#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 Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkCopyDescriptorSet newInstance(long address) {
return new VkCopyDescriptorSet(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkCopyDescriptorSet.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkCopyDescriptorSet.npNext(address()); }
/** Returns the value of the {@code srcSet} field. */
@NativeType("VkDescriptorSet")
public long srcSet() { return VkCopyDescriptorSet.nsrcSet(address()); }
/** Returns the value of the {@code srcBinding} field. */
@NativeType("uint32_t")
public int srcBinding() { return VkCopyDescriptorSet.nsrcBinding(address()); }
/** Returns the value of the {@code srcArrayElement} field. */
@NativeType("uint32_t")
public int srcArrayElement() { return VkCopyDescriptorSet.nsrcArrayElement(address()); }
/** Returns the value of the {@code dstSet} field. */
@NativeType("VkDescriptorSet")
public long dstSet() { return VkCopyDescriptorSet.ndstSet(address()); }
/** Returns the value of the {@code dstBinding} field. */
@NativeType("uint32_t")
public int dstBinding() { return VkCopyDescriptorSet.ndstBinding(address()); }
/** Returns the value of the {@code dstArrayElement} field. */
@NativeType("uint32_t")
public int dstArrayElement() { return VkCopyDescriptorSet.ndstArrayElement(address()); }
/** Returns the value of the {@code descriptorCount} field. */
@NativeType("uint32_t")
public int descriptorCount() { return VkCopyDescriptorSet.ndescriptorCount(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkCopyDescriptorSet.Buffer sType(@NativeType("VkStructureType") int value) { VkCopyDescriptorSet.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkCopyDescriptorSet.Buffer pNext(@NativeType("const void *") long value) { VkCopyDescriptorSet.npNext(address(), value); return this; }
/** Sets the specified value to the {@code srcSet} field. */
public VkCopyDescriptorSet.Buffer srcSet(@NativeType("VkDescriptorSet") long value) { VkCopyDescriptorSet.nsrcSet(address(), value); return this; }
/** Sets the specified value to the {@code srcBinding} field. */
public VkCopyDescriptorSet.Buffer srcBinding(@NativeType("uint32_t") int value) { VkCopyDescriptorSet.nsrcBinding(address(), value); return this; }
/** Sets the specified value to the {@code srcArrayElement} field. */
public VkCopyDescriptorSet.Buffer srcArrayElement(@NativeType("uint32_t") int value) { VkCopyDescriptorSet.nsrcArrayElement(address(), value); return this; }
/** Sets the specified value to the {@code dstSet} field. */
public VkCopyDescriptorSet.Buffer dstSet(@NativeType("VkDescriptorSet") long value) { VkCopyDescriptorSet.ndstSet(address(), value); return this; }
/** Sets the specified value to the {@code dstBinding} field. */
public VkCopyDescriptorSet.Buffer dstBinding(@NativeType("uint32_t") int value) { VkCopyDescriptorSet.ndstBinding(address(), value); return this; }
/** Sets the specified value to the {@code dstArrayElement} field. */
public VkCopyDescriptorSet.Buffer dstArrayElement(@NativeType("uint32_t") int value) { VkCopyDescriptorSet.ndstArrayElement(address(), value); return this; }
/** Sets the specified value to the {@code descriptorCount} field. */
public VkCopyDescriptorSet.Buffer descriptorCount(@NativeType("uint32_t") int value) { VkCopyDescriptorSet.ndescriptorCount(address(), value); return this; }
}
}