org.lwjgl.vulkan.VkD3D12FenceSubmitInfoKHR 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 values for Direct3D 12 fence-backed semaphores.
*
* Description
*
* If the semaphore in {@link VkSubmitInfo}{@code ::pWaitSemaphores} or {@link VkSubmitInfo}{@code ::pSignalSemaphores} corresponding to an entry in {@code pWaitSemaphoreValues} or {@code pSignalSemaphoreValues} respectively does not currently have a payload referring to a Direct3D 12 fence, the implementation must ignore the value in the {@code pWaitSemaphoreValues} or {@code pSignalSemaphoreValues} entry.
*
* Valid Usage
*
*
* - {@code waitSemaphoreValuesCount} must be the same value as {@link VkSubmitInfo}{@code ::waitSemaphoreCount}, where {@link VkSubmitInfo} is in the {@code pNext} chain of this {@link VkD3D12FenceSubmitInfoKHR} structure.
* - {@code signalSemaphoreValuesCount} must be the same value as {@link VkSubmitInfo}{@code ::signalSemaphoreCount}, where {@link VkSubmitInfo} is in the {@code pNext} chain of this {@link VkD3D12FenceSubmitInfoKHR} structure.
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link KHRExternalSemaphoreWin32#VK_STRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHR STRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHR}
* - If {@code waitSemaphoreValuesCount} is not 0, and {@code pWaitSemaphoreValues} is not {@code NULL}, {@code pWaitSemaphoreValues} must be a valid pointer to an array of {@code waitSemaphoreValuesCount} {@code uint64_t} values
* - If {@code signalSemaphoreValuesCount} is not 0, and {@code pSignalSemaphoreValues} is not {@code NULL}, {@code pSignalSemaphoreValues} must be a valid pointer to an array of {@code signalSemaphoreValuesCount} {@code uint64_t} values
*
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code waitSemaphoreValuesCount} – the number of semaphore wait values specified in {@code pWaitSemaphoreValues}.
* - {@code pWaitSemaphoreValues} – an array of length {@code waitSemaphoreValuesCount} containing values for the corresponding semaphores in {@link VkSubmitInfo}{@code ::pWaitSemaphores} to wait for.
* - {@code signalSemaphoreValuesCount} – the number of semaphore signal values specified in {@code pSignalSemaphoreValues}.
* - {@code pSignalSemaphoreValues} – an array of length {@code signalSemaphoreValuesCount} containing values for the corresponding semaphores in {@link VkSubmitInfo}{@code ::pSignalSemaphores} to set when signaled.
*
*
* Layout
*
*
* struct VkD3D12FenceSubmitInfoKHR {
* VkStructureType sType;
* const void * pNext;
* uint32_t waitSemaphoreValuesCount;
* const uint64_t * pWaitSemaphoreValues;
* uint32_t signalSemaphoreValuesCount;
* const uint64_t * pSignalSemaphoreValues;
* }The created instance holds a strong reference to the container object.
*/
public VkD3D12FenceSubmitInfoKHR(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 waitSemaphoreValuesCount} field. */
@NativeType("uint32_t")
public int waitSemaphoreValuesCount() { return nwaitSemaphoreValuesCount(address()); }
/** Returns a {@link LongBuffer} view of the data pointed to by the {@code pWaitSemaphoreValues} field. */
@Nullable
@NativeType("const uint64_t *")
public LongBuffer pWaitSemaphoreValues() { return npWaitSemaphoreValues(address()); }
/** Returns the value of the {@code signalSemaphoreValuesCount} field. */
@NativeType("uint32_t")
public int signalSemaphoreValuesCount() { return nsignalSemaphoreValuesCount(address()); }
/** Returns a {@link LongBuffer} view of the data pointed to by the {@code pSignalSemaphoreValues} field. */
@Nullable
@NativeType("const uint64_t *")
public LongBuffer pSignalSemaphoreValues() { return npSignalSemaphoreValues(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkD3D12FenceSubmitInfoKHR sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkD3D12FenceSubmitInfoKHR pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code waitSemaphoreValuesCount} field. */
public VkD3D12FenceSubmitInfoKHR waitSemaphoreValuesCount(@NativeType("uint32_t") int value) { nwaitSemaphoreValuesCount(address(), value); return this; }
/** Sets the address of the specified {@link LongBuffer} to the {@code pWaitSemaphoreValues} field. */
public VkD3D12FenceSubmitInfoKHR pWaitSemaphoreValues(@Nullable @NativeType("const uint64_t *") LongBuffer value) { npWaitSemaphoreValues(address(), value); return this; }
/** Sets the specified value to the {@code signalSemaphoreValuesCount} field. */
public VkD3D12FenceSubmitInfoKHR signalSemaphoreValuesCount(@NativeType("uint32_t") int value) { nsignalSemaphoreValuesCount(address(), value); return this; }
/** Sets the address of the specified {@link LongBuffer} to the {@code pSignalSemaphoreValues} field. */
public VkD3D12FenceSubmitInfoKHR pSignalSemaphoreValues(@Nullable @NativeType("const uint64_t *") LongBuffer value) { npSignalSemaphoreValues(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkD3D12FenceSubmitInfoKHR set(
int sType,
long pNext,
int waitSemaphoreValuesCount,
LongBuffer pWaitSemaphoreValues,
int signalSemaphoreValuesCount,
LongBuffer pSignalSemaphoreValues
) {
sType(sType);
pNext(pNext);
waitSemaphoreValuesCount(waitSemaphoreValuesCount);
pWaitSemaphoreValues(pWaitSemaphoreValues);
signalSemaphoreValuesCount(signalSemaphoreValuesCount);
pSignalSemaphoreValues(pSignalSemaphoreValues);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkD3D12FenceSubmitInfoKHR set(VkD3D12FenceSubmitInfoKHR src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkD3D12FenceSubmitInfoKHR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkD3D12FenceSubmitInfoKHR malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkD3D12FenceSubmitInfoKHR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkD3D12FenceSubmitInfoKHR calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkD3D12FenceSubmitInfoKHR} instance allocated with {@link BufferUtils}. */
public static VkD3D12FenceSubmitInfoKHR create() {
return new VkD3D12FenceSubmitInfoKHR(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkD3D12FenceSubmitInfoKHR} instance for the specified memory address. */
public static VkD3D12FenceSubmitInfoKHR create(long address) {
return new VkD3D12FenceSubmitInfoKHR(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkD3D12FenceSubmitInfoKHR createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkD3D12FenceSubmitInfoKHR.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkD3D12FenceSubmitInfoKHR.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkD3D12FenceSubmitInfoKHR.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkD3D12FenceSubmitInfoKHR.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkD3D12FenceSubmitInfoKHR.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkD3D12FenceSubmitInfoKHR.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkD3D12FenceSubmitInfoKHR.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkD3D12FenceSubmitInfoKHR.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 VkD3D12FenceSubmitInfoKHR.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkD3D12FenceSubmitInfoKHR} instance allocated on the thread-local {@link MemoryStack}. */
public static VkD3D12FenceSubmitInfoKHR mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkD3D12FenceSubmitInfoKHR} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkD3D12FenceSubmitInfoKHR callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkD3D12FenceSubmitInfoKHR} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkD3D12FenceSubmitInfoKHR mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkD3D12FenceSubmitInfoKHR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkD3D12FenceSubmitInfoKHR callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkD3D12FenceSubmitInfoKHR.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkD3D12FenceSubmitInfoKHR.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkD3D12FenceSubmitInfoKHR.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkD3D12FenceSubmitInfoKHR.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkD3D12FenceSubmitInfoKHR.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkD3D12FenceSubmitInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkD3D12FenceSubmitInfoKHR.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 VkD3D12FenceSubmitInfoKHR.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 + VkD3D12FenceSubmitInfoKHR.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkD3D12FenceSubmitInfoKHR.PNEXT); }
/** Unsafe version of {@link #waitSemaphoreValuesCount}. */
public static int nwaitSemaphoreValuesCount(long struct) { return memGetInt(struct + VkD3D12FenceSubmitInfoKHR.WAITSEMAPHOREVALUESCOUNT); }
/** Unsafe version of {@link #pWaitSemaphoreValues() pWaitSemaphoreValues}. */
@Nullable public static LongBuffer npWaitSemaphoreValues(long struct) { return memLongBufferSafe(memGetAddress(struct + VkD3D12FenceSubmitInfoKHR.PWAITSEMAPHOREVALUES), nwaitSemaphoreValuesCount(struct)); }
/** Unsafe version of {@link #signalSemaphoreValuesCount}. */
public static int nsignalSemaphoreValuesCount(long struct) { return memGetInt(struct + VkD3D12FenceSubmitInfoKHR.SIGNALSEMAPHOREVALUESCOUNT); }
/** Unsafe version of {@link #pSignalSemaphoreValues() pSignalSemaphoreValues}. */
@Nullable public static LongBuffer npSignalSemaphoreValues(long struct) { return memLongBufferSafe(memGetAddress(struct + VkD3D12FenceSubmitInfoKHR.PSIGNALSEMAPHOREVALUES), nsignalSemaphoreValuesCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkD3D12FenceSubmitInfoKHR.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkD3D12FenceSubmitInfoKHR.PNEXT, value); }
/** Sets the specified value to the {@code waitSemaphoreValuesCount} field of the specified {@code struct}. */
public static void nwaitSemaphoreValuesCount(long struct, int value) { memPutInt(struct + VkD3D12FenceSubmitInfoKHR.WAITSEMAPHOREVALUESCOUNT, value); }
/** Unsafe version of {@link #pWaitSemaphoreValues(LongBuffer) pWaitSemaphoreValues}. */
public static void npWaitSemaphoreValues(long struct, @Nullable LongBuffer value) { memPutAddress(struct + VkD3D12FenceSubmitInfoKHR.PWAITSEMAPHOREVALUES, memAddressSafe(value)); if (value != null) { nwaitSemaphoreValuesCount(struct, value.remaining()); } }
/** Sets the specified value to the {@code signalSemaphoreValuesCount} field of the specified {@code struct}. */
public static void nsignalSemaphoreValuesCount(long struct, int value) { memPutInt(struct + VkD3D12FenceSubmitInfoKHR.SIGNALSEMAPHOREVALUESCOUNT, value); }
/** Unsafe version of {@link #pSignalSemaphoreValues(LongBuffer) pSignalSemaphoreValues}. */
public static void npSignalSemaphoreValues(long struct, @Nullable LongBuffer value) { memPutAddress(struct + VkD3D12FenceSubmitInfoKHR.PSIGNALSEMAPHOREVALUES, memAddressSafe(value)); if (value != null) { nsignalSemaphoreValuesCount(struct, value.remaining()); } }
// -----------------------------------
/** An array of {@link VkD3D12FenceSubmitInfoKHR} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkD3D12FenceSubmitInfoKHR.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 VkD3D12FenceSubmitInfoKHR#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 VkD3D12FenceSubmitInfoKHR newInstance(long address) {
return new VkD3D12FenceSubmitInfoKHR(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkD3D12FenceSubmitInfoKHR.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkD3D12FenceSubmitInfoKHR.npNext(address()); }
/** Returns the value of the {@code waitSemaphoreValuesCount} field. */
@NativeType("uint32_t")
public int waitSemaphoreValuesCount() { return VkD3D12FenceSubmitInfoKHR.nwaitSemaphoreValuesCount(address()); }
/** Returns a {@link LongBuffer} view of the data pointed to by the {@code pWaitSemaphoreValues} field. */
@Nullable
@NativeType("const uint64_t *")
public LongBuffer pWaitSemaphoreValues() { return VkD3D12FenceSubmitInfoKHR.npWaitSemaphoreValues(address()); }
/** Returns the value of the {@code signalSemaphoreValuesCount} field. */
@NativeType("uint32_t")
public int signalSemaphoreValuesCount() { return VkD3D12FenceSubmitInfoKHR.nsignalSemaphoreValuesCount(address()); }
/** Returns a {@link LongBuffer} view of the data pointed to by the {@code pSignalSemaphoreValues} field. */
@Nullable
@NativeType("const uint64_t *")
public LongBuffer pSignalSemaphoreValues() { return VkD3D12FenceSubmitInfoKHR.npSignalSemaphoreValues(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkD3D12FenceSubmitInfoKHR.Buffer sType(@NativeType("VkStructureType") int value) { VkD3D12FenceSubmitInfoKHR.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkD3D12FenceSubmitInfoKHR.Buffer pNext(@NativeType("const void *") long value) { VkD3D12FenceSubmitInfoKHR.npNext(address(), value); return this; }
/** Sets the specified value to the {@code waitSemaphoreValuesCount} field. */
public VkD3D12FenceSubmitInfoKHR.Buffer waitSemaphoreValuesCount(@NativeType("uint32_t") int value) { VkD3D12FenceSubmitInfoKHR.nwaitSemaphoreValuesCount(address(), value); return this; }
/** Sets the address of the specified {@link LongBuffer} to the {@code pWaitSemaphoreValues} field. */
public VkD3D12FenceSubmitInfoKHR.Buffer pWaitSemaphoreValues(@Nullable @NativeType("const uint64_t *") LongBuffer value) { VkD3D12FenceSubmitInfoKHR.npWaitSemaphoreValues(address(), value); return this; }
/** Sets the specified value to the {@code signalSemaphoreValuesCount} field. */
public VkD3D12FenceSubmitInfoKHR.Buffer signalSemaphoreValuesCount(@NativeType("uint32_t") int value) { VkD3D12FenceSubmitInfoKHR.nsignalSemaphoreValuesCount(address(), value); return this; }
/** Sets the address of the specified {@link LongBuffer} to the {@code pSignalSemaphoreValues} field. */
public VkD3D12FenceSubmitInfoKHR.Buffer pSignalSemaphoreValues(@Nullable @NativeType("const uint64_t *") LongBuffer value) { VkD3D12FenceSubmitInfoKHR.npSignalSemaphoreValues(address(), value); return this; }
}
}